STstraitsx

Get a list of payments

Changed on

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

get/payments

Request

  • Base URL
    https://api-sandbox.straitsx.com/v1
  • URL
    https://api-sandbox.straitsx.com/v1/payments
  • Auth
    API key in header X-XFERS-APP-API-KEY

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[currency]string

Accepts xsgd, xusd, sgd or usd

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[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.<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": "contract_39f038cd10f24a78abd3ce6b3b7504b3",
      "type": "bankTransferTransaction",
      "attributes": {
        "idempotencyId": "SUBSCRIPTION_f4edd70890bfbb38bf5d0c4229f8fd07",
        "currency": "xsgd",
        "amount": "0.1",
        "fees": "0.1",
        "status": "completed",
        "createdAt": "2024-07-29T15:17:04.754+08:00"
      }
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  }
}

Changes

  • d17239d67150Revision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      added subschema #1: Bank Transfer subschema #2: PayNow to the /// response property oneOf list for the response status

    • breaking

      the //// response's property type changed from no type to string for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response's property default value 0 was removed for the status

    • info

      the response's property default value 0 was removed for the status