Get Bills - Quantum Metal Developer Docs

Get a list of bills.

POST /v1/bills HTTP/1.1
Content-Type: application/json
Key: {API Key}
Sign: {Signature}

{
    "filters": [
        {
            "name": "string",
            "value": "string",
            "matchType": "string"
        }
    ],
    "paging": {
        "index": 0,
        "size": 0
    },
    "sort": {
        "name": "string",
        "order": 1
    }
}

Request

Body

application/json

Property	Type	Description
`filters`	array	Optional. The filters to apply to the query.
`filters[].name`	string	The property name of the filter.
`filters[].value`	string	The property value of the filter.
`filters[].matchType`	string	The match type of the filter. Valid values are `like` or `equal`.
`paging`	object	Optional. The paging of the query.
`paging.index`	number	The index of the page.
`paging.size`	number	The size of the page.
`sort`	object	Optional. The sorting of the query.
`sort.name`	string	The property name of the sort.
`sort.order`	number	The order of the sort. Valid values are `1` (ascending) or `-1` (descending).

Response

Body

application/json

{
  "code": 0,
  "message": "string",
  "data": {
    "lists": [
      {
        "billId": "string",
        "merchantReference": "string",
        "requestReference": "string",
        "paymentReference": "string",
        "billAmount": 0.00,
        "currency": "string",
        "status": 0,
        "statusName": "string",
        "isFinal": bool,
        "dateTime": 1706600000000
      }
    ],
    "total": 0
  }
}

Property	Type	Description
`code`	number	The response code. Refer to ENUM Definition.
`message`	string	The response message.
`data`	object	The response data.
`data.lists`	array	The list of bills.
`data.lists[].billId`	string	The unique ID of the bill.
`data.lists[].merchantReference`	string	Your own reference number of the bill.
`data.lists[].requestReference`	string	The reference number of the bill request.
`data.lists[].paymentReference`	string	The reference number of the bill payment.
`data.lists[].billAmount`	number	The amount of the bill.
`data.lists[].currency`	string	The currency of the bill.
`data.lists[].status`	number	The status of the bill. Refer to ENUM Definition.
`data.lists[].statusName`	string	The status name of the bill.
`data.lists[].isFinal`	bool	Whether the status of the bill is final.
`data.lists[].dateTime`	number	The timestamp (in unix milliseconds) of the bill.
`data.total`	number	The total number of bills.

Cancel Bill

You can cancel a bill, at any time. Only works if the bill is Pending Payment status.

Bind Customer

Before you can proceed to perform operations with a registered customer in the platform, you need to bind the customer first. This is a one-time process where you will need to provide the customer's information to obtain an unique identifier for the customer.