put

/api/order/{id}

A pre-authorised buy or sell order needs to be confirmed by submitting an Authorization object to this method and specifying the order id in the path. Confirming an order results in the coins being debited from the seller’s wallet and placed into Escrow at Coindirect.

1 Path Parameter

Request Body

Schema
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

Order: A confirmed buy or sell order placed on the peer to peer marketplace.

id
integer
format: int64
price
number
currencyForSale
object

Currency: A crypto or fiat currency supported by Coindirect

id
integer
1 validation
code
string
fiat
boolean
1 validation
icon
string
name
string
withdrawalParameters
array[object]
options
object
withdrawalFee
number
depositFee
number
baseCurrency
object

Currency: A crypto or fiat currency supported by Coindirect

id
integer
1 validation
code
string
fiat
boolean
1 validation
icon
string
name
string
withdrawalParameters
array[object]
options
object
withdrawalFee
number
depositFee
number
baseAmount
number
basePrice
number
amount
number
value
number
achievedAmount
number
achievedOutput
number
expiresIn
integer
format: int64
dateCreated
string
format: date-time
status
integer
format: int32
paymentMethod
object

PaymentMethod: A bank account, wallet or other payment method linked to a Coindirect account

id
integer
1 validation
currency
string
options
object
type
object

PaymentMethodType: A type of payment method that falls under a particular payment category

description
string
uploadableDocuments
array[string]
documents
array[object]
id
integer
1 validation
description
string
file
object

EncodedFile: Generic object that can be used to represent a file or document.

publicUrl
string
paymentOptions
array[object]
id
integer
1 validation
description
string
returnUrl
string
currencyAccepted
object

Currency: A crypto or fiat currency supported by Coindirect

id
integer
1 validation
code
string
fiat
boolean
1 validation
icon
string
name
string
withdrawalParameters
array[object]
options
object
withdrawalFee
number
depositFee
number
paid
boolean
default
type
string
rating
integer
format: int32
buyerAccount
object

PublicAccount: The details of a Coindirect user account visible to the public.

id
integer
1 validation
name
string
country
string
city
string
rating
object

RatingSummary: A star rating summary linked to a Coindirect marketplace vendor

sellerAccount
object

PublicAccount: The details of a Coindirect user account visible to the public.

id
integer
1 validation
name
string
country
string
city
string
rating
object

RatingSummary: A star rating summary linked to a Coindirect marketplace vendor

chat
boolean
default
notes
string
paymentReference
string
paymentTime
string
format: date-time
paymentType
string
paymentMetadata
object
dispute
boolean
default
exchangeRequired
boolean
default
offer
object

PublicOffer

id
integer
1 validation
currencyForSale
object

Currency: A crypto or fiat currency supported by Coindirect

currencyAccepted
object

Currency: A crypto or fiat currency supported by Coindirect

baseCurrency
object

Currency: A crypto or fiat currency supported by Coindirect

minimumAmount
number
maximumAmount
number
minimumValue
number
maximumValue
number
price
number
basePrice
number
offerAccount
object

PublicAccount: The details of a Coindirect user account visible to the public.

paymentWindow
integer
1 validation
notes
string
directTransfer
boolean
1 validation
features
array[string]
convertToCurrency
object

Currency: A crypto or fiat currency supported by Coindirect

id
integer
1 validation
code
string
fiat
boolean
1 validation
icon
string
name
string
withdrawalParameters
array[object]
options
object
withdrawalFee
number
depositFee
number

Send a Test Request

Path Params
1 path param not set
id
$$.env
1 variable not set
Authorization