v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Credits

List credits

Get all credits

get/credits

Query parameters

nextTokenstring

Example:eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==

Pagination token used as a marker to get records from next page.

statusstring

Filter option to filter by status.

account_idstring

Example:1234

Filter option to filter based on account id.

idstring

Example:cred.1znpoFlsI3U.zmg85

Filter option to filter based on credit id.

pageSizeinteger

Example:10

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Response

Response for Get invoice requests

nextTokenstring

Example response

{
  "data": [
    {
      "accountId": "ACC001",
      "purpose": "PREPAID_CREDIT",
      "effectiveFrom": "2020-07-04",
      "effectiveUntil": "2021-07-04",
      "creditAmount": 1000,
      "priority": 1,
      "id": "cred.1znqBOVcai0.0tBFz",
      "customerId": "7VcRw9xZDIqsC5E",
      "status": "ACTIVE",
      "creditUnit": "USD",
      "holdAmount": 500,
      "consumedAmount": 400
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}