GOgocardless
Refund

Update a refund

Updates a refund object.

put/refunds/{refund_id}

Request

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

Path parameters

refund_idstring required

The refund id

Headers

GoCardless-Versionstring required

Request body

Response

Successful response

Example response

{
  "refunds": {
    "id": "RF123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "amount": 150,
    "currency": "EUR",
    "status": "submitted",
    "reference": "WINEBOX001",
    "links": {
      "payment": "PM123",
      "mandate": "MD123"
    },
    "fx": {
      "exchange_rate": "1.1234567890",
      "estimated_exchange_rate": "1.1234567890",
      "fx_currency": "EUR"
    }
  }
}

Changes

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