Sign in

v1

latestSwagger 2.02026-07-13103251.8 KB
Refunding card payments

Submit a refund for a payment

Return issued refund information. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

post/v1/payments/{paymentId}/refunds

Path parameters

paymentIdstring required

paymentId

Request body

amountinteger required

Amount in pence. Can't be more than the available amount for refunds

refund_amount_availableinteger

Amount in pence. Total amount still available before issuing the refund

Example request

{
  "amount": 150000,
  "refund_amount_available": 200000
}

Response

successful operation

refund_idstring
created_datestring
amountinteger
status'submitted' | 'success' | 'error'

Example response

{
  "refund_id": "act4c33g40j3edfmi8jknab84x",
  "created_date": "2017-01-10T16:52:07.855Z",
  "amount": 120,
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "payment": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "status": "success",
  "settlement_summary": {
    "settled_date": "2016-01-21"
  }
}