Process Deposit
POST/v2/customers/:customerId/deposits/:depositId/status
Request deposit status update.
Deposits are created in PREVIEW
state.
Deposits in PREVIEW state do not create actual transaction in Paysafe Wallet system. It allows to check deposit parameters and display the fees.
To move the payment forward you must request status change using POST /v2/customers/{customerId}/deposits/{depositId}/status
. This will perform the required validations and move the deposit in PENDING
state.
{
"status": "PENDING"
}
To confirm the deposit for execution use POST /v2/customers/{customerId}/deposits/{depositId}/status
:
{
"status": "PROCESSING"
}
Request
Path Parameters
Deposit Id.
Customer Id.
- application/json
Body
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|
]
-
SEPA_BANK_ACCOUNT - SepaBankAccountPaymentInstrument
-
UK_BANK_ACCOUNT - UkBankAccountPaymentInstrument
-
US_BANK_ACCOUNT - UsBankAccountPaymentInstrument
-
CCI_BANK_ACCOUNT - CciBankAccountPaymentInstrument
-
CARD - Represents CardPaymentInstrument
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
Possible values: [PENDING
, PROCESSING
]
paymentProperties
object[]
List of payment option specific properties required for processing of the payment.
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.
paymentInstrument
object
Represents a payment instrument, used for Deposit or Withdrawal. Here are the valid instrumentType values:
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
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 |
any
any
any
any
any
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
The instrument status.
Represents RFC 3339, section 5.6 date-time.
Responses
- 202
- 400
- 405
Accepted
- application/json
- Schema
- Example (from schema)
- PAGO_EFECTIVO_PENDING
- PAGO_EFECTIVO_PROCESSING
Schema
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|
]
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.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.REDIRECT_PAYMENT
- Merchant needs to redirect consumer to this url to complete payment.Array [
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:
]
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.
Deposit id generated during creation.
Customer id.
The account where the money gets deposited in. It deduced based on the currency.
Slip identifier. Slip contains list of transactions associated with the deposit operations.
Deposit Funding transaction id. Stored by Single API and used for Recon.
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
Possible values: [PREVIEW
, PENDING
, PROCESSING
, COMPLETED
, FAILED
, CANCELLED
, REFUNDED
]
The payment status:
Possible values: <= 60 characters
Status reason for FAILED transaction.
Possible values: [PREVIEW
, PENDING
, PROCESSING
, COMPLETED
, FAILED
, CANCELLED
, REFUNDED
]
Provides the next possible status update the client can request, depending on the chosen payment type and option.
Possible values: [NONE
, REDIRECT
, SCA
]
Default value: NONE
Specifies action required to complete to be able to continue to the next payment status:
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.
Possible values: [REDIRECT_PAYMENT
]
Default value: REDIRECT_PAYMENT
The link rel
defines the redirect link semantic.
The url to be used for further actions.
Possible values: [GET
, POST
]
HTTP request method.
Possible values: [RAPID_TRANSFER
, BANK_TRANSFER
, OFFLINE_BANK_TRANSFER
, CARD
, PAYSAFECASH
, PAGO_EFECTIVO
]
Enumeration of supported Payment Option Types
Is the deposit refundable.
paymentDetails
object[]
List of payment-option-specific details.
Possible values: [PAYSAFECASH_BARCODE_TYPE
, PAYSAFECASH_BARCODE_VALUE
]
Defines the available payment details keys and their meaning.
Paysafecash-specific details:
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.
fxAmount
object
(In Development)
Contains the amount in converted currency during currency conversion.
Converted amount (in minor units).
Currency conversion rate.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
{
"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"
}
}
]
}
{
"amount": 1000,
"currencyCode": "PEN",
"paymentOption": "PAGO_EFECTIVO",
"merchantRefNum": "a2322550-af91-417f-867e-681efad44b9d",
"returnUrls": [
{
"rel": "ON_COMPLETED",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
},
{
"rel": "ON_FAILED",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-error.html",
"method": "GET"
},
{
"rel": "DEFAULT",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
}
],
"deviceInfo": {
"threatMetrixSessionId": "a71a475b-1956-4814-9c92-7faa8226b218",
"appType": "WEB_APP"
},
"id": "124567",
"customerId": "87976765",
"accountId": "242421231",
"slipId": "5009964049",
"fundingTransactionId": "500005",
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T17:54:12Z",
"status": "PENDING",
"nextStatus": [
"PROCESSING"
]
}
{
"amount": 1000,
"currencyCode": "PEN",
"paymentOption": "PAGO_EFECTIVO",
"merchantRefNum": "a2322550-af91-417f-867e-681efad44b9d",
"returnUrls": [
{
"rel": "ON_COMPLETED",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
},
{
"rel": "ON_FAILED",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-error.html",
"method": "GET"
},
{
"rel": "DEFAULT",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
}
],
"deviceInfo": {
"threatMetrixSessionId": "a71a475b-1956-4814-9c92-7faa8226b218",
"appType": "WEB_APP"
},
"id": "124567",
"customerId": "87976765",
"accountId": "242421231",
"slipId": "5009964049",
"fundingTransactionId": "500005",
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T17:54:12Z",
"status": "PENDING",
"action": "REDIRECT",
"redirectUrl": {
"rel": "REDIRECT_PAYMENT",
"href": "https://api.qa.paysafe.com/alternatepayments/v1/redirect?accountId=1020436290&paymentHandleId=18d2744e-c2ee-4a05-a047-14c2d65f1eee&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDIwNDM2MjkwIiwicHlkIjoiMThkMjc0NGUtYzJlZS00YTA1LWEwNDctMTRjMmQ2NWYxZWVlIiwiZXhwIjoxNjYwODk5NzQ5fQ.uNm3b4uFbQQmwIayRsmFTXWw9Ep7chfV8SIH2VUqI_M",
"method": "GET"
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
- DW-OPERATION-NOT-ALLOWED
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-OPERATION-NOT-ALLOWED",
"message": "Operation is not allowed in your account. Contact Paysafe for further details.",
"details": [
"Operation is not allowed in your account. Contact Paysafe for further details."
]
}
}