Skip to main content

Get a Payment

GET 
/payments/:id

Get a Payment

Request​

Path Parameters

    id stringrequired

Responses​

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.

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.

Loading...