Skip to main content

WithdrawalStatusUpdateRequest

Withdrawal status update object.

    status PaymentStatus (string)required

    Possible values: [PENDING, PROCESSING]

    paymentProperties

    object[]

    List of payment option specific properties required for processing of the payment.

  • Array [

    • key PaymentPropertyKey (string)

    Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT, SAVE_RECIPIENT, PAYMENT_CONFIRMATION]

    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|
    value string

    The value of the payment property.

  • ]

    • recipient

    object

    Withdrawal recipient request object.

    label string

    Possible values: non-empty and <= 100 characters

    Label for the recipient. Use this field to label the recipient, if you want to make additional payments to the same party. If not specified the label is generated by combining the title, first name, and last name. If ACTIVE recipient with the same label already exists a number suffix is added.

    title string

    Possible values: <= 15 characters

    Personal title, Mr., Dr., etc.

    firstName stringrequired

    Possible values: non-empty and <= 50 characters

    First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

    lastName stringrequired

    Possible values: non-empty and <= 50 characters

    Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

    address

    object

    required

    Address of the customer.

    countryCode CountryCode (string)required

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

    ISO-3166 Alpha 2

    stateProvince string

    Possible values: <= 2 characters

    US state postal abbreviation. Not used for non-US territories.

    city stringrequired

    Possible values: <= 50 characters

    City.

    postalCode stringrequired

    Possible values: non-empty and <= 50 characters

    Postal code.

    address1 stringrequired

    Possible values: <= 200 characters

    The first line of the address.

    address2 string

    Possible values: <= 200 characters

    The second line of the address.

    contactInfo

    object

    Represents contact information.

    mobile string

    Possible values: <= 50 characters

    Mobile number.

    email email

    Possible values: >= 6 characters and <= 100 characters

    Email.

    paymentInstrument

    object

    required

    Represents a payment instrument, used for third-party payments. Here are the valid instrumentType values:

    • SEPA_BANK_ACCOUNT - IBAN Bank Account for EEA international transfers

    • UK_BANK_ACCOUNT - UK Bank Account for somestic UK transfers

    • US_BANK_ACCOUNT - US Bank Account for domestic USA transfers

    id uuid

    The instrument id

    instrumentType

    string

    required

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

    Represents the type of the recipient instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    accountHolderName string

    Possible values: <= 100 characters

    This is the name of the customer or company that owns the bank account.

    iban stringrequired

    The International Bank Account Number (IBAN) of the account.

    bic stringrequired

    The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

    bankName string

    The bank name.

    type stringrequired

    Possible values: [BUSINESS, INDIVIDUAL]

    Recipient type.

    scaDetails

    object

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

    • Included in the request - operation has already undergone SCA authentication and is authorized to proceed. The SCA details connect the wallet operation to the SCA authentication event.

    • Not included in the request - operation either does not require SCA authentication or is being initiated for the first time, and the user's need for SCA is uncertain. If SCA is needed, the response will provide the SCA details for use in the subsequent execution of the wallet operation.

    eventId stringrequired

    A distinct identifier for the SCA authentication event.

    walletOperationId stringrequired

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