I want to sell Bitcoin and receive a specific amount in fiat. What do I do?
When you provide 'desiredFiatAmount' instead of the 'cryptoAmount', we will calculate the amount in Bitcoin
you have to pay based on current exchange rates for you.
How are callbacks handled?
There are several different events you can provide one callback URL for. We will call the provided URL upon the
event being fired once. The GET parameter "order_id" will be added automatically to the request.
I see you need the name of the bank for payouts involving a bank transfer. Do you have a list of accepted bank names?
Vietcombank
Techcombank
VietinBank
AgriBank
BIDV
ACB
SacomBank
EximBank
DongA Bank
VPBank
SeaBank
TienPhong Bank
VIB
MB
SHB
OceanBank
PG Bank
VietA Bank
SaigonBank
AnBinh Bank
HD Bank
Maritime Bank
OCB
GPBank
NamA Bank
BacA Bank
SCB
Shinhan Bank
PVcomBank
Kienlongbank
HSBC
Standard Chartered
Citibank
Woori Bank
Parameters
Parameter
Type
Required?
Format
Description
order
object (Order)
true
order[type]
string
true
{not blank}, [buy|sell]
The type of the order (buy or sell)
order[cryptoCurrency]
string
false
[BTC|ETH|BCH|LTC|DASH]
Symbol of crypto currency, defaults to 'BTC'
order[cryptoAmount]
float
true
{not blank}
Amount in crypto currency, only required for sell orders
order[fiatAmount]
float
true
{not blank}
Amount in fiat currency, only required for buy orders
order[desiredFiatAmount]
float
false
Amount desired for payout
order[desiredCryptoAmount]
float
false
Amount desired for payout
order[paymentMethod]
string
true
{not blank}, [bank|credit], [crypto|credit]
Payment method
order[callback]
object (EventCallback)
false
Collection of callback URLs
order[callback][onCreate]
string
false
Called when order is created
order[callback][onMarkAsPaid]
string
false
Called when order is marked as paid
order[callback][onMarkAsNotPaid]
string
false
Called when order is marked as NOT paid
order[callback][onRateLock]
string
false
Called when rate for order is locked
order[callback][onClose]
string
false
Called when order is closed
order[callback][onCancel]
string
false
Called when order is cancelled
order[callback][onReopen]
string
false
Called when order is reopened
order[payout]
object (Payout)
false
Payout data
order[payout][atmCard]
object (AtmCard)
false
order[payout][atmCard][contactEmail]
string
false
E-mail address to contact in case of any unforeseen event
order[payout][atmCard][contactPhone]
string
false
Phone number to call in case of any unforeseen event
order[payout][atmCard][bankName]
string
false
Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][atmCard][accountHolder]
string
false
Account holder name
order[payout][atmCard][cardNumber]
string
false
ATM card number
order[payout][bank]
object (Bank)
false
order[payout][bank][contactEmail]
string
false
E-mail address to contact in case of any unforeseen event
order[payout][bank][contactPhone]
string
false
Phone number to call in case of any unforeseen event
order[payout][bank][bankName]
string
false
Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][bank][bankBranch]
string
false
Branch of the bank
order[payout][bank][accountNumber]
string
false
Account number
order[payout][bank][accountHolder]
string
false
Holder of the bank account
order[payout][bank][swift]
string
false
Swift code, if available
order[payout][crypto]
object (Crypto)
false
order[payout][crypto][address]
string
false
Crypto destination address
order[payout][bitcoin]
object (Crypto)
false
Deprecated, will be removed in the future. Use "crypto" payout field instead.
order[payout][cashToId]
object (CashToId)
false
order[payout][cashToId][contactEmail]
string
false
E-mail address to contact in case of any unforeseen event
order[payout][cashToId][contactPhone]
string
false
Phone number to call in case of any unforeseen event
order[payout][cashToId][recipientName]
string
false
Full name of the recipient
order[payout][cashToId][recipientId]
string
false
ID number of the recipient
order[payout][cashToId][recipientIdDateOfIssue]
DateTime
false
Date of ID issue
order[payout][cashToId][recipientIdPlaceOfIssue]
string
false
Location of ID issue
order[payout][cashToId][bankName]
string
false
Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][cashToId][bankBranch]
string
false
Branch of the bank
order[payout][cashToId][bankLocation]
string
false
Location of the bank
order[serviceProvider]
string
false
Service provider (for internal use only)
Headers
Name
Required?
Description
APIKEY
true
Your API key
Return
Parameter
Type
Versions
Description
200
- Returned when successful
status
integer
*
HTTP status
error
object (Error)
*
error[code]
integer
*
Error code
error[message]
string
*
Error message
error[field]
string
*
The field in which a problematic value has been submitted, if available
order
object (Order)
*
order[id]
string
*
Order ID
order[type]
string
*
Type of order
order[cryptoCurrency]
string
*
Symbol of crypto currency
order[fees]
object (Fees)
*
Order fees
order[fees][rate]
float
*
Fee rate
order[fees][fixedAmount]
float
*
Fixed fee amount
order[fees][voluntaryAmount]
float
*
Voluntary fee amount
order[rate]
float
*
Exchange rate
order[cryptoAmount]
float
*
Amount in crypto currency
order[fiatAmount]
float
*
Amount in fiat currency
order[desiredFiatAmount]
float
*
Desired amount in fiat currency
order[payout]
object (Payout)
*
order[payout][atmCard]
object (AtmCard)
*
order[payout][atmCard][amount]
float
*
order[payout][atmCard][currency]
string
*
order[payout][atmCard][contactEmail]
string
*
E-mail address to contact in case of any unforeseen event
order[payout][atmCard][contactPhone]
string
*
Phone number to call in case of any unforeseen event
order[payout][atmCard][bankName]
string
*
Name of the bank
order[payout][atmCard][accountHolder]
string
*
Account holder name
order[payout][atmCard][cardNumber]
string
*
ATM card number
order[payout][bank]
object (Bank)
*
order[payout][bank][amount]
float
*
order[payout][bank][currency]
string
*
order[payout][bank][contactEmail]
string
*
E-mail address to contact in case of any unforeseen event
order[payout][bank][contactPhone]
string
*
Phone number to call in case of any unforeseen event
order[payout][bank][bankName]
string
*
Name of the bank
order[payout][bank][bankBranch]
string
*
Branch of the bank
order[payout][bank][accountNumber]
string
*
Account number
order[payout][bank][accountHolder]
string
*
Holder of the bank account
order[payout][bank][swift]
string
*
Swift code, if available
order[payout][bitcoin]
object (Crypto)
*
order[payout][bitcoin][amount]
float
*
order[payout][bitcoin][currency]
string
*
order[payout][bitcoin][address]
string
*
Bitcoin address
order[payout][crypto]
object (Crypto)
*
order[payout][cashToId]
object (CashToId)
*
order[payout][cashToId][amount]
float
*
order[payout][cashToId][currency]
string
*
order[payout][cashToId][contactEmail]
string
*
E-mail address to contact in case of any unforeseen event
order[payout][cashToId][contactPhone]
string
*
Phone number to call in case of any unforeseen event
BitcoinVN.io API documentation