Creates a new refund object.

This fails with:<a name="total_amount_confirmation_invalid"></a><a name="number_of_refunds_exceeded"></a><a name="available_refund_amount_insufficient"></a>

• total_amount_confirmation_invalid if the confirmation amount doesn't match the total amount refunded for the payment. This safeguard is there to prevent two processes from creating refunds without awareness of each other.

• available_refund_amount_insufficient if the creditor does not have sufficient balance for refunds available to cover the cost of the requested refund.

<p class="restricted-notice"><strong>Restricted</strong>: This endpoint is disabled by default. To enable it, you will need to enable refunds on your GoCardless Dashboard.</p> <p class="notice--warning"><strong>Warning</strong>: A payment that has been (partially) refunded can still receive a late failure or chargeback from the customer's bank.<br /><br /> A refund can only be created once it is outside the safer refund period (7 calendar days after the charge date) otherwise an error is returned. The safer refund period can be disabled by contacting GoCardless.</p>

{
  "refunds": {
    "reference": "WINEBOX001",
    "links": {
      "payment": "PM123",
      "mandate": "MD123"
    }
  }
}

{
  "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"
    }
  }
}