التوثيق

Adjust a customer's balance

Gives the customer credit or takes it back. A negative amount is credit, which the customer's next invoice uses up.

POST
/customers/{id}/balance-transactions

Gives the customer credit or takes it back. A negative amount is credit, which the customer's next invoice uses up.

AuthorizationBearer <token>

API key for merchant integrations. Send as Authorization: Bearer <your key>.

In: header

Path Parameters

id*string

Customer ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers/string/balance-transactions" \  -H "Content-Type: application/json" \  -d '{    "amount": -10000000000000  }'
{  "id": "cbtxn_3Nf8a2kLmPq9",  "object": "customer_balance_transaction",  "type": "adjustment",  "amount": -9007199254740991,  "endingBalance": -9007199254740991,  "currency": "EGP",  "invoiceId": "string",  "creditNoteId": "string",  "description": "string",  "customerId": "string",  "merchantId": "string",  "createdAt": "string"}