Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of payment methods

[Available in Production/Sandbox environment] Retrieve payment methods created

get/payment_methods

Query parameters

page[size]integer

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

page[number]integer

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

filter[from]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z<br>Regex: ISO_8601_DATE_TIME: /^(\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<br>Regex: ISO_8601_DATE_TIME: /^(\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[type]string

Accepts only paynow or virtual_bank_account

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

Example response

{
  "data": [
    {
      "id": "StraitsX-3184-26b835a3-227c-4e70-8507-b1234334472d",
      "type": "virtual_bank_account",
      "attributes": {
        "referenceId": "sample-va",
        "instructions": {
          "bankShortCode": "FAZZ",
          "accountNo": "32253006900",
          "recipient_name": "Xfers Pte Ltd",
          "bank_payee_name": "Xfers Pte Ltd"
        }
      }
    }
  ]
}