STstraitsx

[Sandbox] Update status of mock bank transfer payment

Changed on

[Available in Sandbox environment only] Update status of mock bank transfer payment to completed or failed

put/sandbox/customer_profile/{customer_profile_id}/payments/{contract_id}

Request

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

Path parameters

customer_profile_idstring required

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

contract_idstring required

Contract ID is retrieved from the response of Create a mock PayNow payment API

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.

Request body

Response

200

Example response

{
  "data": {
    "id": "contract_3b90b46511d54ac2b9e7e49344d68263",
    "type": "paynowTransaction",
    "attributes": {
      "idempotencyId": "268fd78a-b874-47dc-a22c-8baa63238ed9",
      "customerProfileId": "customer_profile_ea25ab3c-b7b7-49ba-ac66-aec1b9a0374b",
      "amount": "0.1",
      "fees": "0.0",
      "status": "completed",
      "createdAt": "2024-06-25T09:48:34.081+08:00",
      "senderInformation": {
        "accountHolderName": "John Doe",
        "accountNumber": "123456789",
        "bankName": "DBS Bank Ltd",
        "endToEndRef": "Testing Remarks",
        "swiftBic": "DBSSSGSGXXX"
      },
      "paymentMethod": {
        "id": "payment_method_07ed79c2-2cd9-4562-9ab2-7669b5840c58",
        "referenceId": "Sang_test",
        "accountNo": "3119477401622",
        "bankShortCode": "FAZZ",
        "recipientName": "Xfers Pte Ltd"
      }
    }
  }
}

Changes

  • d17239d67150Revision changes
    • warning

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

    • warning

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

    • info

      api operation id sandbox-update-status-of-mock-paynow-payment removed and replaced with update-status-of-mock-bank-transfer-payment

    • info

      added the optional property /// to 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 paynowTransaction was removed for the status