Recover collects on a past-due invoice using the payment methods you supply on the recovery request. You pass reusable gateway tokens, and — when the Wallet feature is enabled — designate which method Recover tries first. This page covers supplying a payment method and using the payment method wallet.

Available as a standalone product — Recurly Subscriptions is not required

1Supply a payment method 2Payment method wallet

Supply a payment method

Provide each payment method as a reusable gateway token in the payment_gateway_references array on a billing_infos entry. Each reference carries the token and its reference_type (for example, stripe_payment_method). Recover stores the method and uses it to collect on the retry schedule.

For the gateways that issue these tokens, see Payment gateways.

Payment method wallet

Note The Wallet feature is enabled by default on every Recover account. No setup is required to designate primary and backup methods.

The Wallet feature lets you designate payment methods as primary or backup in the same request. Set primary_payment_method or backup_payment_method to true on each entry in billing_infos. You can submit multiple payment methods, but only one can be marked as primary.