Get list of charge batches

GET 
/api/gateway/v1/user-billing/charge-batches

Get list of charge batches

Request

Query Parameters

code string
createdFrom date-time
createdTo date-time
status string

Possible values: [PENDING, PROCESSED]

page[size] number

Possible values: <= 50

Default value: 10

Number of items per page

page[after] string

After cursor

page[before] string

Before cursor

page[order] string

Default value: DESC

Order of the items

page[key] string

Key of the items

Header Parameters

x-api-key stringrequired

Gateway API key

Responses

200

List of charge batches

application/json

Schema

Schema

status number
message string

data

object[]

Array [

id numberrequired

batchCode stringrequired

status stringrequired

Possible values: [PENDING, PROCESSED]

submittedAt date-timerequired

processedAt date-timerequired

createdAt date-timerequired

totalAmount numberrequired

unpaidAmount numberrequired

successRate numberrequired

spendingLimitExceed numberrequired

]

meta

object

page numberrequired

Current page number

perPage numberrequired

Number of items per page

count numberrequired

Number of returned items

totalCount numberrequired

Total number of items

totalPages numberrequired

Total number of pages

hasNextPage boolean

Has next page

hasPrevPage boolean

Has previous page

Example (from schema)

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "id": 0,
      "batchCode": "string",
      "status": "PENDING",
      "submittedAt": "2024-07-29T15:51:28.071Z",
      "processedAt": "2024-07-29T15:51:28.071Z",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "totalAmount": 0,
      "unpaidAmount": 0,
      "successRate": 0,
      "spendingLimitExceed": 0
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 10,
    "count": 10,
    "totalCount": 100,
    "totalPages": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

400

Invalid query parameters

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 400,
  "message": "Invalid payload",
  "error": {
    "code": "string",
    "detail": "Invalid payload"
  }
}

401

Unauthorized

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 401,
  "message": "Invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "detail": "Invalid API key"
  }
}

Loading...