Guides

Create payout offer

The endpoint is designed to create a payout offer. It allows users or applications to specify details for a payout transaction and receive information about the offer that can be accepted.

Suggest Edits

πŸ“˜

After confirming the phone number or after user authorization, you will receive an access_token. You need to enter this access_token in the Token field

❗️

The offer is valid for 20 seconds. After this time, the offer becomes invalid, and to create a new offer, you need to request its creation again

🚧

This endpoint is accessible for KYC_0 level and higher

The body parameters

To obtain the cardId, you can use the endpoint GET /v4/payout/data. This endpoint retrieves the necessary cardId for your operation.

Request Sample: cURL

At the time of sending the request, the curl command should be as follows:

curl --request POST \
     --url https://api.vault.sandbox.testessential.net/v4/payout/offer \
     --header 'X-Sdk-Version: payoutCard=1.2' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwNTFhYTc3Mi0yNDk4LTQ0ZTEtODdmYi0zYzNhZDdlMTY1ODgiLCJleHAiOjE3MTI0MTM3NTksImlhdCI6MTcxMjMyNzM1OX0.8E4JD3vvmsVHTKlqe51IkBjlfxvTcaGVnY8YU8O9CMU' \
     --header 'content-type: application/json' \
     --data '
{
  "amount": 31,
  "fromCurrency": "USDT",
  "toCurrency": "EUR",
  "cardId": 7
}
'

After entering the phone number and password into the respective fields, you need to click the Try It! button.

This action initiates the process of sending data to the server and receiving a response from the API using the provided credentials.

Response Example

Successful execution of the request indicates that the operation was successful.

{
  "offerId": 9485,
  "validSeconds": 20,
  "amount": 31,
  "currencyFrom": "USDT",
  "amountTo": 28.08631,
  "currencyTo": "EUR",
  "rate": 0.90601,
  "feeInfo": [
    {
      "currency": "USDT",
      "name": "Transaction fee",
      "scale": 8,
      "value": 3.78916441,
      "type": "TRANSACTION_FEE"
    },
    {
      "currency": "USDT",
      "name": "Crypterium GAS",
      "scale": 8,
      "value": 0,
      "type": "CRYPTERIUM_GAS"
    },
    {
      "currency": "USDT",
      "name": "Additional fee",
      "scale": 8,
      "value": 0,
      "type": "ADDITIONAL_FEE"
    }
  ],
  "possibleToExecute": true,
  "limit": {
    "value": 8655.77,
    "currency": "EUR"
  }
}

To obtain additional information about the RESPONSE, you need to click on the Headers button.

This will allow you to view the server response headers and gain a more detailed understanding of the data returned in response to your request.

Updated 7 months ago