Return to Orbital Homepage
API Documentation
Login to the Client Portal

Create Crypto Payout

post
https://api.getorbital.io/crypto/withdrawal

Initiates a crypto payout from the Merchant's balance to the Receiver's designated wallet address.

Body Params
string
required

Unique ID for the transaction generated by the merchant. Each request requires a new externalId; reusing one is not allowed.

string
required

The Receiver's crypto wallet address where funds will be received.

string
enum

The currency held in the Merchant's balance from which the withdrawal amount will be deducted.

Accepted: USD, GBP, EUR, USDT, USDC, ETH, BTC, LTC, BCH.

string

The blockchain network required for stablecoin payouts (USDT or USDC).

For e.g., if USDT is specified in the targetCurrency field and TON here, it signifies USDT on TON (USDT-TON).

Allowed networks for USDT: TRX, ETH, MATIC, TON, BNB.

Allowed networks for USDC: SOL, ETH, MATIC, TRX, BNB.

string

The specific amount of sourceCurrency that the Merchant wants to deduct from their balance for this payout.

string
enum

The cryptocurrency that the Receiver will get in their wallet.

Accepted: USDT, USDC, ETH, BTC, LTC, BCH.

  • If sourceCurrency is fiat and targetCurrency is crypto (e.g., USD to USDT), a fiat-crypto conversion occurs.
  • If sourceCurrency is crypto and targetCurrency is a different crypto (e.g., USDT to ETH), a crypto-to-crypto conversion occurs.
Allowed:
string

The specific amount of targetCurrency that the Receiver is expected to receive.

string
enum

The currency in which the receiver's balance is displayed on the merchant platform.

string

The amount in cashierCurrency that is displayed in the Receiver's balance on the merchant platform.

uri
required

Webhook URL where the merchant will receive payout status updates.

boolean
Defaults to false

Set to true if you want the receiver to cover the network fee on behalf of the merchant.

string
required
length ≤ 100

Receiver's first name.

string
required
length ≤ 100

Receiver's last name.

Note: For customers in countries where last names are not available, pass LNU (Last Name Unavailable) in this field.

date
required

Receiver's date of birth (YYYY-MM-DD).

string
enum
Defaults to naturalPerson

Indicates the type of Receiver. Can be naturalPerson or legalPerson.

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago