Retry Payment

POST {{url}}/payments/{{payment}}/actions/retry

Retries a failed payment if the underlying mandate is active. You will receive a resubmission_requested webhook, but after that retrying the payment follows the same process as its initial creation, so you will receive a submitted webhook, followed by a confirmed or failed event. Any metadata supplied to this endpoint will be stored against the payment submission event it causes.

This will return a retry_failed error if the payment has not failed.

Payments can be retried up to 3 times.

Retry a failed payment API Docs

 

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key

Datatype

Required

Description

RESPONSES

status OK

{ "payments": { "id": "PM0096DXBGVHA1", "created_at": "2024-01-12T16:13:19.143Z", "charge_date": "2024-03-25", "amount": 7884, "description": null, "currency": "USD", "status": "pending_submission", "amount_refunded": 0, "reference": "INV-1069", "metadata": { "order_dispatch_date": "2024-01-12T16:13:18.804Z" }, "fx": { "fx_currency": null, "fx_amount": null, "exchange_rate": null, "estimated_exchange_rate": null }, "links": { "mandate": "MD000YRY5E62FM", "creditor": "CR00006C6DF0TD" }, "retry_if_possible": true, "faster_ach": true } }