Get list of user debits/charges

GET 
/api/gateway/v1/user-billing/debits

Get list of user debits/charges

Request

Query Parameters

page[size] number

Possible values: <= 50

Default value: 25

Number of items per page

page[page] number

Default value: 1

Page number

page[order] string

Default value: DESC

Order of the items

page[key] string

Key of the items

page[after] string

After cursor

page[before] string

Before cursor

Header Parameters

x-api-key stringrequired

Gateway API key

Responses

200

List of user debits/charges

application/json

Schema

Schema

status number
message string

data

object[]

Array [

id string

userId stringrequired

userName string

userBalanceType MpassUserBalanceType (string)required

Possible values: [UNSECURED_BALANCE, SECURED_BALANCE]

externalId stringrequired

serviceCode string

billingCode string

amount numberrequired

currency stringrequired

note string

status UserBillingStatus (string)required

Possible values: [PENDING, FINALIZED, CANCELED, TEMP_REJECTED, PERMANENT_REJECTED]

originatedEvent UserBillingOriginatedEvent (string)required

Possible values: [MIN_LIMIT_EXCEEDED, MAX_LIMIT_EXCEEDED, END_OF_BILLING_CYCLE]

reportedAt date-timerequired

createdAt date-timerequired

batchCode string

lastMessage string

lastProcessedAt date-time

lastRetryCount string

nextRetryDate date-time

]

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": "string",
      "userId": "string",
      "userName": "string",
      "userBalanceType": "UNSECURED_BALANCE",
      "externalId": "string",
      "serviceCode": "string",
      "billingCode": "string",
      "amount": 0,
      "currency": "string",
      "note": "string",
      "status": "PENDING",
      "originatedEvent": "MIN_LIMIT_EXCEEDED",
      "reportedAt": "2024-07-29T15:51:28.071Z",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "batchCode": "string",
      "lastMessage": "string",
      "lastProcessedAt": "2024-07-29T15:51:28.071Z",
      "lastRetryCount": "string",
      "nextRetryDate": "2024-07-29T15:51:28.071Z"
    }
  ],
  "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...