CommonCustomerWithdrawalRequestProperties

Object conaining common withdrawal request properties.

Withdrawals are created in PREVIEW status and corresponding fee is attached.

amountinteger<int64>required

withdrawal amount in currency minor units.

Possible values: > 0

Example: 1000

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

paymentInstrumentReference object

Represents a reference to a Payment Instrument, used for Deposit or Withdrawal.

idstringrequired

Instrument identifier.

Example: 1001

instrumentTypeInstrumentType (string)required

Represents the type of the instrument.

Value	Description
SEPA_BANK_ACCOUNT	SEPA Bank account
UK_BANK_ACCOUNT	UK Bank account
US_BANK_ACCOUNT	US Bank account
CCI_BANK_ACCOUNT	CCI Bank account
CARD	Card

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Example: CARD

merchantRefNumMerchantReferenceNumber (string)

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Possible values: <= 255 characters

Example: 4bc2deb3-9766-4598-a08e-a98b60615936

paymentProperties object[]

List of payment option specific properties.

Array [

keyPaymentPropertyKey (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 values	Description
  EMBEDDED	Default The payment is confirmed in the hosted Paysafe interface
  OUTSOURCED	The 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 values	Description
  MATCH	The recipient's name and account details match.
  NO_MATCH	The account holder name does not match the account details of the recipient.
  CLOSE_MATCH	The account holder name provided is similar, but not an exact match.
  NOT_POSSIBLE	Unable 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]

valuestring

The value of the payment property.

]

CommonCustomerWithdrawalRequestProperties

{
  "amount": 1000,
  "currencyCode": "EUR",
  "paymentInstrumentReference": {
    "id": "1001",
    "instrumentType": "CARD"
  },
  "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
  "paymentProperties": [
    {
      "key": "CARD_CVV",
      "value": "string"
    }
  ]
}