GOgovernment-digital-service
Refunds

Refund a charge

Changed on
post/v1/api/accounts/{accountId}/charges/{chargeId}/refunds

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

accountIdinteger required

Gateway account ID

chargeIdstring required

Charge external ID

Request body

amountinteger required

Amount to refund in pence

refund_amount_availableinteger required

Total amount still available before issuing the refund

user_emailstring

Email address of the user refunding payment

user_external_idstring

The ID of the user who issued the refund

Example request

{
  "amount": 3444,
  "refund_amount_available": 30000,
  "user_email": "joeb@example.org",
  "user_external_id": "3444"
}

Response

OK

string required

Changes