Create Withdrawal

post https://api.payment.sandbox.coinify.com/v1/withdrawals

This page will help you create withdrawals.

This API endpoint allows you to make withdrawals in different cryptocurrencies to the address you specify. The requested amount is deducted from your FIAT account balance.

It is possible to create withdrawals in all cryptocurrencies supported for payments.

Body Params

orderId

string

required

Unique orderId in Merchant's own system.

amount

string

required

Defaults to 30

Amount in FIAT currency you want to withdraw.

currency

string

required

Defaults to USD

Specifies the FIAT currency of the amount parameter. Must be a three-letter ISO currency code of the amount.

finalCurrency

string

required

Defaults to USDC

The cryptocurrency you want your withdrawal request to be paid out in. Check the possible values via Read Currencies API endpoint.

address

string

required

Defaults to 0x42cE19972118a6F59fcA1D7E13A09712E9C83884

Cryptocurrency destination address of the withdrawal.

addressTag

string

Optional, used for only specific cryptocurrencies.

customerId

string

required

Defaults to 6af46318-9e60-4390-8bf0-e042d7b96b21

Unique identifier of the Merchant's customer.

customerEmail

string

required

Defaults to customer@merchant.example.org

Email of the customer receiving the withdrawal.

pluginIdentifier

string

required

Defaults to DemoMerchant - Conify API Integration

Please give your integration a name and version here.

memo

string

Human-readable description of this payment.

context

json

Arbitrary data associated with this Withdrawal. Can be used to store things like ID of the shop that issued the Withdrawal etc. Please refrain from storing any personal data in here as this context is public information. When provided, must be a key-value hash where both the keys and their values are strings. Can accept up to 50 keys.

subaccountId

string

An ID of a Sub-account to which this Withdrawal request should be attributed to.

Responses

Language

Credentials

Header


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://api.payment.sandbox.coinify.com/v1/withdrawals \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "amount": "30",
8
  "currency": "USD",
9
  "finalCurrency": "USDC",
10
  "address": "0x42cE19972118a6F59fcA1D7E13A09712E9C83884",
11
  "customerId": "6af46318-9e60-4390-8bf0-e042d7b96b21",
12
  "customerEmail": "customer@merchant.example.org",
13
  "pluginIdentifier": "DemoMerchant - Conify API Integration"
14
}
15
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

403403

422422