Refunding card payments

Get all refunds for a payment

Return refunds for a payment. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

get/v1/payments/{paymentId}/refunds

Path parameters

paymentIdstring required

Response

payment_idstring

Example response

{
  "payment_id": "hu20sqlact5260q2nanm0q8u93",
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "payment": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "_embedded": {
    "refunds": [
      {
        "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"
        }
      }
    ]
  }
}

Changes

Changed in 7 of the 50 revisions of this API.418

Oct 8, 20196d52e43c48aa42See the full diff
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ○
  the endpoint scheme security Authorization was added to the API
  api-security-added
- ○
  the endpoint scheme security BearerAuth was removed from the API
  api-security-removed
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 6, 2019884c555517bc6See the full diff
- ○
  the endpoint scheme security BearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security Authorization was removed from the API
  api-security-removed
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 201967d0d74214472See the full diff
- ○
  api tag Refunding card payments added
  api-tag-added
- ○
  api tag Refunding payments removed
  api-tag-removed
Aug 1, 20196e01c8022b872See the full diff
- ○
  api tag Refunding payments added
  api-tag-added
- ○
  api tag Refunds removed
  api-tag-removed
Jul 31, 2019f8066d82895d1See the full diff
- ○
  api operation id getRefunds removed and replaced with Get all refunds for a payment
  api-operation-id-removed
Jul 31, 2019ef50a2b1c4f12See the full diff
- ○
  api tag Refunds added
  api-tag-added
- ○
  api tag refunds removed
  api-tag-removed
Feb 22, 201989daf4ffa64f3See the full diff
- ○
  api operation id Get all refunds for a payment removed and replaced with getRefunds
  api-operation-id-removed
- ○
  api tag refunds added
  api-tag-added
- ○
  api tag Refunding card payments removed
  api-tag-removed

Full history