Deposit
Deposit Response object.
Deposit amount in currency minor units.
Currency alphabetic code as specified by ISO 4217
Possible values: >= 3 characters
and <= 3 characters
EUR
paymentInstrumentReference object
Represents a reference to a Payment Instrument, used for Deposit or Withdrawal.
Instrument identifier.
1001
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
]
CARD
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
4bc2deb3-9766-4598-a08e-a98b60615936
returnUrls object[]
Links to redirect customer back during transaction flow.
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
DEFAULT
The url to be used for further actions.
https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709
HTTP request method.
Possible values: [GET
, POST
]
GET
paymentProperties object[]
List of payment option specific properties.
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
- 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|
Possible values: [CARD_CVV
, CARD_SAVE_INSTRUMENT
, SAVE_RECIPIENT
, PAYMENT_CONFIRMATION
]
The value of the payment property.
Deposit id generated during creation.
112233
Customer id.
10001
The account where the money gets deposited in. It deduced based on the currency.
2100002
Slip identifier. Slip contains list of transactions associated with the deposit operations.
5009964049
Deposit Funding transaction id. Stored by Single API and used for Recon.
500005
Represents RFC 3339, section 5.6 date-time.
2021-07-15T17:54:12Z
The payment status:
PREVIEW
- Payment preview.PENDING
- Payment transaction is created and further action is required by the customer.PROCESSING
- Payment is scheduled for processing by the payment provider.COMPLETED
- Payment is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.FAILED
- Payment has failed. Check STATUS_REASON property for details.CANCELLED
- Payment have been cancelledREFUNDED
- Payment has been refunded. Valid only for deposits.
Possible values: [PREVIEW
, PENDING
, PROCESSING
, COMPLETED
, FAILED
, CANCELLED
, REFUNDED
]
COMPLETED
Status reason for FAILED transaction.
Possible values: <= 60 characters
Provides the next possible status update the client can request, depending on the chosen payment type and option.
Possible values: [PREVIEW
, PENDING
, PROCESSING
, COMPLETED
, FAILED
, CANCELLED
, REFUNDED
]
Specifies action required to complete to be able to continue to the next payment status:
NONE
– No action is required, you can proceed to the next deposit status.REDIRECT
– The user must be redirected in order to complete a payment, for example, when an alternate payment method like Paysafecard is used.SCA
- The user must complete a Strong Customer Authentication (SCA) process.
Possible values: [NONE
, REDIRECT
, SCA
]
NONE
NONE
redirectUrl object
The redirect link defines the link used to redirect the payment flow to hosted payment page. The property rel
defines the link type semantic.
The link rel
defines the redirect link semantic.
REDIRECT_PAYMENT
- Merchant needs to redirect consumer to this url to complete payment.
Possible values: [REDIRECT_PAYMENT
]
REDIRECT_PAYMENT
REDIRECT_PAYMENT
The url to be used for further actions.
https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709
HTTP request method.
Possible values: [GET
, POST
]
GET
Enumeration of supported Payment Option Types
Possible values: [RAPID_TRANSFER
, BANK_TRANSFER
, OFFLINE_BANK_TRANSFER
, CARD
, PAYSAFECASH
, PAGO_EFECTIVO
]
CARD
Is the deposit refundable.
paymentDetails object[]
List of payment-option-specific details.
Defines the available payment details keys and their meaning.
Paysafecash-specific details:
PAYSAFECASH_BARCODE_TYPE
- The type of the generated barcode, when using the Paysafecash payment option.- Valid value:
CODE128
- Valid value:
PAYSAFECASH_BARCODE_VALUE
- The value of the generated barcode, when using the Paysafecash payment option.- Valid value:
1000000000000004574
- Valid value:
Possible values: [PAYSAFECASH_BARCODE_TYPE
, PAYSAFECASH_BARCODE_VALUE
]
PAYSAFECASH_BARCODE_TYPE
fees object[]
Customer fees attached to the transaction.
Amount of the merchant payment, in mintor units. If currency
is not specified, then the main transaction currency is used.
0
1000
Currency alphabetic code as specified by ISO 4217
Possible values: >= 3 characters
and <= 3 characters
EUR
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
]
OTHER_FEE
The target merchant wallet id.
500005
Currency alphabetic code as specified by ISO 4217
Possible values: >= 3 characters
and <= 3 characters
EUR
The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.
100001
fxAmount object
(In Development)
Contains the amount in converted currency during currency conversion.
Converted amount (in minor units).
Currency conversion rate.
Currency alphabetic code as specified by ISO 4217
Possible values: >= 3 characters
and <= 3 characters
EUR
{
"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"
}
],
"id": "112233",
"customerId": "10001",
"accountId": "2100002",
"slipId": "5009964049",
"fundingTransactionId": "500005",
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T17:54:12Z",
"status": "COMPLETED",
"statusReason": "string",
"nextStatus": [
"COMPLETED"
],
"action": "NONE",
"redirectUrl": {
"rel": "REDIRECT_PAYMENT",
"href": "https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
"method": "GET"
},
"paymentOption": "CARD",
"refundable": true,
"paymentDetails": [
{
"key": "PAYSAFECASH_BARCODE_TYPE",
"value": "string"
}
],
"fees": [
{
"amount": 1000,
"currency": "EUR",
"paymentReason": "OTHER_FEE",
"merchantId": "500005",
"recipientCurrency": "EUR",
"merchantAccountId": "100001",
"fxAmount": {
"amount": 0,
"rate": 0,
"currency": "EUR"
}
}
]
}