Adyen · Schema

CheckoutVoucherAction

CheckoutVoucherAction schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
alternativeReference string The voucher alternative reference code.
collectionInstitutionNumber string A collection institution number (store number) for Econtext Pay-Easy ATM.
downloadUrl string The URL to download the voucher.
entity string An entity number of Multibanco.
expiresAt string The date time of the voucher expiry.
initialAmount object The initial amount.
instructionsUrl string The URL to the detailed instructions to make payment using the voucher.
issuer string The issuer of the voucher.
maskedTelephoneNumber string The shopper telephone number (partially masked).
merchantName string The merchant name.
merchantReference string The merchant reference.
passCreationToken string A base64 encoded signature of all properties
paymentData string Encoded payment data.
paymentMethodType string Specifies the payment method.
reference string The voucher reference code.
shopperEmail string The shopper email.
shopperName string The shopper name.
surcharge object The surcharge amount.
totalAmount object The total amount (initial plus surcharge amount).
type string **voucher**
url string Specifies the URL to redirect to.
View JSON Schema on GitHub

JSON Schema

checkout-checkout-voucher-action-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/checkout-checkout-voucher-action-schema.json",
  "title": "CheckoutVoucherAction",
  "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
}