Skip to main content

WithdrawalInformation

Withdrawal common information.

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
creationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimestring<date-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
  • ACCEPTED - Payment has been accepted by the recipient and will be automatically processed.

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

Example: FAILED
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, ACCEPTED, 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.
  • USER_INPUT - Additional information from the user is required to complete the payment.

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

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.

creationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimestring<date-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, PAYSAFECARD, PAGO_EFECTIVO, MBWAY, KLARNA]

Example: CARD
instrumentValidationRules object[]

List of payment instrument validation rules relevant for the specific payment option and allows client side instrument validation. This field is returned only when no existing payment instrument is passed, upon withdrawal creation. This field can also contain validation data for payment options, that does not use payment instruments.

  • Array [
    • instrumentTypeInstrumentType (string)

    Represents the type of the instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    CARDCard

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

    Example: CARD
    fields object[]
  • Array [
    • fieldNamestring

    Field name.

    Example: iban
    validations object[]
  • Array [
    • idstring

    Validation rule id. Can be used to identify the validation.

    Example: VALID_IBAN
    messagestring

    Human readable validation error message in English.

    Example: Please enter valid IBAN.
    regexpstring

    Regular explression for the validation

    Example: ^AL\d{10}[0-9A-Z]{16}$|^AD\d{10}[0-9A-Z]{12}$|^AT\d{18}$|^BH\d{2}[A-Z]{4}[0-9A-Z]{14}$|^BE\d{14}$|^BA\d{18}$|^BG\d{2}[A-Z]{4}\d{6}[0-9A-Z]{8}$|^HR\d{19}$|^CY\d{10}[0-9A-Z]{16}$|^CZ\d{22}$|^DK\d{16}$|^FO\d{16}$|^GL\d{16}$|^DO\d{2}[0-9A-Z]{4}\d{20}$|^EE\d{18}$|^FI\d{16}$|^FR\d{12}[0-9A-Z]{11}\d{2}$|^GE\d{2}[A-Z]{2}\d{16}$|^DE\d{20}$|^GI\d{2}[A-Z]{4}[0-9A-Z]{15}$|^GR\d{9}[0-9A-Z]{16}$|^HU\d{26}$|^IS\d{24}$|^IE\d{2}[A-Z]{4}\d{14}$|^IL\d{21}$|^IT\d{2}[A-Z]\d{10}[0-9A-Z]{12}$|^[A-Z]{2}\d{5}[0-9A-Z]{13}$|^KW\d{2}[A-Z]{4}22!$|^LV\d{2}[A-Z]{4}[0-9A-Z]{13}$|^LB\d{6}[0-9A-Z]{20}$|^LI\d{7}[0-9A-Z]{12}$|^LT\d{18}$|^LU\d{5}[0-9A-Z]{13}$|^MK\d{5}[0-9A-Z]{10}\d{2}$|^MT\d{2}[A-Z]{4}\d{5}[0-9A-Z]{18}$|^MR13\d{23}$|^MU\d{2}[A-Z]{4}\d{19}[A-Z]{3}$|^MC\d{12}[0-9A-Z]{11}\d{2}$|^ME\d{20}$|^NL\d{2}[A-Z]{4}\d{10}$|^NO\d{13}$|^PL\d{10}[0-9A-Z]{,16}n$|^PT\d{23}$|^RO\d{2}[A-Z]{4}[0-9A-Z]{16}$|^SM\d{2}[A-Z]\d{10}[0-9A-Z]{12}$|^SA\d{4}[0-9A-Z]{18}$|^RS\d{20}$|^SK\d{22}$|^SI\d{17}$|^ES\d{22}$|^SE\d{22}$|^CH\d{7}[0-9A-Z]{12}$|^TN59\d{20}$|^TR\d{7}[0-9A-Z]{17}$|^AE\d{21}$|^GB\d{2}[A-Z]{4}\d{14}$
  • ]
  • ]
  • ]
    • WithdrawalInformation
    {
      "id": "5000000123",
      "accountId": "1000000123",
      "customerId": "2000000123",
      "slipId": "5009964049",
      "fundingTransactionId": "544232",
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:54:12Z",
      "status": "FAILED",
      "statusReason": "string",
      "nextStatus": [
        "FAILED"
      ],
      "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",
            "action": {
              "language": "en",
              "returnUrl": "https://some-process.paysafe.com/",
              "redirectUrl": "https://some-process.paysafe.com/"
            }
          }
        ],
        "creationTime": "2021-07-15T17:54:12Z",
        "expirationTime": "2021-07-15T17:54:12Z"
      },
      "paymentOption": "CARD",
      "instrumentValidationRules": [
        {
          "instrumentType": "CARD",
          "fields": [
            {
              "fieldName": "iban",
              "validations": [
                {
                  "id": "VALID_IBAN",
                  "message": "Please enter valid IBAN.",
                  "regexp": "^ALd{10}[0-9A-Z]{16}$|^ADd{10}[0-9A-Z]{12}$|^ATd{18}$|^BHd{2}[A-Z]{4}[0-9A-Z]{14}$|^BEd{14}$|^BAd{18}$|^BGd{2}[A-Z]{4}d{6}[0-9A-Z]{8}$|^HRd{19}$|^CYd{10}[0-9A-Z]{16}$|^CZd{22}$|^DKd{16}$|^FOd{16}$|^GLd{16}$|^DOd{2}[0-9A-Z]{4}d{20}$|^EEd{18}$|^FId{16}$|^FRd{12}[0-9A-Z]{11}d{2}$|^GEd{2}[A-Z]{2}d{16}$|^DEd{20}$|^GId{2}[A-Z]{4}[0-9A-Z]{15}$|^GRd{9}[0-9A-Z]{16}$|^HUd{26}$|^ISd{24}$|^IEd{2}[A-Z]{4}d{14}$|^ILd{21}$|^ITd{2}[A-Z]d{10}[0-9A-Z]{12}$|^[A-Z]{2}d{5}[0-9A-Z]{13}$|^KWd{2}[A-Z]{4}22!$|^LVd{2}[A-Z]{4}[0-9A-Z]{13}$|^LBd{6}[0-9A-Z]{20}$|^LId{7}[0-9A-Z]{12}$|^LTd{18}$|^LUd{5}[0-9A-Z]{13}$|^MKd{5}[0-9A-Z]{10}d{2}$|^MTd{2}[A-Z]{4}d{5}[0-9A-Z]{18}$|^MR13d{23}$|^MUd{2}[A-Z]{4}d{19}[A-Z]{3}$|^MCd{12}[0-9A-Z]{11}d{2}$|^MEd{20}$|^NLd{2}[A-Z]{4}d{10}$|^NOd{13}$|^PLd{10}[0-9A-Z]{,16}n$|^PTd{23}$|^ROd{2}[A-Z]{4}[0-9A-Z]{16}$|^SMd{2}[A-Z]d{10}[0-9A-Z]{12}$|^SAd{4}[0-9A-Z]{18}$|^RSd{20}$|^SKd{22}$|^SId{17}$|^ESd{22}$|^SEd{22}$|^CHd{7}[0-9A-Z]{12}$|^TN59d{20}$|^TRd{7}[0-9A-Z]{17}$|^AEd{21}$|^GBd{2}[A-Z]{4}d{14}$"
                }
              ]
            }
          ]
        }
      ]
    }