Skip to main content

AccountsListResponse

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

items object[]

The page contents

  • Array [
  • account object
    iduuid

    The primary id of the merchant account

    Example: 019a0abe-f093-72c7-9f89-be4e48b9e01e
    namestring

    The name of the account

    addressLineOnestringnullable

    The address line of the merchant

    addressLineTwostringnullable

    The address line of the merchant

    citystringnullable

    The city of the merchant

    postalCodestringnullable

    The postal code of the merchant

    countryCodestringnullable

    The country code of the merchant

    phonestringnullable

    The primary contact number of the merchant

    emailstringnullable

    The primary contact email of the merchant

    timezonestringnullable

    The primary timezone of the merchant

    invoiceEmailstringnullable

    The email used when sending invoices.

    invoiceAttentionstringnullable

    The receiver name of the invoice email.

    vatstringnullable

    The VAT number of the merchant

    currencyCodestringnullable

    The primary currency code of the merchant

    statusstring

    The current status of the merchant account

    createdAtdate-time

    The merchant account creation time

  • ]
  • AccountsListResponse
    {
    "page": 0,
    "perPage": 0,
    "lastPage": 0,
    "total": 0,
    "firstPageUrl": "string",
    "lastPageUrl": "string",
    "nextPageUrl": "string",
    "previousPageUrl": "string",
    "nextPage": 0,
    "previousPage": 0,
    "from": 0,
    "to": 0,
    "path": "string",
    "items": [
    {
    "account": {
    "id": "019a0abe-f093-72c7-9f89-be4e48b9e01e",
    "name": "string",
    "addressLineOne": "string",
    "addressLineTwo": "string",
    "city": "string",
    "postalCode": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "string",
    "timezone": "string",
    "invoiceEmail": "string",
    "invoiceAttention": "string",
    "vat": "string",
    "currencyCode": "string",
    "status": "string",
    "createdAt": "2024-07-29T15:51:28.071Z"
    }
    }
    ]
    }