Skip to main content

PagedModelAccount

content object[]
  • Array [
  • idstringrequired

    Unique ID

    accountTypestringrequired

    Account type.

    Possible values: [INDIVIDUAL, BUSINESS]

    accountNamestring

    Name of account.

    emailstring

    Email address.

    phoneNumberstring

    Phone number of customer (preferably mobile).

    countryCodestring

    Country of residence for INDIVIDUAL. Country of registration for BUSINESS.

    Example: GB
    externalIdstring

    Client-provided identifier for the account. Used for idempotency and external reference.

    accountStatusstring

    Represents the current onboarding and operational status of the account.

    Possible values:

    • CREATED: Account created.
    • APPLICATION_IN_PROGRESS: Account sign-up accepted, onboarding in progress.
    • APPLICATION_SUBMITTED: Customer has submitted the application and pending review by operations.
    • APPLICATION_APPROVED: Application approved by operations, awaiting card details to activate account.
    • ACTIVE: Card details added and account is now fully onboarded.
    • DECLINED: Application was rejected by operations or did not meet eligibility criteria.
    • SUSPENDED: Account temporarily disabled due to billing issues or subscription expiry.
    • CLOSED: Account has been permanently closed or terminated.

    Possible values: [CREATED, APPLICATION_IN_PROGRESS, APPLICATION_SUBMITTED, APPLICATION_APPROVED, ACTIVE, DECLINED, SUSPENDED, CLOSED]

    accountTierstring

    See Hubpay tier plans

    Possible values: [STARTER, SCALE, TREASURY]

  • ]
  • page object
    sizeint64
    numberint64
    totalElementsint64
    totalPagesint64
    PagedModelAccount
    {
    "content": [
    {
    "id": "string",
    "accountType": "INDIVIDUAL",
    "accountName": "string",
    "email": "string",
    "phoneNumber": "string",
    "countryCode": "GB",
    "externalId": "string",
    "accountStatus": "CREATED",
    "accountTier": "STARTER"
    }
    ],
    "page": {
    "size": 0,
    "number": 0,
    "totalElements": 0,
    "totalPages": 0
    }
    }