POST
/
api
/
v1
/
withdrawal-fees
curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/withdrawal-fees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "ETH",
  "network": "ethereum",
  "amount": 0.002,
  "external_ref": "withdrawal-fee-1234"
}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expires_at": "2022-08-24T14:15:22Z",
  "amount": 0.002,
  "gas_price": 0.00001,
  "fee": 0.00001,
  "total_fee": 0.00002,
  "total_amount": 0.00202
}

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

Body

​
currency
string

Currency to estimate the fee for. It needs to be the same currency as the once use later for the withdrawal. The fee in the reponse will be expressed in this currency.

​
network
string

The blockchain network in which the withdrawal fee needs to be estimated. The later withdrawal must be performed in the same network.

​
amount
number

Amount to be withdrawaled. It''s the amount that wants to be transfered, the fee depends on this amount.

​
external_ref
string

An external identifier, usually a unique UUID

Response

201 - application/json
Created
​
id
string

UUID used as withdrawal identifier.

​
expires_at
string

ISO DateTime indicating expiration date of the withdrawal fee. Fee will be invalid after that date.

​
amount
number

It is the requested amount to withdrawal.

​
gas_price
number

Indicates de basic cost on a withdrawal fee, the network gas price. It is expressed in the requested currency.

​
fee
number

Indicates the basic fee that it is charged on the amount to be withdrawaled. It is expressed in the requested currency.

​
total_fee
number

Indicates the total fee that will be charged in order to perform a withdrawal. Tipically, equivalent to gas_price + fee. It is expressed in the requested currency.

​
total_amount
number

Indicates the total amount needed to perform a withdrawal for the requested amount. It is the amount that will be decreased on the user balance. Tipically, amount + total_fee. It is expressed in the requested currency.

Was this page helpful?