Calculate fees

POST

tools

fee-calculator

Calculate fees

const options = {
  method: 'POST',
  headers: {
    'Melio-Entity-Id': '<melio-entity-id>',
    'api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    originatingAccountId: 'acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301',
    receivingAccountId: 'acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
    deliveryPreference: 'same-day-ach',
    amount: 125000
  })
};

fetch('https://api.melio.com/v2/tools/fee-calculator', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/tools/fee-calculator"

payload = {
    "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "deliveryPreference": "same-day-ach",
    "amount": 125000
}
headers = {
    "Melio-Entity-Id": "<melio-entity-id>",
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.melio.com/v2/tools/fee-calculator \
  --header 'Content-Type: application/json' \
  --header 'Melio-Entity-Id: <melio-entity-id>' \
  --header 'api-key: <api-key>' \
  --data '
{
  "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "deliveryPreference": "same-day-ach",
  "amount": 125000
}
'

HttpResponse<String> response = Unirest.post("https://api.melio.com/v2/tools/fee-calculator")
  .header("Melio-Entity-Id", "<melio-entity-id>")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/tools/fee-calculator")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Melio-Entity-Id"] = '<melio-entity-id>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.melio.com/v2/tools/fee-calculator"

	payload := strings.NewReader("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Melio-Entity-Id", "<melio-entity-id>")
	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "type": "expedited-ach",
    "chargeTo": "originator",
    "percent": {
      "rate": 0.5,
      "max": 3000
    },
    "amount": 625
  }
]

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

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

Authorizations

api-key

string

header

required

Headers

Melio-Entity-Id

string

required

Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).

Body

application/json

originatingAccountId

string

required

Internal originating account id (acct_), the debit account

receivingAccountId

string

required

External receiving account id (acct_), the credit account

deliveryPreference

enum<string>

required

The delivery preference to price. Its rail must match the receiving account; the normal-speed values (standard-ach, standard-check, domestic-wire, virtual-card) price that rail at normal speed.

Available options:

standard-ach,

same-day-ach,

rtp,

standard-check,

express-check,

overnight-check,

domestic-wire,

instant-domestic-wire,

virtual-card,

instant-virtual-card

amount

integer

required

The payment amount to price, in minor units (cents).

currency

string

default:USD

Response

Calculated fees.

type

string

required

The fee category (e.g. ach, card, expedited-ach).

chargeTo

enum<string>

required

Which side of the payment the fee is levied on: the account originating the payment or the account receiving it. Works for both estimated (calculator) and applied (payment) fees.

Available options:

originator,

receiver

fixed

object

Present when the fee is a flat amount.

Hide child attributes

fixed.value

integer

Flat fee, minor units (cents)

percent

object

Present when the fee is a percentage of the payment amount.

Hide child attributes

percent.rate

number

Percentage rate (e.g. 2.9 = 2.9%)

percent.min

integer

Minimum fee, minor units (cents)

percent.max

integer

Maximum fee, minor units (cents)

amount

integer

The resolved fee for the requested payment amount, in minor units (cents). Absent only when the fee cannot be resolved without a per-payment quote (e.g. tiered pricing).

⌘I

Calculate fees

const options = {
  method: 'POST',
  headers: {
    'Melio-Entity-Id': '<melio-entity-id>',
    'api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    originatingAccountId: 'acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301',
    receivingAccountId: 'acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
    deliveryPreference: 'same-day-ach',
    amount: 125000
  })
};

fetch('https://api.melio.com/v2/tools/fee-calculator', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/tools/fee-calculator"

payload = {
    "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "deliveryPreference": "same-day-ach",
    "amount": 125000
}
headers = {
    "Melio-Entity-Id": "<melio-entity-id>",
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.melio.com/v2/tools/fee-calculator \
  --header 'Content-Type: application/json' \
  --header 'Melio-Entity-Id: <melio-entity-id>' \
  --header 'api-key: <api-key>' \
  --data '
{
  "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "deliveryPreference": "same-day-ach",
  "amount": 125000
}
'

HttpResponse<String> response = Unirest.post("https://api.melio.com/v2/tools/fee-calculator")
  .header("Melio-Entity-Id", "<melio-entity-id>")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/tools/fee-calculator")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Melio-Entity-Id"] = '<melio-entity-id>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.melio.com/v2/tools/fee-calculator"

	payload := strings.NewReader("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"deliveryPreference\": \"same-day-ach\",\n  \"amount\": 125000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Melio-Entity-Id", "<melio-entity-id>")
	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "type": "expedited-ach",
    "chargeTo": "originator",
    "percent": {
      "rate": 0.5,
      "max": 3000
    },
    "amount": 625
  }
]

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

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

Entities

Accounts

Payments

Tools

Webhooks

Authorizations

Headers

Body

Response