v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a payment

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

get/payments/{contract_id}

Path parameters

contract_idstring required

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

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_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",
      "senderInformation": {
        "accountHolderName": "LIM ZI XUAN",
        "accountNumber": "00000001",
        "bankName": "DBS Bank Ltd",
        "endToEndRef": "Transfer",
        "swiftBic": "DBSSSGSGXXX"
      },
      "paymentMethod": {
        "id": "StraitsX-3184-c7fe5d05-6d21-4f0a-8179-bcf33c038b36",
        "referenceId": "BCD",
        "accountNo": "3225225839000",
        "bankShortCode": "FAZZ",
        "recipientName": "Xfers Pte Ltd"
      }
    }
  }
}