v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Withdraw Endpoints

gcm/withdraw/quote

Get a quote for a certain amount to be sold or bought using a certain corridor delivery method.

post/gcm/withdraw/quote

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

DeliveryChannelIDstring required

The delivery channel ID

ClientAccountIDstring

The client account ID

BuyAmountstring

The amount to be bought

SellAmountstring

The amount to be sold

FeesIncludedboolean

Whether fees are included

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Error message if any

Example response

{
  "Quote": {
    "CrossborderQuoteID": "6690052331",
    "ExpiryTime": "2024-11-20 01:42:58",
    "ChargedAmount": "100.00",
    "PrincipalAmount": "98.40",
    "CreditedAmount": "57.01",
    "FXRate": "0.579370",
    "ServiceFee": "0.00",
    "DeliveryFee": "1.60",
    "HasSufficientFunds": true
  }
}