v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a payment for a customer profile

[Available in Production/Sandbox environment] Retrieve a payment made via bank transfer or PayNow

get/{customer_profile_id}/deposits/{deposit_id}

Path parameters

customer_profile_idstring required

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

deposit_idstring required

Deposit ID is retrieved from the callback of a bank transfer payment

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: 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. Note: 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. Note: 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. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: 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. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200

idstring

Payment contract ID.

typestring

Transaction type.

idempotency_idstring

Idempotency ID for the transaction.

amountstring

Transaction amount.

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:fees","oasType":"schema","type":"unknown","description":"Additional transaction fees charged."}

statusstring

Transaction status.

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:bank_account_no","oasType":"schema","type":"unknown","description":"Bank account number."}

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:merchant_ref","oasType":"schema","type":"unknown","description":"Merchant reference."}

blocked_reasonsobject[]

Reasons blocking the transaction, if any.

currencystring

Transaction currency.

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:end_to_end_ref","oasType":"schema","type":"unknown","description":"End user’s added comments/notes."}

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:sender_bank","oasType":"schema","type":"unknown","description":"Sender bank name."}

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:sender_bank_account_no","oasType":"schema","type":"unknown","description":"Sender's bank account number."}

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:sender_bank_account_holder_name","oasType":"schema","type":"unknown","description":"Sender's bank account holder name."}

{"stackTrail":"paths:/{customer_profile_id}/deposits/{deposit_id}:get:responses:200:content:application/json:schema:properties:sender_bank_swift_bic","oasType":"schema","type":"unknown","description":"Sender's bank SWIFT/BIC code."}

created_atstring

Timestamp when the transaction was created.

Example response

{
  "id": "contract_df1bebad457c40dc91fa4dd64e297912",
  "type": "Direct bank transfer",
  "idempotency_id": "1ee0f5ee-2699-4712-a727-179870fa5424",
  "amount": "27.0",
  "status": "pending",
  "currency": "xsgd",
  "created_at": "2023-09-27T07:45:31.425Z"
}