Skip to main content

WalletRequest

Wallet composite model

customer object
idstring

Possible values: <= 20 characters

Example: 10040500
externalIdExternalId (string)required

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932
typestring

Type of Customer

Possible values: [PERSON]

Default value: PERSON
Example: PERSON
emailstringrequired

Primary email address

Possible values: <= 150 characters

Example: john.smith@mail.com
mobilestringrequired

Mobile number

Possible values: <= 50 characters

Example: +12025550120
registrationIpstring<ipv4>required

IPv4 address from which the customer has registered.

registrationDatestring<date-time>

Date of registration at the Merchant system

restrictions object[]
  • Array [
    • nameRestrictionName (string)required

    Represents the name of a restriction applied to a customer wallet.

    • ALL_TRANSACTIONS - Block all types of transactions.
    • OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
    • INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
    • SEND_MONEY - Block all send money transactions to other customers and merchants.
    • INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
    • CARD_DEPOSITS - Block all deposit made by card.
    • CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
    • DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
    • OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
    • OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
    • DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
    • CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
    • LOGIN - Block access to account login, preventing the user from signing in to view or manage their account.
    • OTHER - Other restrictions.

    Possible values: [ALL_TRANSACTIONS, OUTGOING_TRANSACTIONS, INCOMING_TRANSACTIONS, SEND_MONEY, INCOMING_TRANSACTIONS_AND_SEND_MONEY, CARD_DEPOSITS, CARD_AND_ACH_DEPOSITS, DEPOSITS, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS, DEPOSITS_AND_WITHDRAWALS, CRYPTO_TRANSACTIONS, LOGIN, OTHER]

    Example: ALL_TRANSACTIONS
    reasonRestrictionReason (string)required

    Reason for placing the restriction.

    • RISK_CONTROLS - The reason for setting up the restriction requires additional risk checks to the end-customer's account.
    • COMPLIANCE - The reason for setting up the restriction is related to the customer's due diligence and requires an additional compliance check of the end-customer's account.
    • CLOSE_ACCOUNT - Account closure.
    • DUPLICATE_ACCOUNT - The reason for setting up the restriction shows that the same person already exists as the account owner.
    • KYC - The reason for setting up the restriction is related to the customer's KYC verification and requires KYC document submissions.
    • NO_SERVICE_COUNTRY - No service country.
    • PREPAID_CARD_CHARGEBACK - Pre-paid card chargeback.
    • T_C_ABUSE - Terms & Conditions Abuse
    • TERMINATED - Account terminated.
    • UNDER_18 - Customer under 18.
    • MERCHANT_REQUEST - Merchant placed the restriction.
    • CONFIRM_TXN_ACTIVITY - Contact customer to confirm pre-paid card transactional activities.
    • SCA - Customer should perform some action related to SCA.
    • OTHER - Other reason.

    Possible values: [RISK_CONTROLS, COMPLIANCE, CLOSE_ACCOUNT, DUPLICATE_ACCOUNT, KYC, NO_SERVICE_COUNTRY, PREPAID_CARD_CHARGEBACK, T_C_ABUSE, TERMINATED, UNDER_18, OTHER, CONFIRM_TXN_ACTIVITY, MERCHANT_REQUEST, SCA]

    requiredActionsRequiredAction (string)[]

    Actions to be completed in order to resolve

    Possible values: [CONTACT_CUSTOMER_SERVICE, KYC_VERIFICATION, SUBMIT_ID, SUBMIT_SSN_CARD, SECOND_FORM_OF_ID, SUBMIT_AD, PEP_DECLARATION, BANK_ACCOUNT_VERIFICATION, WAIT, NO_REMEDIATION, COMPLETE_ONBOARDING, NATIONALITY, SETUP_PIN, OTHER, EXPLANATION_OF_ACTIVITY]

    creationTimestring<date-time>

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    idstringrequired

    Restriction id

    Possible values: <= 36 characters

    Example: 084666a4-cd47-40c1-afe2-4a575e341d59
  • ]
    • accounts object[]

    Accounts associated with this customer.

  • Array [
    • currencyCodeCurrency (string)required

    Currency alphabetic code as specified by ISO 4217

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

    Example: EUR
    idstring

    Account id.

    Possible values: <= 20 characters

    Example: 5029090724
    customerIdstring

    Paysafe embedded wallet internal customer identifier.

    Possible values: <= 20 characters

    Example: 123456789
    externalIdExternalId (string)

    External identifier in merchant system. Must be passed during onboarding.

    Possible values: non-empty and <= 40 characters

    Example: a2322550-af91-417f-867e-681efad44b9d
    totalBalanceinteger<int64>

    Amount in minor units

    Example: 0
    availableBalanceinteger<int64>

    Amount in minor units

    Example: 0
    instruments object[]deprecated

    **Deprecated! Use virtualInstrument property instead. **

    List of payment instruments associated with this account, provided by Paysafe. This list might include virtual bank accounts or pre-paid cards funded by the account

  • Array [
    • 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
    BR_BANK_ACCOUNTBR Bank account
    PH_BANK_ACCOUNTPH Bank account
    CLABE_BANK_ACCOUNTCLABE Bank account
    CARDCard
    QR_CODEQR Code

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, BR_BANK_ACCOUNT, PH_BANK_ACCOUNT, CLABE_BANK_ACCOUNT, CARD, QR_CODE]

    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
  • ]
    • virtualInstruments object[]

    List of virtual payment instruments liked to this balance account.

  • Array [
    • idstringrequired

    Virtual instrument unique identifier.

    Possible values: <= 50 characters

    Example: acde070d-8c4c-4f0d-9d8a-162843c10333
    instrumentTypeVirtualInstrumentType (string)required

    Virtual payment instrument type.

    • SEPA_BANK_ACCOUNT - alias to IBAN. Deprecated!
    • UK_BANK_ACCOUNT - UK bank account number and sort code for UK domestic payments.
    • US_BANK_ACCOUNT - US bank account and routing number for US domestic payments
    • IBAN_BANK_ACCOUNT - IBAN used for domestic and international payments in relevant countries.

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, IBAN_BANK_ACCOUNT]

    Example: US_BANK_ACCOUNT
  • ]
    • creationTimestring<date-time>

    Instrument creation time.

    Example: 2019-08-24T14:15:22Z
  • ]
    • firstNamestringrequired

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

    Possible values: <= 50 characters

    lastNamestringrequired

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

    Possible values: <= 50 characters

    titlestring

    Personal title, Mr., Dr., etc.

    Possible values: <= 15 characters

    address1stringrequired

    Address line 1.

    Possible values: <= 200 characters

    address2string

    Address line 2.

    Possible values: <= 200 characters

    citystringrequired

    City of residence.

    Possible values: <= 100 characters

    zipstringrequired

    Postal code.

    Possible values: <= 30 characters

    statestring

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

    Possible values: <= 2 characters

    countryCodeCountryCode (string)required

    ISO-3166 Alpha 2

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

    Example: GB
    birthDatestring<date>required

    Birth date in YYYY-MM-DD format.

    nationalityCountryCode (string)

    ISO-3166 Alpha 2

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

    Example: GB
    occupationOccupation (string)required

    Valid occupation:

    • ARCHITECTURE_CARTOGRAPHY_SURVEYOR - "Architecture, Cartography, Surveyor"
    • LIFE_PHYSICAL_AND_SOCIAL_SCIENCES - "Life, Physical, and Social Sciences"
    • COMMUNITY_AND_SOCIAL_SERVICES - "Community and Social Services"
    • NEWS_AND_REPORTING_SERVICES - "News and Reporting Services"
    • HEALTHCARE_SERVICES - "Healthcare Services"
    • LAW_ENFORCEMENT_AND_PUBLIC_SAFETY - "Law Enforcement and Public Safety"
    • FOOD_AND_BEVERAGE_INDUSTRY - "Food and Beverage Industry"
    • DOMESTIC_SERVICES - "Domestic Services"
    • PERSONAL_CARE_PROFESSIONAL_SERVICES - "Personal Care Professional Services"
    • SALES_AND_RELATED_OCCUPATIONS - "Sales and Related Occupations"
    • OFFICE_ADMINISTRATION_AND_SUPPORT - "Office Administration and Support"
    • FARMING_FISHING_AND_FORESTRY_SERVICES - "Farming, Fishing and Forestry Services"
    • CONSTRUCTION_AND_RELATED_SERVICES - "Construction and Related Services"
    • MANUFACTURING_SERVICES - "Manufacturing Services"
    • TRANSPORTATION_SERVICES - "Transportation Services"
    • ENTERTAINMENT_MEDIA - "Entertainment and Media"
    • UNEMPLOYED - "Unemployed"
    • STUDENT - "Student"
    • PENSIONER - "Pensioner"
    • SPORTS_INDUSTRY - "Sports Industry"
    • BETTING_INDUSTRY - "Betting Industry"
    • ART_AND_DESIGN - "Art and Design"
    • EDUCATION_AND_EDUCATIONAL_SURVICES - "Education and Educational Support Services"
    • ENGINEERING - "Engineering"
    • FINANCIAL_AND_INSURANCE_SERVICES - "Financial and Insurance Services"
    • IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT - "IT Software, Hardware and Website Development"
    • LEGAL_AND_COMPLIANCE_SERVICES - "Legal and Compliance Services"
    • MANAGEMENT_CONSULTING - "Management Consulting"
    • WEAPON_INDUSTRY - "Weapon Industry"
    • CHARITY_AND_NON_PROFIT_SERVICES - "Charity, Non-Profit Services"
    • FREELANCER_SELF_EMPLOYED - "Freelancer, Self-employed"
    • PUBLIC_SECTOR - "Public Sector"

    Possible values: [ARCHITECTURE_CARTOGRAPHY_SURVEYOR, LIFE_PHYSICAL_AND_SOCIAL_SCIENCES, COMMUNITY_AND_SOCIAL_SERVICES, NEWS_AND_REPORTING_SERVICES, HEALTHCARE_SERVICES, LAW_ENFORCEMENT_AND_PUBLIC_SAFETY, FOOD_AND_BEVERAGE_INDUSTRY, DOMESTIC_SERVICES, PERSONAL_CARE_PROFESSIONAL_SERVICES, SALES_AND_RELATED_OCCUPATIONS, OFFICE_ADMINISTRATION_AND_SUPPORT, FARMING_FISHING_AND_FORESTRY_SERVICES, CONSTRUCTION_AND_RELATED_SERVICES, MANUFACTURING_SERVICES, TRANSPORTATION_SERVICES, ENTERTAINMENT_MEDIA, UNEMPLOYED, STUDENT, PENSIONER, SPORTS_INDUSTRY, BETTING_INDUSTRY, ART_AND_DESIGN, EDUCATION_AND_EDUCATIONAL_SURVICES, ENGINEERING, FINANCIAL_AND_INSURANCE_SERVICES, IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT, LEGAL_AND_COMPLIANCE_SERVICES, MANAGEMENT_CONSULTING, WEAPON_INDUSTRY, CHARITY_AND_NON_PROFIT_SERVICES, FREELANCER_SELF_EMPLOYED, PUBLIC_SECTOR]

    Example: ARCHITECTURE_CARTOGRAPHY_SURVEYOR
    vulnerabilitiesVulnerability (string)[]

    List of vulnerabilities

    Possible values: [PHYSICAL_DISABILITY, LOW_MENTAL_CAPACITY, GAMBLING_ADDICTION, FINANCE_MISMANAGEMENT, POOR_LITERACY, POOR_LANGUAGE_SKILLS, POOR_DIGITAL_SKILLS, CARING_RESPONSIBILITIES, FRAUDULENT_LOCATION]

    additionalAttributes object

    List of additional attributes not covered in standard list. Specifics need to be aligned during integration with Paysafe.

    property name*string
    userCategorystring

    The user category

    Possible values: <= 50 characters

    Example: SPECIAL_USER_CATEGORY
    serviceLevelinteger<int32>

    Service level of the customer.

    Possible values: >= 0 and <= 5

    Example: 0
    preferences object

    User-defined preferences related to data consent and marketing communication

    marketing object

    Preferences related to the user's choice to receive marketing communications through various channels, including push notifications, emails, SMS, social media, targeted ads, and third-party marketing.

    receivePushNotificationsboolean

    User preference to receive marketing-related push notifications.

    receiveMarketingEmailsboolean

    User preference to receive promotional emails.

    receiveMarketingSmsboolean

    User preference to receive marketing messages via SMS.

    receiveSocialAdsboolean

    User preference to receive advertisements through social media platforms.

    receiveTargetedAdsboolean

    User preference to receive advertisements that are targeted based on user data.

    receiveThirdPartyAdsboolean

    User preference to receive marketing content from third-party partners.

    data object

    Preferences related to the user's consent for various types of data usage, including targeted advertising, analytics, and performance tracking.

    consentForTargetedAdsboolean

    User consent to use their data for targeted advertising purposes.

    consentForAnalyticsboolean

    User consent to collect and use data for analytics and insights.

    consentForPerformanceTrackingboolean

    User consent to track data for enhancing app or service performance.

    accounts object[]required
  • Array [
    • currencyCodeCurrency (string)required

    Currency alphabetic code as specified by ISO 4217

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

    Example: EUR
  • ]
    • termsAndConditionsAcceptedboolean
    WalletRequest
    {
      "customer": {
        "id": "10040500",
        "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
        "type": "PERSON",
        "email": "john.smith@mail.com",
        "mobile": "+12025550120",
        "registrationIp": "198.51.100.42",
        "registrationDate": "2024-07-29T15:51:28.071Z",
        "restrictions": [
          {
            "name": "ALL_TRANSACTIONS",
            "reason": "RISK_CONTROLS",
            "requiredActions": [
              "CONTACT_CUSTOMER_SERVICE"
            ],
            "creationTime": "2021-07-15T17:54:12Z",
            "id": "084666a4-cd47-40c1-afe2-4a575e341d59"
          }
        ],
        "accounts": [
          {
            "currencyCode": "EUR",
            "id": "5029090724",
            "customerId": "123456789",
            "externalId": "a2322550-af91-417f-867e-681efad44b9d",
            "totalBalance": 0,
            "availableBalance": 0,
            "virtualInstruments": [
              {
                "id": "acde070d-8c4c-4f0d-9d8a-162843c10333",
                "instrumentType": "US_BANK_ACCOUNT"
              }
            ],
            "creationTime": "2019-08-24T14:15:22Z"
          }
        ],
        "firstName": "string",
        "lastName": "string",
        "title": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "zip": "string",
        "state": "string",
        "countryCode": "GB",
        "birthDate": "2024-07-29",
        "nationality": "GB",
        "occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
        "vulnerabilities": [
          "PHYSICAL_DISABILITY"
        ],
        "additionalAttributes": {},
        "userCategory": "SPECIAL_USER_CATEGORY",
        "serviceLevel": 0,
        "preferences": {
          "marketing": {
            "receivePushNotifications": true,
            "receiveMarketingEmails": true,
            "receiveMarketingSms": true,
            "receiveSocialAds": true,
            "receiveTargetedAds": true,
            "receiveThirdPartyAds": true
          },
          "data": {
            "consentForTargetedAds": true,
            "consentForAnalytics": true,
            "consentForPerformanceTracking": true
          }
        }
      },
      "accounts": [
        {
          "currencyCode": "EUR"
        }
      ],
      "termsAndConditionsAccepted": true
    }