Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Create a mock bank transfer payment

[Available in Sandbox environment only] Send test funds to your business account via bank transfer

post/sandbox/customer_profile/{customer_profile_id}/bank_transfer_simulations

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response of Create Customer Profile API<br>Regex: /^\s*.{1,191}\s*$/

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

destination_bank_short_codestring

Accepts FAZZ, SCB or DBS

destination_bank_account_nostring required

You can retrieve the virtual_account_no from the response of Get a virtual bank account API<br>Regex: /^\s*.{1,255}\s*$/

currency'SGD' | 'USD'

SGD by default if left empty

amountstring required

Transaction amount(Must be a positive float)<br>Regex: /^(?=.*[1-9])\d+(\.\d{1,2})?$/

source_bank_account_holder_namestring required

Input a name here to test the pending status for name matching failure.<br>Regex: /^\s*.{1,255}\s*$/

source_bank_swift_codestring

Regex: /^\s*.{1,255}\s*$/

source_bank_account_nostring

Regex: /^\s*.{1,255}\s*$/

end_to_end_refstring

End user's added comments / notes<br>Regex: /^\s*.{1,255}\s*$/

Response

200

idstring

Payment contract ID.

typestring

Transaction type.

idempotency_idstring

Idempotency ID for the transaction.

customer_profile_idstring

Customer profile ID.

amountstring

Transaction amount.

feesstring

Fees charged for the transaction.

statusstring

Transaction status.

bank_account_nostring

Destination bank account number.

merchant_refstring

Merchant reference.

currencystring

Transaction currency.

{"stackTrail":"paths:/sandbox/customer_profile/{customer_profile_id}/bank_transfer_simulations:post:responses:200:content:application/json:schema:properties:end_to_end_ref","oasType":"schema","type":"unknown","description":"End user’s added comments/notes."}
{"stackTrail":"paths:/sandbox/customer_profile/{customer_profile_id}/bank_transfer_simulations:post:responses:200:content:application/json:schema:properties:transaction_remarks","oasType":"schema","type":"unknown","description":"Transaction remarks."}
sender_bankstring

Sender's bank name.

sender_bank_account_nostring

Sender's bank account number.

sender_bank_account_holder_namestring

Sender's bank account holder name.

sender_bank_swift_bicstring

Sender's bank SWIFT/BIC code.

created_atstring

Timestamp when the transaction was created.

Example response

{
  "id": "contract_fac6965b3bf747188dc8931ac31b1df8",
  "type": "Direct bank transfer",
  "idempotency_id": "f80ce624-f8a4-4c43-88c7-442ebd9d2a22",
  "customer_profile_id": "customer_profile_ea25ab3c-b7b7-49ba-ac66-aec1b9a0374b",
  "amount": "100.0",
  "fees": "0.45",
  "status": "pending",
  "bank_account_no": "3119477401622",
  "merchant_ref": "Sang_test",
  "currency": "xsgd",
  "sender_bank": "DBS Bank Ltd",
  "sender_bank_account_no": "123456789",
  "sender_bank_account_holder_name": "John Doe",
  "sender_bank_swift_bic": "DBSSSGSGXXX",
  "created_at": "2024-06-12T01:39:18.626Z"
}