Verifone · Schema

RefundCardTransactionDto

RefundCardTransactionDto from Verifone eCommerce API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
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
reason string The reason of the refund.
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`
detailed_amount object
promo_code string A code defined by the merchant that affects the calculation of the total 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
receipt_type string Defines the type of receipt to be generated
View JSON Schema on GitHub

JSON Schema

ecommerce-api-refundcardtransactiondto.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-refundcardtransactiondto.json",
  "title": "RefundCardTransactionDto",
  "description": "RefundCardTransactionDto from Verifone eCommerce API",
  "type": "object",
  "properties": {
    "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."
    },
    "reason": {
      "type": "string",
      "title": "Reason",
      "description": "The reason of the refund."
    },
    "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"
    },
    "detailed_amount": {
      "$ref": "#/components/schemas/DetailedAmount"
    },
    "promo_code": {
      "type": "string",
      "description": "A code defined by the merchant that affects the calculation of the total amount."
    },
    "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
    },
    "receipt_type": {
      "type": "string",
      "description": "Defines the type of receipt to be generated",
      "enum": [
        "FULL_RECEIPT",
        "INVOICE",
        "INVOICE_RECEIPT",
        "SIMPLE_RECEIPT",
        "NONE"
      ]
    }
  },
  "required": [
    "amount"
  ]
}