Skip to main content
POST
Check fast payment eligibility

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. Empty when the rail has no fast variants.