Create an outgoing transfer quote - HEVN

Create an outgoing transfer quote

curl --request POST \
  --url https://api.example.com/payouts/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rail": "<string>",
  "amount": "500.00"
}
'

import requests

url = "https://api.example.com/payouts/preview"

payload = {
    "rail": "<string>",
    "amount": "500.00"
}
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({rail: '<string>', amount: '500.00'})
};

fetch('https://api.example.com/payouts/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "toAmount": "500.00",
  "toCurrency": "<string>",
  "minAmount": "500.00",
  "feeAmount": "500.00",
  "fixedFee": "500.00"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

POST

/

payouts

/

preview

Create an outgoing transfer quote

curl --request POST \
  --url https://api.example.com/payouts/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rail": "<string>",
  "amount": "500.00"
}
'

import requests

url = "https://api.example.com/payouts/preview"

payload = {
    "rail": "<string>",
    "amount": "500.00"
}
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({rail: '<string>', amount: '500.00'})
};

fetch('https://api.example.com/payouts/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "toAmount": "500.00",
  "toCurrency": "<string>",
  "minAmount": "500.00",
  "feeAmount": "500.00",
  "fixedFee": "500.00"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

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

Headers

X-Hevn-Account

string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key

string | null

Body

application/json

rail

string

required

Stable payment-method identifier to preview.

Required string length: 1 - 64

amount

string

required

Source amount to price.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"500.00"

Response

Successful Response

toAmount

string

required

Estimated amount delivered in the destination currency.

Example:

"500.00"

toCurrency

string

required

Currency delivered by the preview.

minAmount

string

required

Minimum supported source amount for this option.

Example:

"500.00"

feeAmount

string | null

Estimated variable fee.

Example:

"500.00"

fixedFee

string | null

Estimated fixed fee component.

Example:

"500.00"