Get a Borrower's Charge Order
See which rails a borrower is collected on, in what order, and where that order comes from
Get a Borrower’s Charge Order
Returns the charge order and fallback rules in effect for one borrower, and the instruments Rightfoot can debit.charge_order_source tells you where the order comes from:
borrower_settings shows what the borrower has set. A null field there follows your policy.
An instrument is stopped after a failure that rules it out, such as an expired card or a closed account. A stopped rail is skipped until you send a different card or bank account.Authorizations
Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Path Parameters
Response
The charge settings in effect.
The charge settings in effect for one borrower.
The failures that move a payment to the next rail, in effect.
insufficient_funds — not enough money on the rail tried.
instrument_invalid — the instrument cannot take a payment: a closed or
frozen account, an expired card.
authorization_revoked — the borrower or their bank refused the payment,
such as an unauthorized ACH return or a card dispute.
declined_by_processor — the payment processor refused it for its own
reasons.
A processor outage (processor_error) never moves a payment to another
rail: the same rail is tried again later. It cannot be listed.
insufficient_funds, instrument_invalid, authorization_revoked, declined_by_processor 