List Payments
GET/payments
Request
Query Parameters
An object ID that is used as a cursor in pagination. For instance, if you make a list request and receive 100 objects, ending with obj_foo42, your subsequent call can include after=obj_foo42 in order to fetch the next page of the list.
Possible values: >= 1
and <= 100
Default value: 10
A limit on the number of objects to be returned, between 1 and 100.
Possible values: [ASC
, DESC
]
Default value: DESC
Sort list objects in either ascending or descending order.
Responses
- 200
OK
Response Headers
Acme-Mode
string
Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
required
Unique identifier for the object.
Possible values: [FAST
, GIRO
, ACT
, TT
, PAYNOW
]
Type of the payment
A positive integer value in specified currency's smallest unit. e.g. for SGD, $10 would be represented as 1000 (cents).
Three-letter ISO 4217 currency code in full uppercase. Must be a supported currency.
A meaningful description of the payment. This will show up in the receiver's bank statement. Characters used should be restricted to the SWIFT Character Set: uppercase and lowercase letters A-Z, 0-9 numerals, space, and these symbols: /-?:().,'+
.
Sender's account ID. Must be an internal account.
receiver
object
Receiver's name
Receiver's bank BIC
Receiver's bank account number
Possible values: [MOBILE
, UEN
, VPA
]
The proxy type if type is PAYNOW
The proxy value if type is PAYNOW
address
object
Receiver's address
Possible values: [PROCESSING
, FAILED
, SUBMITTED
, COMPLETED
]
Status of the payment
Result code of the payment
Time at which the object was created. In ISO 8601 format.
Time at which the object was last updated. In ISO 8601 format.
{
"data": [
{
"id": "pymt_dummy42",
"type": "FAST",
"amount": 4200,
"currency": "SGD",
"customerReference": "BONUS-2024-01",
"senderAccountId": "intacc_dummy42",
"receiver": {
"name": "Harry Potter",
"bank": "DBSSSGSGXXX",
"bankAccountNumber": 12345678,
"proxyType": "MOBILE",
"proxyValue": 6500000000,
"address": {
"line1": "20 Main Street",
"line2": "Unit #03-45",
"city": "Singapore",
"state": "",
"postalCode": "11111",
"country": "Singapore"
}
},
"status": "PROCESSING",
"resultCode": "SUCCESS",
"createdAt": "2023-04-24T00:00:00.000000Z",
"updatedAt": "2023-04-24T00:00:00.000000Z"
}
],
"hasMore": true,
"nextCursor": "eyJjcmVhdGVkQdummy42"
}