Get payout quote

Get quote for payout to contact. Auto-detects payment channel (IBAN/onchain/internal).

POST /api/v1/balance/payout/quote

Get payout quote

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/balance/payout/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123
}
'

import requests

url = "https://api.hevn.finance/api/v1/balance/payout/quote"

payload = {
    "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', amount: 123})
};

fetch('https://api.hevn.finance/api/v1/balance/payout/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "quoteId": "<string>",
  "paymentChannel": "<string>",
  "fromAmount": 123,
  "fromCurrency": "<string>",
  "toAmount": 123,
  "toCurrency": "<string>",
  "provider": "<string>",
  "depositMemo": "<string>",
  "feeAmount": 123,
  "feeCurrency": "<string>",
  "rate": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "maskedIban": "<string>",
  "depositAddress": "<string>",
  "recipientAddress": "<string>",
  "originChainId": "<string>",
  "destinationChainId": "<string>",
  "transactionRequest": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

Request for payout quote to contact.

contactId · string<uuid> · required

amount · number · required

swapType · enum<string> · default: FLEX_INPUT

Type of swap quote.

Available options: EXACT_INPUT, EXACT_OUTPUT, FLEX_INPUT, ANY_INPUT

Response

200

application/json

Successful Response

Universal quote response.

quoteId · string · required

paymentChannel · string · required

fromAmount · number · required

fromCurrency · string · required

toAmount · number · required

toCurrency · string · required

provider · string | null

depositMemo · string | null

feeAmount · number | null

feeCurrency · string | null

rate · number | null

expiresAt · string<date-time> | null

maskedIban · string | null

depositAddress · string | null

recipientAddress · string | null

originChainId · string | null

destinationChainId · string | null

transactionRequest · Transactionrequest · object | null