Get a list of payments for a customer profile v1

[Available in Production/Sandbox environment] Retrieve payments made via bank transfer or PayNow for a customer profile

get/{customer_profile_id}/deposits

Request

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

Path parameters

customer_profile_idstring required

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

Query parameters

page[size]integer

Number of transactions per page(Must be an integer greater than 0) Regex: /^0*[1-9][0-9]*$/

page[number]integer

Page number(Must be an integer greater than 0) Regex: /^0*[1-9][0-9]*$/

sortstring

Must be either created_at or amount Creation Date: Ascending (created_at) / Descending (-created_at) Amount:Ascending (amount) / Descending (-amount)

filter[created_after]string

ISO8601 format Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[created_before]string

ISO8601 format Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[currency]string

Accepts only SGD or USD

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. 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. Either Direct bank transfer or paynowTransaction.

idempotency_idstring

Idempotency ID for the transaction.

amountstring

Transaction amount.

feesstring nullable

Additional transaction fees charged.

statusstring

Transaction status.

bank_account_nostring nullable

Bank account number from the payment method.

merchant_refstring nullable

Merchant reference ID.

currencystring

Transaction currency.

end_to_end_refstring nullable

End user's added comments/notes.

transaction_remarksstring nullable

Transaction remarks from the sender.

sender_bankstring nullable

Sender bank name.

sender_bank_account_nostring nullable

Sender's bank account number.

sender_bank_account_holder_namestring nullable

Sender's bank account holder name.

sender_bank_swift_bicstring nullable

Sender's bank SWIFT/BIC code.

created_atstring

Timestamp when the transaction was created (Singapore timezone).

updated_atstring

Timestamp when the transaction was last updated (Singapore timezone).

customer_profile_idstring

Customer Profile ID associated with this payment.

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-27T15:45:31.425+08:00",
    "updated_at": "2023-09-27T15:45:31.425+08:00",
    "customer_profile_id": "customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65"
  }
]

Changes

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