Create a Payment

POST 
/payments

Request

Header Parameters

Idempotency-Key string

A unique value, eg. a UUID.

application/json

Body

type stringrequired

Possible values: [FAST, GIRO, ACT, PAYNOW, MY_DUITNOW]

Type of the payment, eg. FAST or GIRO.

amount integerrequired

A positive integer value in specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents).

currency stringrequired

Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type.

For example, FAST only supports SGD.

customerReference string

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: /-?:().,'+.

senderAccountId stringrequired

Sender's account ID. Must be an internal account.

senderAccountCurrency string

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

PayNow Receiver

name stringrequired

Receiver's name

proxyType stringrequired

Possible values: [MOBILE, UEN, VPA]

The proxy type if type is PAYNOW

proxyValue stringrequired

The proxy value if type is PAYNOW

FAST Receiver

name stringrequired

Receiver's name

bank stringrequired

Receiver's bank 11-character SWIFT/BIC code

bankAccountNumber stringrequired

Receiver's bank account number

address

object

Receiver's address

line1 string

line2 string

city string

state string

postalCode string

country string

DuitNow Receiver

name stringrequired

Receiver's name

proxyType stringrequired

Possible values: [MOBILE, BUSINESS_REG, NRIC, PASSPORT]

The proxy type

proxyValue stringrequired

Follow these formats:

• MOBILE proxy type: A mobile number including the country code (+60 for Malaysia). E.g: +601255214553.
• BUSINESS_REG proxy type: A valid Business Registration Number (BRN) issued by the Companies Commission of Malaysia, a.k.a. Suruhanjaya Syarikat Malaysia (SSM). E.g: 201903123456.
• NRIC proxy type: Only alphanumeric with no hyphens (-) and no spaces allowed. Both New and Old IC numbers are supported. E.g: 610204135758.
• PASSPORT proxy type: Passport Number + Alpha-3 country code of the country of issuance. E.g: given a passport number E394029340V and country code of Singapore (SGP), the value will be E394029340VSGP.

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

Schema

id stringrequired

Unique identifier for the object.

type stringrequired

Possible values: [FAST, GIRO, ACT, TT, PAYNOW, MY_DUITNOW]

Type of the payment

amount integerrequired

A positive integer value in specified currency's smallest unit. e.g. for SGD, $10 would be represented as 1000 (cents).

currency stringrequired

Three-letter ISO 4217 currency code in full uppercase.

customerReference string

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: /-?:().,'+.

senderAccountId stringrequired

Sender's account ID. Must be an internal account.

senderAccountCurrency string

Currency to use in the sender account, if it has multiple currencies. Optional if sender account only has one currency configured.

receiver

object

name string

Receiver's name

bank string

Receiver's bank SWIFT/BIC code

bankAccountNumber string

Receiver's bank account number

proxyType string

Possible values: [MOBILE, UEN, VPA]

The proxy type if type is PAYNOW

proxyValue string

The proxy value if type is PAYNOW

address

object

Receiver's address

line1 string

line2 string

city string

state string

postalCode string

country string
status stringrequired

Possible values: [PROCESSING, FAILED, SUBMITTED, COMPLETED]

Status of the payment

resultCode string
Possible values: [INVALID_DATE, INVALID_CURRENCY, INVALID_AMOUNT, INVALID_BANK, INVALID_PROXY_TYPE, INVALID_PROXY_VALUE, INVALID_SENDER_ACCOUNT_CURRENCY, DUPLICATE_TRANSACTION, OTHERS]
Result code of the payment, if available. Possible values are:
• INVALID_DATE: Invalid date.
• INVALID_CURRENCY: Currency not appropriate for the payment type.
• INVALID_AMOUNT: Amount not appropriate for the payment type.
• INVALID_BANK: Receiver bank is invalid.
• INVALID_PROXY_TYPE: Receiver proxy type is invalid.
• INVALID_PROXY_VALUE: Receiver proxy value is invalid.
• INVALID_SENDER_ACCOUNT_CURRENCY: Invalid sender account currency.
• DUPLICATE_TRANSACTION: This payment is not processed because it is a duplicate of a previous payment, ensure you use a unique customerReference.
• OTHERS: Generic or unknown reason. If you need to find out more, reach out to Acme Support.
createdAt stringrequired

Time at which the object was created. In ISO 8601 format.

updatedAt stringrequired

Time at which the object was last updated. In ISO 8601 format.

Example (from schema)

{
  "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": "INVALID_DATE",
  "createdAt": "2023-04-24T00:00:00.000000Z",
  "updatedAt": "2023-04-24T00:00:00.000000Z"
}

Loading...