DepositRequest

Structure for initiating Deposit process.

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.

]

paymentOptionCustomerPaymentOptionType (string)required

Payment option requested by customer.

Possible values: [RAPID_TRANSFER, BANK_TRANSFER, CARD, PAYSAFECASH, PAGO_EFECTIVO]

Example: CARD

fees object[]

Customer fees attached to the transaction.

Array [

amountint64required

Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

Default value: 0

Example: 1000

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

paymentReasonFeePaymentReason (string)required

Fee payment reason.

SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
ATM_FEE - Fee for ATM service, when using prepaid cards.
FX_FEE - Fee applied, when payment requires currency exchange.
OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction

Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

Default value: OTHER_FEE

merchantIdstring

The target merchant wallet id.

Example: 500005

recipientCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR

merchantAccountIdstring

The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

Example: 100001

]

DepositRequest
{
  "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"
    }
  ],
  "paymentOption": "CARD",
  "fees": [
    {
      "amount": 1000,
      "currency": "EUR",
      "paymentReason": "OTHER_FEE",
      "merchantId": "500005",
      "recipientCurrency": "EUR",
      "merchantAccountId": "100001"
    }
  ]
}