Home
POST/v2/stablecoin/withdraw/preview

Preview- Stablecoin Withdraw

Previews a stablecoin withdrawal: returns amount, currency, fees, and total before you submit the transfer.

Headers

FieldTypeRequiredPossible valuesDescription
AuthorizationstringRequiredBearer {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

FieldTypeRequiredPossible valuesDescription
BeneficiaryPaymentInstrumentIDstringRequired{paymentInstrumentID}Payment instrument ID linked to the beneficiary (from List or Create Payment Instrument).
AmountstringRequired1.00 | 2.00 | 3.00 | 4.00 | 5.00 | ... NPayment amount in the specified currency, as a decimal string (e.g. `1.00`).
DescriptionstringRequiredTest API PaymentShort memo or narrative for the transaction (shown in history and details).

Example request

{
  "BeneficiaryPaymentInstrumentID": "{paymentInstrumentID}",
  "Amount": "400",
  "Description": "Testing apis"
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntityHuman-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
ResponseDataobjectPlease refer to below example for response bodyTransaction preview including amount, currency, fees, from/to, and total.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Amount": "0.00000001",
    "Currency": "BTC",
    "Description": "Test API Payment",
    "Fee": "0.00000001",
    "From": "Rishav_Business - Rishav",
    "To": "Earnest-TRF",
    "Total": "0.00000002"
  }
  …

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose