External payment data

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentExternalData",
  "title": "External payment data",
  "required": [
    "Type"
  ],
  "type": "object",
  "properties": {
    "Type": {
      "title": "External payment type",
      "allOf": [
        {
          "$ref": "#/components/schemas/ExternalPaymentTypeEnum"
        }
      ],
      "description": "Type of the external payment. *Except for enterprises based in the French Legal Environment. `Unspecified` is considered as fraud.\n\nUnspecified (Unspecified (unavailable in French Legal Environment))\n\nBadDebts (Bad debts)\n\nBacs (Bacs payment)\n\nWireTransfer (Wire transfer)\n\nInvoice (Invoice)\n\nExchangeRateDifference (Exchange rate difference)\n\nComplimentary (Complimentary)\n\nReseller (Reseller)\n\nExchangeRoundingDifference (Exchange rounding difference)\n\nBarter (Barter)\n\nCommission (Commission)\n\nBankCharges (Bank charges)\n\nCrossSettlement (Cross settlement)\n\nCash (Cash)\n\nCreditCard (Credit card \u2013 deprecated, only for existing partners)\n\nPrepayment (Prepayment)\n\nCheque (Cheque)\n\nBancontact (Bancontact)\n\nIDeal (iDeal \u2013 deprecated, only for existing partners)\n\nPayPal (PayPal \u2013 deprecated, only for existing partners)\n\nGiftCard (Gift card)\n\nLoyaltyPoints (Loyalty points)\n\nChequeVacances (Ch\u00e8que-Vacances)\n\nOnlinePayment (Online payment \u2013 deprecated, only for existing partners)\n\nCardCheck (Card check)\n\nPaymentHubRedirection (Payment hub redirection)\n\nVoucher (Voucher)\n\nMasterCard (MasterCard \u2013 deprecated, only for existing partners)\n\nVisa (Visa \u2013 deprecated, only for existing partners)\n\nAmex (American Express \u2013 deprecated, only for existing partners)\n\nDiscover (Discover \u2013 deprecated, only for existing partners)\n\nDinersClub (Diners Club \u2013 deprecated, only for existing partners)\n\nJcb (JCB \u2013 deprecated, only for existing partners)\n\nUnionPay (UnionPay \u2013 deprecated, only for existing partners)\n\nTwint (TWINT)\n\nReka (Reka)\n\nLoyaltyCard (Loyalty card)\n\nPosDiningAndSpaReward (POS Dining & Spa Reward)\n\nDirectDebit (Direct debit)\n\nDepositCheck (Deposit - check)\n\nDepositCash (Deposit - cash)\n\nDepositCreditCard (Deposit - credit card \u2013 deprecated, only for existing partners)\n\nDepositWireTransfer (Deposit - wire transfer)",
      "x-enumNames": [
        "Unspecified",
        "BadDebts",
        "Bacs",
        "WireTransfer",
        "Invoice",
        "ExchangeRateDifference",
        "Complimentary",
        "Reseller",
        "ExchangeRoundingDifference",
        "Barter",
        "Commission",
        "BankCharges",
        "CrossSettlement",
        "Cash",
        "CreditCard",
        "Prepayment",
        "Cheque",
        "Bancontact",
        "IDeal",
        "PayPal",
        "GiftCard",
        "LoyaltyPoints",
        "ChequeVacances",
        "OnlinePayment",
        "CardCheck",
        "PaymentHubRedirection",
        "Voucher",
        "MasterCard",
        "Visa",
        "Amex",
        "Discover",
        "DinersClub",
        "Jcb",
        "UnionPay",
        "Twint",
        "Reka",
        "LoyaltyCard",
        "PosDiningAndSpaReward",
        "DirectDebit",
        "DepositCheck",
        "DepositCash",
        "DepositCreditCard",
        "DepositWireTransfer"
      ],
      "x-enumDescriptions": [
        "Unspecified (unavailable in French Legal Environment)",
        "Bad debts",
        "Bacs payment",
        "Wire transfer",
        "Invoice",
        "Exchange rate difference",
        "Complimentary",
        "Reseller",
        "Exchange rounding difference",
        "Barter",
        "Commission",
        "Bank charges",
        "Cross settlement",
        "Cash",
        "Credit card \u2013 deprecated, only for existing partners",
        "Prepayment",
        "Cheque",
        "Bancontact",
        "iDeal \u2013 deprecated, only for existing partners",
        "PayPal \u2013 deprecated, only for existing partners",
        "Gift card",
        "Loyalty points",
        "Ch\u00e8que-Vacances",
        "Online payment \u2013 deprecated, only for existing partners",
        "Card check",
        "Payment hub redirection",
        "Voucher",
        "MasterCard \u2013 deprecated, only for existing partners",
        "Visa \u2013 deprecated, only for existing partners",
        "American Express \u2013 deprecated, only for existing partners",
        "Discover \u2013 deprecated, only for existing partners",
        "Diners Club \u2013 deprecated, only for existing partners",
        "JCB \u2013 deprecated, only for existing partners",
        "UnionPay \u2013 deprecated, only for existing partners",
        "TWINT",
        "Reka",
        "Loyalty card",
        "POS Dining & Spa Reward",
        "Direct debit",
        "Deposit - check",
        "Deposit - cash",
        "Deposit - credit card \u2013 deprecated, only for existing partners",
        "Deposit - wire transfer"
      ]
    },
    "ExternalIdentifier": {
      "type": "string",
      "description": "Identifier of the payment from external system.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "PaymentExternalData"
}