Skip to main content
POST
/
credits
/
{credit_id}
/
void
Void credit
curl --request POST \
  --url https://api.togai.com/credits/{credit_id}/void \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "creds.1znQx9jiIXw.r44fc",
    "customerId": "7VcRw9xZDIqsC5E",
    "accountId": "ACC001",
    "purpose": "Prepaid Credit",
    "effectiveFrom": "2020-07-04",
    "effectiveUntil": "2021-07-04",
    "status": "ACTIVE",
    "creditAmount": 1000,
    "creditUnit": "USD",
    "holdAmount": 500,
    "consumedAmount": 400,
    "priority": 1,
    "createdAt": "2020-07-04T12:00:00.000Z"
  },
  {
    "id": "creds.1znQ46jiIXw.r24fc",
    "customerId": "7VcRw9xZDIqsC5E",
    "accountId": "ACC001",
    "purpose": "Prepaid Credit",
    "effectiveFrom": "2020-08-04",
    "effectiveUntil": "2021-08-04",
    "status": "ACTIVE",
    "creditAmount": 1000,
    "creditUnit": "USD",
    "holdAmount": 500,
    "consumedAmount": 400,
    "priority": 1,
    "createdAt": "2020-08-04T12:00:00.000Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
credit_id
string
required
Example:

"creds.1znQx9jiIXw.r44fc"

Response

Response for List credits request

​
credits
object[]
required