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

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

valuestring

The value of the payment property.

]

paymentInstrument object

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

SEPA_BANK_ACCOUNT - SepaBankAccountPaymentInstrument
UK_BANK_ACCOUNT - UkBankAccountPaymentInstrument
US_BANK_ACCOUNT - UsBankAccountPaymentInstrument
CCI_BANK_ACCOUNT - CciBankAccountPaymentInstrument
CARD - Represents CardPaymentInstrument

idstring

The instrument id

customerIdstring

The customer to which this instrument belongs.

Example: 5435323362

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

externallyVerifiedboolean

Is the instrument externally verified.

Default value: false

statusstring

The instrument status.

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

creationTimedate-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

emailemail

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
QR_CODE - QR Code for transfers via QR code

idstring

The instrument id

Example: 97266b06c85f4acd9a3f3aa0eed8b11e

instrumentTypeRecipientInstrumentType (string)required

Represents the type of the recipient instrument.

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

Example: US_BANK_ACCOUNT

typestring

Recipient type.

Possible values: [BUSINESS, INDIVIDUAL]

birthDatedate

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"
  }
}