Verifone · Schema

unmatchedRefundBaseRequest

unmatchedRefundBaseRequest from Verifone eCommerce API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name	Type	Description
payment_provider_contract	string	The identifier of payment provider contract you want to process the transaction request with.
card_brand	object
brand_choice	string	For dual-branded cards identifies whether selection is made by a cardholder or merchant.
amount	integer	Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide
detailed_amount	object
currency_code	object
customer	string	The ID of a customer.
shopper_interaction	string	Determines the sales channel the shopper gives their card details through: * `ECOMMERCE` Online transactions where the cardholder is present. * `MAIL` order transactions where the shopper is in contac
reason	string	The reason for the refund
merchant_reference	string	A reference specified by the merchant to identify the transaction.
line_items	array	The array of items being refunded.
receipt_type	string	Defines the type of receipt to be generated
tax_indicator	string	This field indicates the taxable status of the transaction (if any of the purchased items are taxable). This field is part of so-called Level 2 data. If the value `TAX_PROVIDED` is sent, `tax_amount`
purchase_order_number	string	The purchase order number. It can be provided in transactions with purchase or procurement cards for the cardholder to get better interchange rates (note that this functionality needs alignment with t
promo_code	string	A code defined by the merchant that affects the calculation of the total amount.
promo_financing_details	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-unmatchedrefundbaserequest.json",
  "title": "unmatchedRefundBaseRequest",
  "description": "unmatchedRefundBaseRequest from Verifone eCommerce API",
  "properties": {
    "payment_provider_contract": {
      "type": "string",
      "description": "The identifier of payment provider contract you want to process the transaction request with.",
      "format": "uuid-flexible"
    },
    "card_brand": {
      "$ref": "#/components/schemas/CardBrand"
    },
    "brand_choice": {
      "type": "string",
      "description": "For dual-branded cards identifies whether selection is made by a cardholder or merchant.",
      "enum": [
        "MERCHANT",
        "CARDHOLDER"
      ],
      "default": "MERCHANT"
    },
    "amount": {
      "type": "integer",
      "description": "Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field."
    },
    "detailed_amount": {
      "$ref": "#/components/schemas/DetailedAmount"
    },
    "currency_code": {
      "$ref": "#/components/schemas/CurrencyCodeEnum"
    },
    "customer": {
      "title": "Customer ID",
      "description": "The ID of a customer.",
      "type": "string",
      "format": "uuid-flexible"
    },
    "shopper_interaction": {
      "title": "Ecommerce Shopper Interaction",
      "description": "Determines the sales channel the shopper gives their card details through:\n  * `ECOMMERCE` Online transactions where the cardholder is present.\n  * `MAIL` order transactions where the shopper is in contact with the merchant via email.\n  * `TELEPHONE` order transactions where the shopper is in contact with the merchant via telephone.\n",
      "type": "string",
      "enum": [
        "ECOMMERCE",
        "MAIL",
        "TELEPHONE"
      ],
      "default": "ECOMMERCE"
    },
    "reason": {
      "type": "string",
      "description": "The reason for the refund"
    },
    "merchant_reference": {
      "description": "A reference specified by the merchant to identify the transaction.",
      "type": "string",
      "maxLength": 50
    },
    "line_items": {
      "type": "array",
      "description": "The array of items being refunded.",
      "items": {
        "$ref": "#/components/schemas/UnmatchedLineItem"
      }
    },
    "receipt_type": {
      "type": "string",
      "description": "Defines the type of receipt to be generated",
      "enum": [
        "FULL_RECEIPT",
        "INVOICE",
        "INVOICE_RECEIPT",
        "SIMPLE_RECEIPT"
      ]
    },
    "tax_indicator": {
      "title": "Tax Indicator",
      "description": "This field indicates the taxable status of the transaction (if any of the purchased items are taxable). This field is part of so-called Level 2 data. If the value `TAX_PROVIDED` is sent, `tax_amount` should also be provided\n",
      "type": "string",
      "enum": [
        "TAX_PROVIDED",
        "TAX_NOT_PROVIDED",
        "NON_TAXABLE"
      ],
      "default": "TAX_NOT_PROVIDED"
    },
    "purchase_order_number": {
      "title": "Purchase Order Number",
      "description": "The purchase order number. It can be provided in transactions with purchase or procurement cards for the cardholder to get better interchange rates (note that this functionality needs alignment with the acquirer and the scheme). This field is part of so-called Level 2 data.\n",
      "type": "string",
      "maxLength": 17
    },
    "promo_code": {
      "type": "string",
      "description": "A code defined by the merchant that affects the calculation of the total amount."
    },
    "promo_financing_details": {
      "$ref": "#/components/schemas/PromoFinancingDetails"
    }
  },
  "required": [
    "payment_provider_contract",
    "amount",
    "currency_code"
  ]
}