CommonCustomerDepositRequestProperties

Structure for common customer facing deposit properties.

amountint64required

Deposit amount in currency minor units.

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

returnUrls object[]

Links to redirect customer back during transaction flow.

Array [

relReturnLinkType (string)

The link rel defines a semantic of the merchant url to redirect the payment flow.

DEFAULT - The default return URL that will be used if specific status return URL is not defined or cannot be determined. ON_COMPLETED - Paysafe will return to this merchant url post succeful payment authorisation. ON_FAILED - Paysafe will return to this merchant url post if the authorisation failed. ON_CANCELLED - Paysafe will return to this merchant url post if payment is cancelled in PSP.

Possible values: [DEFAULT, ON_COMPLETED, ON_FAILED, ON_CANCELLED]

Default value: DEFAULT

Example: DEFAULT

hrefstring

The url to be used for further actions.

Example: https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709

methodHttpRequestMethod (string)

HTTP request method.

Possible values: [GET, POST]

Example: GET

]

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
• 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|

Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT, SAVE_RECIPIENT, PAYMENT_CONFIRMATION]

valuestring

The value of the payment property.

]

CommonCustomerDepositRequestProperties

{
  "amount": 0,
  "currencyCode": "EUR",
  "paymentInstrumentReference": {
    "id": "1001",
    "instrumentType": "CARD"
  },
  "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
  "returnUrls": [
    {
      "rel": "DEFAULT",
      "href": "https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
      "method": "GET"
    }
  ],
  "paymentProperties": [
    {
      "key": "CARD_CVV",
      "value": "string"
    }
  ]
}