Adyen · JSON Structure

Checkout Payment Cancel Response Structure

PaymentCancelResponse schema from Adyen API

Type: object Properties: 5 Required: 4
PaymentsFinancial ServicesFintech

PaymentCancelResponse is a JSON Structure definition published by Adyen, describing 5 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

merchantAccount paymentPspReference pspReference reference status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-payment-cancel-response-structure.json",
  "description": "PaymentCancelResponse schema from Adyen API",
  "type": "object",
  "properties": {
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "paymentPspReference": {
      "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to cancel. ",
      "type": "string"
    },
    "pspReference": {
      "description": "Adyen's 16-character reference associated with the cancel request.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the cancel request.",
      "type": "string"
    },
    "status": {
      "description": "The status of your request. This will always have the value **received**.",
      "enum": [
        "received"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "merchantAccount",
    "paymentPspReference",
    "pspReference"
  ],
  "name": "PaymentCancelResponse"
}