Skip to main content

WithdrawalRequest

Structure for initiating withdrawal process.

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.

  • ]
    • paymentOptionCustomerPaymentOptionType (string)required

    Payment option requested by customer.

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

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