Get a list of payments for a customer profile v2

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

get/{customer_profile_id}/payments

Request

Base URL
https://api-sandbox.straitsx.com/v1/customer_profile
URL
https://api-sandbox.straitsx.com/v1/customer_profile/{customer_profile_id}/payments
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[currency]string

Accepts only XSGD or XUSD

filter[from]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z 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[to]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z 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[paymentMethodType]string

Accepts only bank_transfer or paynow

filter[status]string

Accepts only pending, failed 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

Example response

{
  "data": [
    {
      "id": "contract_b2a96e5ce51a4f68b7cba7590fb0a8ff",
      "type": "paynowTransaction",
      "attributes": {
        "idempotencyId": "dynamic_paynow_payment_5",
        "customerProfileId": "customer_profile_90d4576d-eba9-4579-a51e-ef048a6faa36",
        "currency": "sgd",
        "amount": "199999.0",
        "fees": "0.0",
        "status": "pending",
        "createdAt": "2024-06-20T15:22:22.250+08:00"
      }
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  }
}

Changes

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