GOgocardless
Payment

Retry a payment

<a name="retry_failed"></a>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.

post/payments/{payment_id}/actions/retry

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

payment_idstring required

The payment id

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "payments": {
    "charge_date": "2014-05-21"
  }
}

Response

Action completed successfully

Example response

{
  "payments": {
    "id": "PM123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "amount": 1000,
    "amount_refunded": 150,
    "currency": "EUR",
    "description": "One-off upgrade fee",
    "charge_date": "2014-05-21",
    "reference": "WINEBOX001",
    "status": "submitted",
    "app_fee": 100,
    "links": {
      "mandate": "MD123",
      "creditor": "CR123",
      "payout": "PO123",
      "subscription": "SU123",
      "instalment_schedule": "IS123"
    },
    "fx": {
      "exchange_rate": "1.1234567890",
      "estimated_exchange_rate": "1.1234567890",
      "fx_currency": "EUR"
    },
    "scheme": "bacs"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.