DepositInformation

Deposit common information.

idstringrequired

Deposit id generated during creation.

Example: 112233

customerIdstringrequired

Customer id.

Example: 10001

accountIdstringrequired

The account where the money gets deposited in. It deduced based on the currency.

Example: 2100002

slipIdstring

Slip identifier. Slip contains list of transactions associated with the deposit operations.

Example: 5009964049

fundingTransactionIdstring

Deposit Funding transaction id. Stored by Single API and used for Recon.

Example: 500005

creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

expirationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

statusPayment Status (string)required

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 cancelled
REFUNDED - Payment has been refunded. Valid only for deposits.
SCHEDULED - Payment is scheduled funds are blocked, but some action is required. Check action response object property for details

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, SCHEDULED, CANCELLED, REFUNDED]

Example: COMPLETED

statusReasonstring

Status reason for FAILED transaction.

Possible values: <= 60 characters

nextStatusPayment Status (string)[]

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, SCHEDULED, CANCELLED, REFUNDED]

actionPayment Action (string)

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.
ONBOARD - A transfer-specific action is required. The recipient customer must be registered with the corresponding email address.

Possible values: [NONE, REDIRECT, SCA, ONBOARD]

Default value: NONE

Example: 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.

relRedirectLinkType (string)

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]

Default value: REDIRECT_PAYMENT

Example: REDIRECT_PAYMENT

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

paymentOptionPaymentOptionType (string)

Enumeration of supported Payment Option Types

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

Example: CARD

refundableboolean

Is the deposit refundable.

DepositInformation
{
  "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
}