Refunding card payments

Search refunds

Search refunds by 'from' and 'to' date. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

get/v1/refunds

Query parameters

from_datestring

From date of refunds to be searched (this date is inclusive). Example=2015-08-13T12:35:00Z

to_datestring

To date of refunds to be searched (this date is exclusive). Example=2015-08-14T12:35:00Z

from_settled_datestring

From settled date of refund to be searched (this date is inclusive). Example=2015-08-13

to_settled_datestring

To settled date of refund to be searched (this date is inclusive). Example=2015-08-13

pagestring

Page number requested for the search, should be a positive integer (optional, defaults to 1)

display_sizestring

Number of results to be shown per page, should be a positive integer (optional, defaults to 500, max 500)

Response

totalinteger

countinteger

pageinteger

Example response

{
  "total": 100,
  "count": 20,
  "page": 1,
  "results": [
    {
      "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"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "first_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "last_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "prev_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "next_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  }
}

Changes

Changed in 8 of the 50 revisions of this API.3219

Oct 8, 2020e9ebe27000af2See the full diff
- ○
  added the new optional query request parameter from_settled_date
  new-optional-request-parameter
- ○
  added the new optional query request parameter to_settled_date
  new-optional-request-parameter
Oct 8, 20196d52e43c48aa32See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 422
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 500
  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, 2019884c555517bc5See 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 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 422
  response-media-type-added
- ○
  added the media type application/json for the response with the status 500
  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 searchRefunds removed and replaced with Search refunds
  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, 201989daf4ffa64f23See the full diff
- ●
  deleted the query request parameter from_settled_date
  request-parameter-removed
- ●
  deleted the query request parameter to_settled_date
  request-parameter-removed
- ○
  api operation id Search refunds removed and replaced with searchRefunds
  api-operation-id-removed
- ○
  api tag refunds added
  api-tag-added
- ○
  api tag Refunding card payments removed
  api-tag-removed

Full history