Get a payment
Changed on[Available in Production/Sandbox environment] Retrieve a payment made via bank transfer or PayNow
Request
- Base URLhttps://api-sandbox.straitsx.com/v1
- AuthAPI key in header X-XFERS-APP-API-KEY
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Contract ID is retrieved from the callback of a bank transfer payment
Headers
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.
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.
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.
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.
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"
}
}
}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 Transfersubschema #2: PayNowto the//response propertyoneOflist for the response status - breaking
the
///response's property type changed from no type tostringfor 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
- breaking