Create a Payment
POST/payments
Request
Header Parameters
A unique value, eg. a UUID.
- application/json
Body
- PayNow Receiver
- FAST Receiver
Possible values: [FAST
, GIRO
, ACT
, PAYNOW
]
Type of the payment, eg. FAST or GIRO.
A positive integer value in specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents).
Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type.
For example, FAST only supports SGD
.
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.
Currency to use in the sender account, if it has multiple currencies. Optional if sender account only has one currency configured.
receiver
object
required
oneOf
Receiver's name
Possible values: [MOBILE
, UEN
, VPA
]
The proxy type if type is PAYNOW
The proxy value if type is PAYNOW
Receiver's name
Receiver's bank 11-character SWIFT/BIC code
Receiver's bank account number
address
object
Receiver's address, if required
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
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.
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.
Currency to use in the sender account, if it has multiple currencies. Optional if sender account only has one currency configured.
receiver
object
Receiver's name
Receiver's bank SWIFT/BIC code
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.
{
"id": "pymt_0H3BQXP3VF2HZ",
"type": "FAST",
"amount": 4200,
"currency": "SGD",
"customerReference": "BONUS-2024-01",
"senderAccountId": "intacc_0H3BQY9BK1FCG",
"senderAccountCurrency": "SGD",
"receiver": {
"name": "Harry Potter",
"bank": "DBSSSGSGXXX",
"bankAccountNumber": "0052312891",
"proxyType": "MOBILE",
"proxyValue": "+6592345678",
"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"
}