API Reference

Create Withdrawal

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

This page will help you create withdrawals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique orderId in Merchant's own system.

string
required
Defaults to 30

Amount in FIAT currency you want to withdraw.

string
required
Defaults to USD

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

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.

string
required
Defaults to 0x42cE19972118a6F59fcA1D7E13A09712E9C83884

Cryptocurrency destination address of the withdrawal.

string

Optional, used for only specific cryptocurrencies.

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

Unique identifier of the Merchant's customer.

string
required
Defaults to [email protected]

Email of the customer receiving the withdrawal.

string
required
Defaults to DemoMerchant - Conify API Integration

Please give your integration a name and version here.

string

Human-readable description of this payment.

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.

string

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

string

The customer's wallet ID as returned on Create Customer Wallet or fetched from Read Customer API endpoint. UUID format.

Responses

Updated about 1 month 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 about 1 month ago