POST
/
credits
/
{credit_id}
/
void
Void credit
curl --request POST \
  --url https://api.togai.com/credits/{credit_id}/void \
  --header 'Authorization: Bearer <token>'
{
  "accountId": "biswa",
  "purpose": "credits",
  "effectiveFrom": "2024-03-06",
  "priority": 1,
  "id": "cred.22LLLScunZg.om5kC",
  "customerId": "biswa",
  "status": "VOIDED",
  "createdAt": "2024-03-13T12:33:39.986252Z",
  "applicableEntityIds": [],
  "effectiveUntil": "2025-03-06",
  "creditAmount": 10,
  "grantorId": "addon.22IZs2ZVEnw.0zDFe",
  "creditUnit": "USD",
  "holdAmount": 0,
  "consumedAmount": 0,
  "updatedAt": "2024-03-13T12:42:33.489822Z"
}

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

200
application/json

Response for Void credit request

Payload to grant Credits

POST
/
credits
/
{credit_id}
/
void
Void credit
curl --request POST \
  --url https://api.togai.com/credits/{credit_id}/void \
  --header 'Authorization: Bearer <token>'
{
  "accountId": "biswa",
  "purpose": "credits",
  "effectiveFrom": "2024-03-06",
  "priority": 1,
  "id": "cred.22LLLScunZg.om5kC",
  "customerId": "biswa",
  "status": "VOIDED",
  "createdAt": "2024-03-13T12:33:39.986252Z",
  "applicableEntityIds": [],
  "effectiveUntil": "2025-03-06",
  "creditAmount": 10,
  "grantorId": "addon.22IZs2ZVEnw.0zDFe",
  "creditUnit": "USD",
  "holdAmount": 0,
  "consumedAmount": 0,
  "updatedAt": "2024-03-13T12:42:33.489822Z"
}

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

200
application/json

Response for Void credit request

Payload to grant Credits