Skip to main content
POST
Estimate delivery dates

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 estimate for, in minor units (cents).

deductionDate
string<date>

The debit/schedule date the estimate is based on. Defaults to the current date when omitted.

currency
string
default:USD

Response

Estimated delivery dates, one per 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
deductionDate
string<date>
required

The debit/schedule date the estimates are based on.

estimates
object[]
required

One entry per delivery preference valid for the receiving external account. Empty when the rail has no valid preferences.