Skip to main content

Withdrawal

Withdrawal Response object.

amountint64required

withdrawal amount in currency minor units.

Example: 1000
currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
paymentInstrumentReference object

Represents a reference to a Payment Instrument, used for Deposit or Withdrawal.

idstringrequired

Instrument identifier.

Example: 1001
instrumentTypeInstrumentType (string)required

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]

Example: CARD
merchantRefNumMerchantReferenceNumber (string)

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

Example: 4bc2deb3-9766-4598-a08e-a98b60615936
paymentProperties object[]

List of payment option specific properties.

  • Array [
    • keyPaymentPropertyKey (string)

    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
    • CARD_SAVE_INSTRUMENT - The user agrees to save the card for further payments.
      • Valid value: true
    • 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]

    valuestring

    The value of the payment property.

  • ]
    • 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.

    Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, 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, 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.

    Possible values: [NONE, REDIRECT, SCA]

    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
    availableVerifications object[]

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

  • Array [
    • methodSCA Authentication Event Attempt Verification Method (string)required

    Method used for verifying the SCA authentication event attempt.

    • PASSWORD - A secret combination of characters, typically chosen by the user, used to authenticate their identity.
    • PIN - A numeric code, typically six digits, used to authenticate the user's identity.
    • PASSKEYS - A set of predefined keys or a pattern chosen by the user to authenticate their identity.
    • OTP - One-Time Password sent via SMS, email, or authenticator application to the user's registered device.
    • BIOMETRIC - Authentication based on unique physical characteristics of the user, such as fingerprint, facial recognition, or iris scan.

    Possible values: [PASSWORD, PIN, PASSKEYS, OTP, BIOMETRIC]

    Example: OTP
    channelSCA Authentication Event Attempt Verification Channel (string)

    Channel used to send the verification method to the user.

    • SMS - Verification method sent via SMS to the user's registered device.
    • EMAIL - Verification method sent via email to the user's registered address.
    • AUTHENTICATOR - Verification method generated by an authenticator application installed on the user's device.
    • PUSH_NOTIFICATION - Verification method sent via the user's mobile device prompting them to approve or deny the authentication request.

    Possible values: [SMS, EMAIL, AUTHENTICATOR, PUSH_NOTIFICATION]

    Example: SMS
    targetstring

    The destination for the verification mechanism (when available), such as the phone number or email address where the verification value will be delivered.

    Example: jo***@example.com
  • ]
    • 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
    paymentDetails object[]

    List of payment-option-specific details.

  • Array [
    • keyPaymentDetailsKey (string)

    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
    • PAYSAFECASH_BARCODE_VALUE - The value of the generated barcode, when using the Paysafecash payment option.
      • Valid value: 1000000000000004574

    Possible values: [PAYSAFECASH_BARCODE_TYPE, PAYSAFECASH_BARCODE_VALUE]

    Example: PAYSAFECASH_BARCODE_TYPE
    valuestring
  • ]
    • typeParticipantType (string)

    Participant in the payment.

    Possible values: [THIRD_PARTY, FIRST_PARTY]

    Default value: FIRST_PARTY
    Example: FIRST_PARTY
    descriptionstring

    Description of the payment.

    Possible values: <= 50 characters

    recipientReferencestring

    Withdrawal recipient id of ACTIVE withdrawal recipient for THIRD_PARTY withdrawals. If not specified during THIRD_PARTY Withdrawal creation, the withdrawal recipient must be specified during the first withdrawal step.

    Example: 97266b06-c85f-4acd-9a3f-3aa0eed8b11e
    fees object[]

    Customer fees attached to the transaction.

  • Array [
    • amountint64required

    Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

    Default value: 0
    Example: 1000
    currencyCurrency (string)

    Currency alphabetic code as specified by ISO 4217

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    paymentReasonFeePaymentReason (string)required

    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]

    Default value: OTHER_FEE
    merchantIdstring

    The target merchant wallet id.

    Example: 500005
    recipientCurrencyCurrency (string)

    Currency alphabetic code as specified by ISO 4217

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    merchantAccountIdstring

    The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

    Example: 100001
    fxAmount object

    (In Development)

    Contains the amount in converted currency during currency conversion.

    amountinteger

    Converted amount (in minor units).

    ratenumber

    Currency conversion rate.

    currencyCurrency (string)

    Currency alphabetic code as specified by ISO 4217

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
  • ]
    • Withdrawal
    {
      "amount": 1000,
      "currencyCode": "EUR",
      "paymentInstrumentReference": {
        "id": "1001",
        "instrumentType": "CARD"
      },
      "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
      "paymentProperties": [
        {
          "key": "CARD_CVV",
          "value": "string"
        }
      ],
      "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",
      "paymentDetails": [
        {
          "key": "PAYSAFECASH_BARCODE_TYPE",
          "value": "string"
        }
      ],
      "type": "FIRST_PARTY",
      "description": "string",
      "recipientReference": "97266b06-c85f-4acd-9a3f-3aa0eed8b11e",
      "fees": [
        {
          "amount": 1000,
          "currency": "EUR",
          "paymentReason": "OTHER_FEE",
          "merchantId": "500005",
          "recipientCurrency": "EUR",
          "merchantAccountId": "100001",
          "fxAmount": {
            "amount": 0,
            "rate": 0,
            "currency": "EUR"
          }
        }
      ]
    }