curl --request POST \
--url https://api.withorb.com/v1/customers/{customer_id}/balance_transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": "<string>",
"type": "increment",
"description": "<string>"
}'
{
"id": "cgZa3SXcsPTVyC4Y",
"created_at": "2022-05-01T07:01:31+00:00",
"starting_balance": "33.00",
"ending_balance": "22.00",
"amount": "11.00",
"action": "applied_to_invoice",
"description": "An optional description",
"invoice": {
"id": "gXcsPTVyC4YZa3Sc"
},
"type": "increment",
"credit_note": {
"id": "<string>"
}
}
Creates an immutable balance transaction that updates the customer’s balance and returns back the newly created transaction.
curl --request POST \
--url https://api.withorb.com/v1/customers/{customer_id}/balance_transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": "<string>",
"type": "increment",
"description": "<string>"
}'
{
"id": "cgZa3SXcsPTVyC4Y",
"created_at": "2022-05-01T07:01:31+00:00",
"starting_balance": "33.00",
"ending_balance": "22.00",
"amount": "11.00",
"action": "applied_to_invoice",
"description": "An optional description",
"invoice": {
"id": "gXcsPTVyC4YZa3Sc"
},
"type": "increment",
"credit_note": {
"id": "<string>"
}
}
API Keys can be issued in the Orb's web application.
OK
The response is of type object
.
Was this page helpful?