ListClientsResponse

successboolean

Example: true

data object[]

Array [

idstring<uuid>

Unique client identifier.

paymentHubIdintegernullable

ID of the associated PaymentHub.

hubNamestringnullable

Name of the associated PaymentHub.

namestring

Full legal name of the client.

taxIdstring

Tax identification number (CUIT).

cashinCallbackUrlstring<uri>nullable

Webhook URL configured to receive cash-in notifications.

externalReferencestringnullable

Your internal reference for this client.

metadata object

Custom metadata.

property name*any

Custom metadata.

emailsstring[]

Contact email addresses.

phonesstring[]

Contact phone numbers.

aliasPrefixHintstringnullable

Requested CVU alias prefix hint.

aliasSuffixHintstringnullable

Requested CVU alias middle segment.

cvustringnullable

22-digit CVU assigned to this client. Null if still provisioning.

Example: 0000726100000000014782

aliasstringnullable

Human-readable CVU alias. Null if still provisioning.

Example: ACMESA.HUB1

cvuStatusstring

Current status of the dedicated CVU provisioning.

Possible values: [not_provisioned, provisioning, active, provisioning_failed, disabled]

createdAtstring<date-time>

ISO 8601 timestamp of client creation.

]

pagination object

pageintegerrequired

Current page number

Example: 1

limitintegerrequired

Items per page

Example: 20

totalintegerrequired

Total number of items

Example: 150

totalPagesintegerrequired

Total number of pages

Example: 8

timestampstring<date-time>

ListClientsResponse

{
  "success": true,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentHubId": 0,
      "hubName": "string",
      "name": "string",
      "taxId": "string",
      "cashinCallbackUrl": "string",
      "externalReference": "string",
      "metadata": {},
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ],
      "aliasPrefixHint": "string",
      "aliasSuffixHint": "string",
      "cvu": "0000726100000000014782",
      "alias": "ACMESA.HUB1",
      "cvuStatus": "not_provisioned",
      "createdAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}