Complete API Reference

Accounts

Get affiliate balances

Get affiliate code

Get affiliate transactions

List uploaded documents for an account

Upload a document for an account

List Account Preferences

Read Account Preference

Update Account Preference

Check progress of account setup

Banking

List Banks by Country

Countries

Detect Country by IP

Currencies

Convert Currency Value

List Cryptocurrencies

List Fiat Currencies

Prices

List Latest Prices

Sentiment

Read Last Exchange Rates

Read Exchange Rates

Read Aggregated Sentiment

Read Last Sentiment

Languages

Users

Reissue Temporary Token

Delete/Revoke API Key

Update User Profile

Get WebSocket Channel

Upload ID verification document

Forgot Password Confirm Reset

Forgot Password Request

Update profile image

Update user password

Get current user profile

Update current user profile

Register a new user

Confirm new user registration

Resend verification email

Confirm Two Factor Code

Begin Two Factor Setup

Check Two Factor Status

P2P Marketplace - Offers - Vendors

Create Offer to Buy

Execution Equation

List Exchanges for Equations

Create Offer to Sell

List Variables for Equations

P2P Marketplace - Orders - Customers

Mark an order as paid (seller)

Pre-authorize buy order

List Completed Orders

Export Orders CSV

Mark an order as paid (buyer)

Update payment status for order

List Pending Orders

Pre-authorize sell order

Upload Order Documentation

View Upload Order Documentation

Get documents for Order

P2P Marketplace - Orders - Chats

Read messages for Order

Send message for order

Retrieve URL for message attachment

P2P Marketplace - Orders - Disputes

List Buyer Dispute Reasons

List Seller Dispute Reasons

Retrieve Dispute

P2P Vendor Applications

List Applications

Apply to be a vendor

Upload an application document

Retrieve Application

Cancel Application

P2P Marketplace - Orders - Vendors

Mark an order as paid (seller)

List Completed Orders

Export Orders CSV

Mark an order as paid (buyer)

List Pending Orders

Upload Order Documentation

Get documents for Order

Payment Methods

List Payment Methods

Create Payment Method

List Payment Method Types

List Dependant options for Payment Method Type on field

List Options for Payment Method Type

List Search options for Payment Method Type

Read Payment Method Type

Retrieve Payment Method

Update Payment Method

Delete Payment Method

List Payment Method Categories

Read Payment Method Category

P2P Marketplace - Offers - Public

Find buy offers

List sell offers

Get offer information

Payment Types and Categories

List Payment Method Categories

List option for Payment Method Type

List Payment Method Types

List Payment Method Types for Category

Transactions

List Transactions

Get Transaction

List Transaction Types

Read Transaction Type

List Transactions for Wallet

Exchange - Historical Data

Retrieve Historical Trades

Retrieve Historical Data

Exchange

Get Order Book For Market

Exchange - Orders

Check access to market

Wallets

Get Deposit Address

Get Funding Options

List Transfer Requests

Create Transfer Request

Estimate Transfer Request Output

Withdraw from Wallet

List Withdrawal Requests

Read Withdrawal Request

Get convertible currencies

Get transferable currencies

Models

AccountDocument

AccountPreference

AccountProgress

AffiliateTransaction

AuthenticationToken

AuthenticationTokenRequest

CountryDocument

CurrencySnapshot

CurrencyWithdrawalParameter

ExchangeOrderRequest

HistoricalDataRequest

OfferPaymentMethod

OrderDisputeReason

PartnerApplication

PartnerApplicationDocument

PaymentMethodCategory

PaymentMethodType

TransactionType

TransferRequest

UserForgotPasswordRequest

UserPasswordChangeRequest

UserRegistrationRequest

WalletFundingOption

WithdrawalRequest

WrappedPrimitive

Powered by Stoplight

post

/api/wallet/withdraw/{id}

Create a new withdrawal request by submitting a WithdrawalRequest object to this method. Upon a successful response, the funds will immediately be debited from the specified wallet id.

1 Path Parameter

Request Body

Schema

object

Withdrawal: A confirmed withdrawal from a user’s wallet to an external address or bank account.

id

integer

format: int64

amount

number

address

string

authorization

object

Authorization: Used when API calls require secondary authentication to confirm an event. totp is required if 2FA is enabled, otherwise password is required.

password

string

totp

string

Responses

successful operation

Schema

object

WithdrawalRequest: A withdrawal request from a user’s wallet to an external address or bank account.

id

integer

format: int64

approved

boolean

default

dateApproved

string

format: date-time

dateCreated

string

format: date-time

lastUpdated

string

format: date-time

notes

string

processed

boolean

default

serializedRequest

string

wallet

object

Wallet: A place to store a single crypto or fiat currency and where transactions can take place.

id

integer

1 validation

description

string

currency

object

Currency: A crypto or fiat currency supported by Coindirect

supportsWithdrawals

boolean

1 validation

supportsDeposits

boolean

1 validation

address

string

lookup

string

balance

number

hash

string

amount

number

message

string

Send a Test Request

Path Params

1 path param not set

id

$$.env

1 variable not set

Authorization