Skip to main content

Create a test transaction

POST 
/transactions

This request is only available in test mode.

Request​

Body

    dataSource stringrequired

    Possible values: [ICN, IDN, CAMT.053]

    Data source where the information for this transaction came from

    transactionType stringrequired

    Possible values: [FAST, PAYNOW, ACT, TT, MEPS, GIRO, OTHERS]

    Transaction type

    bankReference string

    Reference ID set by the bank

    description stringdeprecated

    The transaction detail text that often appears on your bank statement and in your banking portal.

    Deprecated: use customerReference instead.

    customerReference string

    Customer reference set by the sender. Often used to allow the receiving part to recognize and reconcile the transaction.

    remittanceInformation string

    Remittance information, if available.

    additionalInformation string

    Additional information, if available.

    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

    Possible values: [SGD, EUR, USD]

    Three-letter ISO 4217 currency code in full uppercase. Must be a supported currency.

    direction stringrequired

    Possible values: [CREDIT, DEBIT]

    Credit transaction or debit transaction

    counterparty

    object

    The other party of this transaction. For a credit transaction, the counterparty is the party where money was debited from. For a debit transaction, the counterparty is the party where money was credited to.

    name string

    Counterparty name

    bank string

    Counterparty bank SWIFT/BIC code

    bankAccountNumber string

    Counterparty bank account number

    virtualAccountNumber string

    Virtual Account number, if the transaction destination is a Virtual Account.

    transactionDate string

    Transaction date

    sendWebhook boolean

    Default value: true

    Specify false to prevent a transactions.created webhook from being sent

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.

    dataSource stringrequired

    Possible values: [ICN, IDN, CAMT.053, CAMT052, CAMT053, CAMT054]

    Data source where the information for this transaction came from:

    • ICN, IDN: Real-time or semi-real-time credit transaction notification. Applicable to: DBS
    • CAMT.053: End-of-day statement. Applicable to: DBS
    • CAMT052: Intra-day statement. Applicable to: DBS
    • CAMT053: End-of-day statement. Applicable to: Citi
    • CAMT054: Real-time transaction notification. Applicable to: Citi
    transactionType stringrequired

    Possible values: [FAST, PAYNOW, ACT, TT, MEPS, GIRO, OTHERS]

    Transaction type

    bankReference stringrequired

    Transaction reference ID set by the bank

    description stringrequireddeprecated

    The transaction detail text that often appears on your bank statement and in your banking portal.

    Deprecated: use customerReference instead.

    customerReference string

    Customer reference set by the sender. Often used to allow the receiving party to recognize and reconcile the transaction.

    remittanceInformation string

    Remittance information, if available.

    additionalInformation string

    Additional information, if available.

    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.

    direction stringrequired

    Possible values: [CREDIT, DEBIT]

    Credit transaction or debit transaction

    counterparty

    object

    required

    The other party of this transaction. For a credit transaction, the counterparty is the party where money was debited from. For a debit transaction, the counterparty is the party where money was credited to.

    name string

    Counterparty name

    bank string

    Counterparty bank SWIFT/BIC code

    bankAccountNumber string

    Counterparty bank account number

    bankAccount

    object

    The bank account of the transaction

    id string

    Internal account ID

    bank string

    Bank SWIFT/BIC code

    bankAccountNumber string

    Account number

    virtualAccountNumber string

    Virtual Account number, if the transaction destination is a Virtual Account.

    transactionDate stringrequired

    Transaction date

    statementId string

    ID of the statement that the transaction is a part of.

    createdAt stringrequired

    Creation timestamp

    updatedAt stringrequired

    Last updated timestamp

Loading...