Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Update status of mock first party bank transfer payout

[Available in Sandbox environment only] Update status of created payout from pending

put/{customer_profile_id}/withdrawals/{contract_id}

Path parameters

customer_profile_idstring required

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

contract_idstring required

ID can be retrieved from the response in Create a first party bank transfer payout 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

statusstring required

Accepts only completed or failed

Response

200

idstring

Payout contract ID.

idempotency_idstring

Idempotency ID for the transaction.

typestring

Request type.

statusstring

Transaction status.

amountstring

Transaction amount.

feesstring

Fees charged for the transaction.

account_nostring

Bank account number.

bank_abbrevstring

Bank abbreviation.

expressboolean

Transfer method (e.g. FAST).

{"stackTrail":"paths:/{customer_profile_id}/withdrawals/{contract_id}:put:responses:200:content:application/json:schema:properties:value_date","oasType":"schema","type":"unknown","description":"Date when the transaction is settled and funds are made available to the beneficiary."}
{"stackTrail":"paths:/{customer_profile_id}/withdrawals/{contract_id}:put:responses:200:content:application/json:schema:properties:failure_reason","oasType":"schema","type":"unknown","description":"Reason for failure (if applicable)."}
created_atstring

Timestamp when the transaction was created.

Example response

{
  "id": "contract_c5fc76a331e248e888ab5922e1fa7382",
  "idempotency_id": "567fb3ac-efda-4d35-8dc8-bb5ce91af54d",
  "type": "Withdrawal on behalf",
  "status": "completed",
  "amount": "11.94",
  "fees": "0.0",
  "account_no": "64122371721287",
  "bank_abbrev": "DBS",
  "created_at": "2019-15-06T10:43:29+07:00"
}