POST
/v2/stablecoin/withdrawTransfer - Stablecoin Withdraw
Submits a stablecoin withdrawal to the blockchain address on the selected payment instrument.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Authorization | string | Required | Bearer {SessionToken} | Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
BeneficiaryPaymentInstrumentID | string | Required | {paymentInstrumentID} | Payment instrument ID linked to the beneficiary (from List or Create Payment Instrument). |
Amount | string | Required | 1.00 | 2.00 | 3.00 | 4.00 | 5.00 | ... N | Payment amount in the specified currency, as a decimal string (e.g. `1.00`). |
Description | string | Required | Test API Payment | Short memo or narrative for the transaction (shown in history and details). |
IsRemittanceTransaction | string | Optional | Yes | No | Marks the payment as a remittance submitted on behalf of your own end customer. Only available when the remittance feature is enabled on your account; sending it otherwise is rejected. Defaults to `No`. |
UltimateDebtorId | string | Optional | {beneficiaryID} | Beneficiary ID of the Ultimate Debtor, i.e. your end customer who is the actual originator of the funds. Required when `IsRemittanceTransaction` is `Yes` and must be an active beneficiary belonging to your account. Must be omitted otherwise. |
Example request
{
"BeneficiaryPaymentInstrumentID": "{paymentInstrumentID}",
"Amount": "0.01",
"Description": "Testing apis"
}Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422 | API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized). |
ResponseMessage | string | Success | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity | Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome. |
ResponseData | object | Please refer to below example for response body | Contains TransactionNumber for use with Get Transaction Details. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"TransactionNumber": "FVBTC000007938"
}
}Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.