Setting the payment_type parameter to wire
, instant
, or ach
indicates how the failed payment will be retried. Note that only debit payments can be retried using wires. The wire details for this retry attempt are provided in the wire_details object in the first (most recent) payment attempt after the /retry endpoint is called.
Setting the bank_account parameter indicates the failed payment will be retried using a new bank account. Both credits and debits may be retried using a new bank account.
Deprecation Notice: The use_wire
parameter has been deprecated in favor of the payment_type
field.
If use_wire
is provided:
- When
true
, it is treated as ifpayment_type
="wire" was set. - If
payment_type
is also provided,payment_type
takes precedence, anduse_wire
is ignored.
Please update your integrations accordingly.
Note that the can_retry field on the Payment object communicates whether a payment can be retried. We recommend relying on this field to determine whether a retry is possible.