RAratepay
Cancellation

Retrieve all cancellations

Retrieve all cancellation resources of an existing transaction including their attributes.

get/v2/transactions/{ratepay_transaction_id}/cancellations

Request

  • Base URL
    https://api-integration.ratepay.com/transaction/management
  • URL
    https://api-integration.ratepay.com/transaction/management/v2/transactions/{ratepay_transaction_id}/cancellations
  • Auth
    HTTP bearer

Path parameters

ratepay_transaction_idstring required

ID of transaction to retrieve. Get an overview of key identifiers used in payment API.

Headers

Prefer'return=representation'

According to RFC 7240: Provide return=representation if you prefer that the response to a request includes the current state of the resource.

X-Partnerstring

The partner ID for the operation is required only when using a single credential set for multiple integrations, such as countries or brands associated with one company.

Response

Cancellations retrieved

OR

Example response

{
  "_embedded": {
    "cancellations": [
      {
        "_links": {
          "self": {
            "href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/cancellations/aa7rth5-__GG44rdsasf"
          }
        },
        "ratepay_cancellation_id": "aa7rth5-__GG44rdsasf"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp"
    }
  },
  "ratepay_transaction_id": "scwBgARW-nE93I7_ywhp"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.