Credit a prepaid customer balance.
Admin-only controlled prepaid top-up. Writes an `admin_credit` ledger row and does not return or require customer tokens.
POST
/v1/admin/customers/{customer_id}/credits
Admin-only controlled prepaid top-up. Writes an `admin_credit` ledger row and does not return or require customer tokens.
Authentication
API Key (header: X-B3IQ-Admin-Token)
Path Parameters
customer_id
string
required
path
Request Body required
application/jsoncredit_id
string
Optional operator-supplied ledger entry id.
amount_wei
string
REQUIRED
reason
string
Responses
201
Customer balance credited.
application/jsonstatus
string
Enum:
creditedcustomer_id
string
credit_id
string
amount_wei
string
balance_after_wei
string
reserved_after_wei
string
reason
string | null
created_at
string (date-time)
default
B3IQ-native problem response.
curl -X POST 'https://{controlPlaneHost}/v1/admin/customers/string/credits' \ -H 'X-B3IQ-Admin-Token: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "credit_id": "string", "amount_wei": "string", "reason": "string"}'const response = await fetch('https://{controlPlaneHost}/v1/admin/customers/string/credits', { method: 'POST', headers: { "X-B3IQ-Admin-Token": "YOUR_API_KEY", "Content-Type": "application/json" }, body: JSON.stringify({ "credit_id": "string", "amount_wei": "string", "reason": "string" })});const data = await response.json();console.log(data);
201
Response
{ "status": "credited", "customer_id": "<string>", "credit_id": "<string>", "amount_wei": "<string>", "balance_after_wei": "<string>", "reserved_after_wei": "<string>", "reason": "<string>", "created_at": "2024-01-01T00:00:00Z"}API Playground
Try this endpoint
POST
/v1/admin/customers/{customer_id}/credits