Execute Reusable Quote

Reusable Quote Executions buy or sell assets using a Reusable Quote obtained from the Reusable Quote Creation flow.

The asset, and guaranteed price/rate 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 reusable quote with ID reusable_quote_id has expired.
Insufficient Funds if the end user with ID end_user_id has insufficient available balance to fund the execution.
Quote with no price if a Reusable Quote has its prices set to null and status UNA_PRICE (Unavailable Price).
Buy Limit Frequency Exceeded if the end_user reached a Daily/Monthly/Yearly frequency limit for BUY Trades.
Sell Limit Frequency Exceeded if the end_user reached a Daily/Monthly/Yearly frequency limit for SELL Trades.
Buy Limit Amount Exceeded if the end_user reached a Daily/Monthly/Yearly amount limit for BUY Trades.
Sell Limit Amount Exceeded if the end_user reached a Daily/Monthly/Yearly amount limit for SELL Trades.

POST

api

reusable-quotes

{reusable_quote_id}

actions

execute

curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/reusable-quotes/{reusable_quote_id}/actions/execute/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_amount": 2,
  "end_user_id": "customer_1",
  "op_type": "BUY",
  "external_ref": "ex_op_1"
}'

{
  "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691",
  "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489",
  "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507",
  "end_user_id": "customer_1",
  "rate": "1.00060000",
  "charged_fee": "0.000",
  "base_amount": "5.000000000000000000",
  "quote_amount": "5.002999999999999670",
  "base_asset": "USDT",
  "quote_asset": "USD",
  "created_at": "2021-09-16T15:38:43.115315-03:00"
}

Authorizations

Authorization

string

header

required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Path Parameters

reusable_quote_id

string

required

Body

Response

201

application/json

Successful response

If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.

curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/reusable-quotes/{reusable_quote_id}/actions/execute/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_amount": 2,
  "end_user_id": "customer_1",
  "op_type": "BUY",
  "external_ref": "ex_op_1"
}'

{
  "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691",
  "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489",
  "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507",
  "end_user_id": "customer_1",
  "rate": "1.00060000",
  "charged_fee": "0.000",
  "base_amount": "5.000000000000000000",
  "quote_amount": "5.002999999999999670",
  "base_asset": "USDT",
  "quote_asset": "USD",
  "created_at": "2021-09-16T15:38:43.115315-03:00"
}

Execute Reusable Quote

Reusable Quote Executions buy or sell assets using a Reusable Quote obtained from the Reusable Quote Creation flow.

The asset, and guaranteed price/rate 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 reusable quote with ID reusable_quote_id has expired.
Insufficient Funds if the end user with ID end_user_id has insufficient available balance to fund the execution.
Quote with no price if a Reusable Quote has its prices set to null and status UNA_PRICE (Unavailable Price).
Buy Limit Frequency Exceeded if the end_user reached a Daily/Monthly/Yearly frequency limit for BUY Trades.
Sell Limit Frequency Exceeded if the end_user reached a Daily/Monthly/Yearly frequency limit for SELL Trades.
Buy Limit Amount Exceeded if the end_user reached a Daily/Monthly/Yearly amount limit for BUY Trades.
Sell Limit Amount Exceeded if the end_user reached a Daily/Monthly/Yearly amount limit for SELL Trades.

POST

api

reusable-quotes

{reusable_quote_id}

actions

execute

curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/reusable-quotes/{reusable_quote_id}/actions/execute/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_amount": 2,
  "end_user_id": "customer_1",
  "op_type": "BUY",
  "external_ref": "ex_op_1"
}'

{
  "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691",
  "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489",
  "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507",
  "end_user_id": "customer_1",
  "rate": "1.00060000",
  "charged_fee": "0.000",
  "base_amount": "5.000000000000000000",
  "quote_amount": "5.002999999999999670",
  "base_asset": "USDT",
  "quote_asset": "USD",
  "created_at": "2021-09-16T15:38:43.115315-03:00"
}

Authorizations

Authorization

string

header

required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Path Parameters

reusable_quote_id

string

required

Body

Response

201

application/json

Successful response

If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.

curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/reusable-quotes/{reusable_quote_id}/actions/execute/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_amount": 2,
  "end_user_id": "customer_1",
  "op_type": "BUY",
  "external_ref": "ex_op_1"
}'

{
  "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691",
  "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489",
  "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507",
  "end_user_id": "customer_1",
  "rate": "1.00060000",
  "charged_fee": "0.000",
  "base_amount": "5.000000000000000000",
  "quote_amount": "5.002999999999999670",
  "base_asset": "USDT",
  "quote_asset": "USD",
  "created_at": "2021-09-16T15:38:43.115315-03:00"
}

Execute Reusable Quote

Authorizations

Path Parameters

Body

Response

Overview

OAuth2

Widget

Trading

Transactions

End Users

Onchain Deposits & Withdrawals

Sandbox

Banking as a Service

Webhooks

Yields

Execute Reusable Quote

Authorizations

Path Parameters

Body

Response