Tools

Check fast payment eligibility

Checks which faster-than-standard delivery options a payment between two of the entity’s accounts is eligible for, without creating one. Eligibility depends on the originating account, the receiving account, and the amount (minor units, cents). The response has one entry per fast option valid for the receiving account and the originating account’s funding type, for example same-day-ach and rtp for ACH, or express-check and overnight-check for check. With a card originating account the collect is immediate, so same-day-ach and instant-domestic-wire are always eligible.

POST

tools

fast-payment-eligibility

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',
    amount: 125000
  })
};

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

import requests

url = "https://api.melio.com/v2/tools/fast-payment-eligibility"

payload = {
    "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "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/fast-payment-eligibility \
  --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",
  "amount": 125000
}
'

HttpResponse<String> response = Unirest.post("https://api.melio.com/v2/tools/fast-payment-eligibility")
  .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  \"amount\": 125000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/tools/fast-payment-eligibility")

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  \"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/fast-payment-eligibility"

	payload := strings.NewReader("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\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))

}

{
  "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "amount": 125000,
  "currency": "USD",
  "eligibilities": [
    {
      "deliveryPreference": "same-day-ach",
      "eligible": true
    },
    {
      "deliveryPreference": "rtp",
      "eligible": false
    }
  ]
}

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

amount

integer

required

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

currency

string

default:USD

Response

Fast-payment eligibility decisions, one per fast delivery preference for the receiving rail.

originatingAccountId

string

required

receivingAccountId

string

required

amount

integer

required

Echoes the requested payment amount, minor units (cents).

currency

string

required

eligibilities

object[]

required

One entry per fast delivery preference valid for the receiving external account and the originating account's funding type. Card-funded same-day-ach / instant-domestic-wire are always eligible — the collect is immediate, so no eligibility check applies. Empty when no fast variants are available for the combination (e.g. a card originating account with a virtual-card receiving account).

Hide child attributes

eligibilities.deliveryPreference

enum<string>

required

A faster-than-standard delivery preference valid for the receiving external account and the originating account's funding type.

Available options:

same-day-ach,

rtp,

express-check,

overnight-check,

instant-domestic-wire,

instant-virtual-card,

fast-international-fx

eligibilities.eligible

boolean

required

True when this fast delivery preference can be used for the prospective payment. When false (including when eligibility cannot be determined), only the receiving rail's standard-speed preference should be used.

Check fast payment eligibility

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',
    amount: 125000
  })
};

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

import requests

url = "https://api.melio.com/v2/tools/fast-payment-eligibility"

payload = {
    "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "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/fast-payment-eligibility \
  --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",
  "amount": 125000
}
'

HttpResponse<String> response = Unirest.post("https://api.melio.com/v2/tools/fast-payment-eligibility")
  .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  \"amount\": 125000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/tools/fast-payment-eligibility")

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  \"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/fast-payment-eligibility"

	payload := strings.NewReader("{\n  \"originatingAccountId\": \"acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\n  \"receivingAccountId\": \"acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\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))

}

{
  "originatingAccountId": "acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "receivingAccountId": "acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "amount": 125000,
  "currency": "USD",
  "eligibilities": [
    {
      "deliveryPreference": "same-day-ach",
      "eligible": true
    },
    {
      "deliveryPreference": "rtp",
      "eligible": false
    }
  ]
}

Entities

Accounts

Attachments

Payments

Tools

Check fast payment eligibility

Authorizations

Headers

Body

Response