WithdrawalInformation

idstringrequired

Withdrawal id generated during creation.

Example: 5000000123

accountIdstringrequired

Example: 1000000123

customerIdstringrequired

Example: 2000000123

slipIdstring

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

Example: 5009964049

fundingTransactionIdstring

Withdrawal funding transaction id.

Example: 544232

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

scaDetails object

SCA authentication details, including information about the authentication process. It should be present in the response of any wallet operation that requires it due to PSD2 regulatory requirements.

• Present in the response - operation requires SCA authentication, and the user should proceed with the SCA process.
• Not present in the response - operation does not require SCA authentication and is authorized to proceed.

eventIdstringrequired

The distinct identifier for the SCA authentication event.

Example: 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

walletOperationIdstringrequired

The distinct identifier for the wallet operation. This identifier is used to associate the wallet operation with the SCA authentication event.

Example: a5865fd6-18c2-45a8-9953-1c00eac36c36

authenticationModeSCA Authentication Mode (string)required

Mode of the Strong Customer Authentication (SCA) authentication process.

• OUTSOURCED - The partner is responsible for handling the entire SCA process.
• EMBEDDED - Paysafe is responsible for handling the entire SCA process, including user authentication and compliance with regulations like PSD2.
• HYBRID - Paysafe manages the entire SCA process, excluding the communication with the end-user.

Possible values: [OUTSOURCED, EMBEDDED, HYBRID]

Example: OUTSOURCED

availableVerificationsobject[]

List of available verifications for the SCA authentication event. If none are specified, the user can proceed with any agreed-upon verification method.

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

paymentOptionPaymentOptionType (string)

Enumeration of supported Payment Option Types

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

Example: CARD

WithdrawalInformation

{
  "id": "5000000123",
  "accountId": "1000000123",
  "customerId": "2000000123",
  "slipId": "5009964049",
  "fundingTransactionId": "544232",
  "creationTime": "2021-07-15T17:54:12Z",
  "expirationTime": "2021-07-15T17:54:12Z",
  "status": "COMPLETED",
  "statusReason": "string",
  "nextStatus": [
    "COMPLETED"
  ],
  "action": "NONE",
  "scaDetails": {
    "eventId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
    "walletOperationId": "a5865fd6-18c2-45a8-9953-1c00eac36c36",
    "authenticationMode": "OUTSOURCED",
    "availableVerifications": [
      {
        "method": "OTP",
        "channel": "SMS",
        "target": "jo***@example.com"
      }
    ],
    "creationTime": "2021-07-15T17:54:12Z",
    "expirationTime": "2021-07-15T17:54:12Z"
  },
  "paymentOption": "CARD"
}