Skip to main content

Account

Represents a wallet account that is holding account balance in specific currency.

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! This field will be removed in a future version. Use the Payment Instruments API (/customers/{customerId}/instruments) instead.

This field includes only a subset of supported payment instrument types. The implementation is not maintained, and future instrument types will not be included.

  • 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
    Account
    {
      "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"
    }