post

/api/offer/sell

Create a new sell offer by submitting an Offer object to this method. Upon receiving a successful response, your offer will immediately appear on the peer to peer marketplace, unless there isn’t sufficient bitcoin in your Coindirect wallet balance.

Request Body

Schema
object

Offer: A buy or sell offer listed on the peer to peer marketplace.

id
integer
format: int64
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
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
fundingWallet
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
priceLimitHigher
number
priceLimitLower
number
priceType
string
status
integer
format: int32
type
string
maximumOrderSize
number
minimumOrderSize
number
maximumOrderValue
number
minimumOrderValue
number
totalMaximumAmount
number
price
string
notes
string
expressionDetails
string
paymentWindow
integer
format: int64
paymentMethods
array[object]
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
paymentMethodTypes
array[object]
id
integer
1 validation
category
object

PaymentMethodCategory: A high-level category of payment methods

enabled
boolean
1 validation
name
string
options
object
countryOptions
object
features
array[string]
latestPrice
number
countries
array[object]
id
integer
1 validation
allowRegistration
boolean
1 validation
code
string
name
string
documents
array[object]
defaultCurrency
string
options
object
region
object

Region

Responses

successful operation

Schema
object

Offer: A buy or sell offer listed on the peer to peer marketplace.

id
integer
format: int64
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
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
fundingWallet
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
priceLimitHigher
number
priceLimitLower
number
priceType
string
status
integer
format: int32
type
string
maximumOrderSize
number
minimumOrderSize
number
maximumOrderValue
number
minimumOrderValue
number
totalMaximumAmount
number
price
string
notes
string
expressionDetails
string
paymentWindow
integer
format: int64
paymentMethods
array[object]
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
paymentMethodTypes
array[object]
id
integer
1 validation
category
object

PaymentMethodCategory: A high-level category of payment methods

enabled
boolean
1 validation
name
string
options
object
countryOptions
object
features
array[string]
latestPrice
number
countries
array[object]
id
integer
1 validation
allowRegistration
boolean
1 validation
code
string
name
string
documents
array[object]
defaultCurrency
string
options
object
region
object

Region

Send a Test Request

$$.env
1 variable not set
Authorization