Skip to main content
PATCH

Change a Borrower’s Charge Order

Set the order one borrower is collected in, overriding your collection policy for them. This is how you change a borrower’s order after they are enrolled. Re-sending the borrower to Enroll and Update Borrowers leaves their order as it is. The change applies from the borrower’s next payment. A payment already submitted finishes on its own rail.

When card is refused

A charge_order naming card is rejected with 400, and error.details.reason says why: Changing only fallback_on never re-checks a card order saved earlier.

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.

Body

application/json

A change to one borrower's charge settings. A field left out is unchanged; null follows your collection policy again.

charge_order
enum<string>[] | null

The rails to collect on, in order: ["card", "ach"] charges the debit card first and falls back to ACH, ["ach", "card"] the other way round. ach is required; a card-only order is not offered. Unset is ACH alone.

Required array length: 1 - 2 elements

ach — the bank account in account_number / routing_number.

card — the debit card in charge_instrument.

Available options:
ach,
card
fallback_on
enum<string>[] | null

Which failures move a payment to the next rail in the charge order. A rail with another after it gets one payment per collection attempt. If that payment fails for a reason in this list, the next rail is tried; otherwise the attempt ends. Unset is every category listed here. Has no effect on an ACH-only order.

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

Response

The charge settings now 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.