Skip to main content

PaymentPropertyKey

Payment property key. Defines available payment property key and their meaning.

Card payment properties:

  • CARD_CVV - Card CVV is required to confirm the card payment during deposit.
    • Valid value: 123
  • CARD_SAVE_INSTRUMENT - The user agrees to save the card for further payments.
    • Valid value: true
  • SAVE_INSTRUMENT - The user agrees to save the instrument for further payments.
    • Valid value: true. Replaces CARD_SAVE_INSTRUMENT
  • PAYMENT_CONFIRMATION - For PCI-DSS level 3 partners card information is collected in Paysafe hosted interface.
    Valid valuesDescription
    EMBEDDEDDefault The payment is confirmed in the hosted Paysafe interface
    OUTSOURCEDThe payment flow is returned to caller after collection of card data
  • CARRIER - Specifies the carrier(s) for the payment flow, used to define the payment target when the payment instrument cannot uniquely identify it. The user must choose from a predefined list of carriers provided by the payment provider.
  • QR_CODE - The unique QR code generated by the payment provider and used to identify the payment transaction.
  • VERIFICATION_OF_PAYEE - Result of the Validation of Payee.
    Valid valuesDescription
    MATCHThe recipient's name and account details match.
    NO_MATCHThe account holder name does not match the account details of the recipient.
    CLOSE_MATCHThe account holder name provided is similar, but not an exact match.
    NOT_POSSIBLEUnable to verify the recipient's details due to a technical issue or missing information.
  • PHONE_NUMBER - Specifies the phone number provided by the user, required for completing certain payment flows or verification steps.
    • Valid value: A valid phone number in international format (e.g. +351912345678).
stringPaymentPropertyKey (string)

Payment property key. Defines available payment property key and their meaning.

Card payment properties:

  • CARD_CVV - Card CVV is required to confirm the card payment during deposit.
    • Valid value: 123
  • CARD_SAVE_INSTRUMENT - The user agrees to save the card for further payments.
    • Valid value: true
  • SAVE_INSTRUMENT - The user agrees to save the instrument for further payments.
    • Valid value: true. Replaces CARD_SAVE_INSTRUMENT
  • PAYMENT_CONFIRMATION - For PCI-DSS level 3 partners card information is collected in Paysafe hosted interface.
    Valid valuesDescription
    EMBEDDEDDefault The payment is confirmed in the hosted Paysafe interface
    OUTSOURCEDThe payment flow is returned to caller after collection of card data
  • CARRIER - Specifies the carrier(s) for the payment flow, used to define the payment target when the payment instrument cannot uniquely identify it. The user must choose from a predefined list of carriers provided by the payment provider.
  • QR_CODE - The unique QR code generated by the payment provider and used to identify the payment transaction.
  • VERIFICATION_OF_PAYEE - Result of the Validation of Payee.
    Valid valuesDescription
    MATCHThe recipient's name and account details match.
    NO_MATCHThe account holder name does not match the account details of the recipient.
    CLOSE_MATCHThe account holder name provided is similar, but not an exact match.
    NOT_POSSIBLEUnable to verify the recipient's details due to a technical issue or missing information.
  • PHONE_NUMBER - Specifies the phone number provided by the user, required for completing certain payment flows or verification steps.
    • Valid value: A valid phone number in international format (e.g. +351912345678).

Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT, SAVE_INSTRUMENT, SAVE_RECIPIENT, PAYMENT_CONFIRMATION, CARRIER, QR_CODE, VERIFICATION_OF_PAYEE, PHONE_NUMBER]

PaymentPropertyKey
"CARD_CVV"