Skip to main content
GET
Get a borrower's charge order

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

Authorization
string
header
required

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

authorizer_unique_id
string
required

The borrower, as the identifier you enrolled them with.

Response

The charge settings in effect.

The charge settings in effect for one borrower.

authorizer_unique_id
string
charge_order
enum<string>[]

The order in effect.

ach — the bank account in account_number / routing_number.

card — the debit card in charge_instrument.

Available options:
ach,
card
charge_order_source
enum<string>

borrower — the borrower's own order. lender — your collection policy's. default — neither is set: ACH alone.

Available options:
borrower,
lender,
default
fallback_on
enum<string>[]

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.

Available options:
insufficient_funds,
instrument_invalid,
authorization_revoked,
declined_by_processor
borrower_settings
object

What the borrower has set. A null field follows your policy.

instruments
object[]

The bank account Rightfoot would debit, and the borrower's debit card if you sent one.