Get a payment for a customer profile

get

https://api-sandbox.straitsx.com/v1/customer_profile/{customer_profile_id}/deposits/{deposit_id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

When a payment is received, callback will also be sent to to the URL indicated on the StraitsX Business Dashboard - check out the guide here: Confirm deposit has been received

Path Params

customer_profile_id

string

required

Defaults to customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65

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

deposit_id

string

required

Defaults to contract_ace7f5761016402b9330f517ae2fdc1e

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

Headers

X-XFERS-APP-API-KEY

string

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-ID

string

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-TIMESTAMP

string

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-NONCE

string

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-SIGNATURE

string

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200