Skip to main content

WithdrawalStatusUpdateRequest

Withdrawal status update object.

statusPaymentStatus (string)required

Possible values: [PENDING, PROCESSING, CANCELLED, SCHEDULED, ACCEPTED]

Example: PENDING
paymentProperties object[]

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

  • 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
    • SAVE_INSTRUMENT - The user agrees to save the instrument for further payments.
      • Valid value: true. Replaces CARD_SAVE_INSTRUMENT
    • PAYMENT_CONFIRMATION - For PCI-DSS level 3 partners card information is collected in Paysafe hosted interface.
      Valid valuesDescription
      EMBEDDEDDefault The payment is confirmed in the hosted Paysafe interface
      OUTSOURCEDThe payment flow is returned to caller after collection of card data
    • CARRIER - Specifies the carrier(s) for the payment flow, used to define the payment target when the payment instrument cannot uniquely identify it. The user must choose from a predefined list of carriers provided by the payment provider.
    • QR_CODE - The unique QR code generated by the payment provider and used to identify the payment transaction.
    • VERIFICATION_OF_PAYEE - Result of the Validation of Payee.
      Valid valuesDescription
      MATCHThe recipient's name and account details match.
      NO_MATCHThe account holder name does not match the account details of the recipient.
      CLOSE_MATCHThe account holder name provided is similar, but not an exact match.
      NOT_POSSIBLEUnable to verify the recipient's details due to a technical issue or missing information.
    • PHONE_NUMBER - Specifies the phone number provided by the user, required for completing certain payment flows or verification steps.
      • Valid value: A valid phone number in international format (e.g. +351912345678).

    Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT, SAVE_INSTRUMENT, SAVE_RECIPIENT, PAYMENT_CONFIRMATION, CARRIER, QR_CODE, VERIFICATION_OF_PAYEE, PHONE_NUMBER]

    valuestring

    The value of the payment property.

  • ]
    • paymentInstrument object

    Represents a payment instrument, used for Deposit or Withdrawal. Here are the valid instrumentType values:

    idstring

    The instrument id

    customerIdstring

    The customer to which this instrument belongs.

    Example: 5435323362
    instrumentTypeInstrumentType (string)required

    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
    externallyVerifiedboolean

    Is the instrument externally verified.

    Default value: false
    statusstring

    The instrument status.

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    creationTimestring<date-time>

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    recipient object

    Withdrawal recipient request object.

    labelstring

    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.

    Possible values: non-empty and <= 100 characters

    Example: Supplier1
    titlestring

    Personal title, Mr., Dr., etc.

    Possible values: <= 15 characters

    Example: Mr.
    firstNamestring

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

    Possible values: non-empty and <= 50 characters

    Example: Tom
    lastNamestring

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

    Possible values: non-empty and <= 50 characters

    Example: Jones
    address object

    Address of the customer.

    countryCodeCountryCode (string)required

    ISO-3166 Alpha 2

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

    Example: GB
    stateProvincestring

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

    Possible values: <= 2 characters

    citystringrequired

    City.

    Possible values: <= 50 characters

    Example: London
    postalCodestringrequired

    Postal code.

    Possible values: non-empty and <= 50 characters

    Example: E1 6AN
    address1stringrequired

    The first line of the address.

    Possible values: <= 200 characters

    Example: 12 Brushfield Street
    address2string

    The second line of the address.

    Possible values: <= 200 characters

    contactInfo object

    Represents contact information.

    mobilestring

    Mobile number.

    Possible values: <= 50 characters

    emailstring<email>

    Email.

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

    paymentInstrument objectrequired

    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 domestic UK transfers
    • US_BANK_ACCOUNT - US Bank Account for domestic USA transfers
    • CCI_BANK_ACCOUNT - CCI Bank Account for transfers in Peru
    • PHONE_NUMBER - Phone Number for transfers via phone number
    idstring

    The instrument id

    Example: 97266b06c85f4acd9a3f3aa0eed8b11e
    instrumentTypeRecipientInstrumentType (string)required

    Represents the type of the recipient instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    PHONE_NUMBERPhone Number

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

    Example: US_BANK_ACCOUNT
    typestring

    Recipient type.

    Possible values: [BUSINESS, INDIVIDUAL]

    birthDatestring<date>

    Birth date in YYYY-MM-DD format.

    Example: 1981-01-11
    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.
    eventIdstringrequired

    A distinct identifier for the SCA authentication event.

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

    A 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
    WithdrawalStatusUpdateRequest
    {
      "status": "PENDING",
      "paymentProperties": [
        {
          "key": "CARD_CVV",
          "value": "string"
        }
      ],
      "paymentInstrument": {
        "id": "string",
        "customerId": "5435323362",
        "instrumentType": "CARD",
        "externallyVerified": false,
        "status": "VERIFIED",
        "creationTime": "2021-07-15T17:54:12Z"
      },
      "recipient": {
        "label": "Supplier1",
        "title": "Mr.",
        "firstName": "Tom",
        "lastName": "Jones",
        "address": {
          "countryCode": "GB",
          "stateProvince": "string",
          "city": "London",
          "postalCode": "E1 6AN",
          "address1": "12 Brushfield Street",
          "address2": "string"
        },
        "contactInfo": {
          "mobile": "string",
          "email": "user@example.com"
        },
        "paymentInstrument": {
          "id": "97266b06c85f4acd9a3f3aa0eed8b11e",
          "instrumentType": "US_BANK_ACCOUNT"
        },
        "type": "BUSINESS",
        "birthDate": "1981-01-11"
      },
      "scaDetails": {
        "eventId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
        "walletOperationId": "a5865fd6-18c2-45a8-9953-1c00eac36c36"
      }
    }