Adyen · JSON Structure

Checkout Checkout Voucher Action Structure

CheckoutVoucherAction schema from Adyen API

Type: object Properties: 21 Required: 1

PaymentsFinancial ServicesFintech

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

Properties

alternativeReference collectionInstitutionNumber downloadUrl entity expiresAt initialAmount instructionsUrl issuer maskedTelephoneNumber merchantName merchantReference passCreationToken paymentData paymentMethodType reference shopperEmail shopperName surcharge totalAmount type url

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-checkout-voucher-action-structure.json",
  "description": "CheckoutVoucherAction schema from Adyen API",
  "type": "object",
  "properties": {
    "alternativeReference": {
      "description": "The voucher alternative reference code.",
      "type": "string"
    },
    "collectionInstitutionNumber": {
      "description": "A collection institution number (store number) for Econtext Pay-Easy ATM.",
      "type": "string"
    },
    "downloadUrl": {
      "description": "The URL to download the voucher.",
      "type": "string"
    },
    "entity": {
      "description": "An entity number of Multibanco.",
      "type": "string"
    },
    "expiresAt": {
      "description": "The date time of the voucher expiry.",
      "type": "string"
    },
    "initialAmount": {
      "description": "The initial amount.",
      "$ref": "#/components/schemas/Amount"
    },
    "instructionsUrl": {
      "description": "The URL to the detailed instructions to make payment using the voucher.",
      "type": "string"
    },
    "issuer": {
      "description": "The issuer of the voucher.",
      "type": "string"
    },
    "maskedTelephoneNumber": {
      "description": "The shopper telephone number (partially masked).",
      "type": "string"
    },
    "merchantName": {
      "description": "The merchant name.",
      "type": "string"
    },
    "merchantReference": {
      "description": "The merchant reference.",
      "type": "string"
    },
    "passCreationToken": {
      "x-addedInVersion": "68",
      "description": "A base64 encoded signature of all properties",
      "type": "string"
    },
    "paymentData": {
      "description": "Encoded payment data.",
      "type": "string"
    },
    "paymentMethodType": {
      "description": "Specifies the payment method.",
      "type": "string"
    },
    "reference": {
      "description": "The voucher reference code.",
      "type": "string"
    },
    "shopperEmail": {
      "description": "The shopper email.",
      "type": "string"
    },
    "shopperName": {
      "description": "The shopper name.",
      "type": "string"
    },
    "surcharge": {
      "description": "The surcharge amount.",
      "$ref": "#/components/schemas/Amount"
    },
    "totalAmount": {
      "description": "The total amount (initial plus surcharge amount).",
      "$ref": "#/components/schemas/Amount"
    },
    "type": {
      "description": "**voucher**",
      "enum": [
        "voucher"
      ],
      "type": "string"
    },
    "url": {
      "description": "Specifies the URL to redirect to.",
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "name": "CheckoutVoucherAction"
}