DepositRequest
Structure for initiating Deposit process.
Array [
]
Array [
- CARD_CVV - Card CVV is required to confirm the card payment during deposit.
- Valid value:
123
- Valid value:
- CARD_SAVE_INSTRUMENT - The user agrees to save the card for further payments.
- Valid value:
true
- Valid value:
- 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|
]
Array [
- 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
]
Deposit amount in currency minor units.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
paymentInstrumentReference
object
Represents a reference to a Payment Instrument, used for Deposit or Withdrawal.
Instrument identifier.
Possible values: [SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
, CARD
]
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: <= 255 characters
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.
returnUrls
object[]
Links to redirect customer back during transaction flow.
Possible values: [DEFAULT
, ON_COMPLETED
, ON_FAILED
, ON_CANCELLED
]
Default value: DEFAULT
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.
The url to be used for further actions.
Possible values: [GET
, POST
]
HTTP request method.
paymentProperties
object[]
List of payment option specific properties.
Possible values: [CARD_CVV
, CARD_SAVE_INSTRUMENT
, SAVE_RECIPIENT
, PAYMENT_CONFIRMATION
]
Payment property key. Defines available payment property key and their meaning.
Card payment properties:
The value of the payment property.
Possible values: [RAPID_TRANSFER
, BANK_TRANSFER
, CARD
, PAYSAFECASH
, PAGO_EFECTIVO
]
Payment option requested by customer.
fees
object[]
Customer fees attached to the transaction.
Default value: 0
Amount of the merchant payment, in mintor units. If currency
is not specified, then the main transaction currency is used.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Possible values: [MERCHANT_FEE
, ATM_FEE
, FX_FEE
, PAYSAFE_FEE
, OTHER_FEE
, SENDER_FEE
, RECIPIENT_FEE
, DEPOSIT_FEE
, WITHDRAWAL_FEE
]
Default value: OTHER_FEE
Fee payment reason.
The target merchant wallet id.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.