Create Quote Execution

Execute on a quote for buying or selling an asset.

The side, market, and guaranteed price of the execution are specified by the quote with ID quote_id.

The amount to buy or sell must be specified in either fiat or crypto by setting exactly one of:

• base_amount to specify the amount of crypto to buy or sell.
• quote_amount to specify the amount of fiat to spend or acquire.

An otherwise-valid request to create a quote execution may fail with the following types of errors:

• Expired if the quote with ID quote_id has expired.
• Insufficient Funds if the profile with ID profile_id has insufficient available balance to fund the execution.
• Rejected if extreme market conditions (e.g. a very large price swing) have invalidated the quote.
• Already Exists if a Quote Execution with the same ref_id has already been created.

POST /profiles/{profile_id}/quote-executions

cURL

Buy $100 BTC

curl --request POST \
  --url https://api.paxos.com/v2/profiles/{profile_id}/quote-executions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "366a26d2-3098-4226-a520-4bb43ae4d922",
  "quote_amount": "100",
  "metadata": {
    "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339"
  }
}
'

200

Buy $100 BTC

{
  "id": "43a59965-be3a-45ab-841d-c55386e0ff90",
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "quote_id": "366a26d2-3098-4226-a520-4bb43ae4d922",
  "status": "CREATED",
  "market": "BTCUSD",
  "side": "BUY",
  "price": "6001.2",
  "base_amount": "0.016663334",
  "base_asset": "BTC",
  "quote_amount": "100.00",
  "quote_asset": "USD",
  "created_at": "2020-01-17T18:36:31.345Z",
  "metadata": {
    "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339"
  }
}

OAuth Scope

exchange:write_quote_execution

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

profile_id · string · required

The ID of the profile under which to execute this order.

Body

application/json

quote_id · string · required

The ID of the held Quote for buying or selling some asset.

ref_id · string

A unique identifier for the quote execution (for idempotence).

base_amount · string

The amount of the base asset (crypto) to buy or sell using the specified quote. The maximum precision is 8 decimals.

Pattern: ^[0-9]*\.?[0-9]+$

quote_amount · string

The amount of the quote asset (fiat) to spend or acquire using the specified quote. The maximum precision is 2 decimals.

Pattern: ^[0-9]*\.?[0-9]+$

metadata · object

Metadata to store on the quote execution. Up to 6 key/value pairs may be stored, with each key and value at most 100 characters.

Show child attributes

identity_id · string

The end user that requests the quote execution.

account_id · string

The account under which this quote execution is placed. The provided identity must be allowed to trade on behalf of this account.

recipient_profile_id · string

The ID of the profile under which to deposit the funds.

Response

200

application/json

A successful response.

A QuoteExecution is an order to buy or sell an asset at a particular held Quote.

id · string · required

The UUID of the quote execution.

profile_id · string · required

The ID of the profile under which this order executed.

quote_id · string · required

The ID of the quote used to create this quote execution.

status · enum<string> · required

A QuoteExecution begins in state CREATED and transitions to end state SETTLED when all accounting movements are complete.

Available options: CREATED, SETTLED

market · enum<string> · required

Available options: ETHEUR, ETHSGD, ETHUSD, BTCEUR, BTCSGD, BTCUSD, PAXGUSD, BCHUSD, LTCUSD, USDPUSD, LINKUSD, MATICUSD, AAVEUSD, UNIUSD, PEPEUSD, TRUMPUSD, SHIBUSD, ARBUSD, BONKUSD, ENAUSD, MNTUSD, ONDOUSD, PENGUUSD, QNTUSD, RENDERUSD, SKYUSD, WIFUSD, WLDUSD

side · enum<string> · required

Trade side.

Available options: BUY, SELL

price · string · required

The guaranteed price of the quote.

base_amount · string · required

The amount of assets (crypto) in the transaction.

base_asset · string · required

The "base" side of the trading pair (crypto - like BTC, ETH, PAXG).

quote_amount · string · required

The amount of quote currency (cash) in the transaction.

quote_asset · string · required

The "quote" side of the trading pair (fiat - like USD, EUR, SGD).

created_at · string<date-time> · required

The time at which the quote execution was created.

ref_id · string

A unique identifier for the quote execution creation (for idempotence).

settled_at · string<date-time>

The time at which the quote execution was settled, completing its lifecycle.

metadata · object

Client-specified metadata.

Show child attributes

identity_id · string

The identity under which this quote execution is placed.

account_id · string

The account under which this quote execution is placed.

recipient_profile_id · string

The ID of the profile under which to deposit the funds.