STstraitsx

Get a list of payments

[Available in Production/Sandbox environment] Retrieve payments made via bank transfer or PayNow across all customer profiles

get/deposits

Request

  • Base URL
    https://api-sandbox.straitsx.com/v1/customer_profile
  • URL
    https://api-sandbox.straitsx.com/v1/customer_profile/deposits
  • Auth
    none required

Query parameters

page[size]integer

Number of transactions per page<br>Regex: /^0*[1-9][0-9]*$/

page[number]integer

Page number<br>Regex: /^0*[1-9][0-9]*$/

sortstring

Sorted by <br> <b>Creation Date:</b> Ascending (created_at) / Descending (-created_at) <br><b>Amount:</b>Ascending (amount) / Descending (-amount)

filter[created_after]string

ISO8601 format

filter[created_before]string

ISO8601 format

filter[currency]string

Accepts only SGD, USD, XSGD or XUSD

filter[status]string

Accepts only pending, refunded or completed

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.

Response

200

idstring
typestring
idempotency_idstring
customer_profile_idstring
amountstring
feesunknown
statusstring
bank_account_nounknown
merchant_refunknown
currencystring
end_to_end_refunknown
sender_bankunknown
sender_bank_account_nounknown
sender_bank_account_holder_nameunknown
sender_bank_swift_bicunknown
created_atstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.