Bill Pay

Get Expected Payment Date

Returns the date a payment sent on a given rail is expected to reach the vendor, based on the banking calendar and the funding account's daily cutoffs.

get/billpay/expected-payment-date

Request

Query parameters

payment_type'ACH' | 'WIRE' | 'INTERNATIONAL_PAYMENT_FX' | 'CHECK' | 'CRYPTO' required

The rails this API names, spelled the way the bills API spells them.

A caller reads payment_details.payment_type off a bill and feeds it back here, so the FX rail has to answer to BillPaymentTypeEnum's name for it — the internal PaymentDeliveryRail calls the same rail INTERNATIONAL_PAYMENT.

The rail the payment would be sent on, named as a bill's payment_details.payment_type names it.

initiated_atstring date-time required

When the payment would be sent.

instant_eligibleboolean

Whether the payment may auto-route an instant rail when it executes, which only a crypto send does and only when sent immediately. A scheduled send funds over a wire, so leave this false to get the wire-funded date.

account_idstring nullable

The funding account, in the same id format returned by GET /accounts. Defaults to the entity's default bill pay account, or to your key's account when the key is restricted to one account.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

expected_delivery_datestring date required

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

Changes

No recorded changes to this operation across all 1 revision of this API.