Get customers

View as Markdown
Retrieves a list of customers from a specific payment service provider (PSP) **Query Params** | Parameter | Type | Description | | --- | --- | --- | | `pspId` | string | (Optional) Identifier of the payment provider (e.g., `nium`, `finmo`) | | `text` | string | (Optional) Filter by firstName, lastName, email | | `name` | string | (Optional) Filter by customer name | | `email` | string | (Optional) Filter by customer email | | `country` | string | (Optional) Filter by customer address country | | `phoneNumber` | string | (Optional) Filter by customer phone number | | `page` | int | _(Optional)_ Page number (default: 0) | | `pageSize` | int | _(Optional)_ Records per page (default: 10) | Response Body 200 OK | Field | Type | Description | | --- | --- | --- | | `id` | string | Identifier of the customer in Manis | | `type` | string | Customer type. Acceptable values: `INDIVIDUAL` or `COMPANY`. | | `accountUsagePurpose` | string | Purpose of the account usage (required by Finmo). | | `firstName` | string | Customer’s first name. | | `lastName` | string | Customer’s last name. | | `dob` | string | Date of birth in `YYYY-MM-DD` format. | | `countryOfResidence` | string | Country where the customer resides (ISO 3166-1 alpha-2 code). | | `email` | string | Customer's email address. | | `phoneCountryCode` | string | Country code for the phone number (e.g., `+1`). | | `phoneNumber` | string | Customer’s phone number. | | `addressCountry` | string | Country of the address (ISO 3166-1 alpha-2 code). | | `addressZipCode` | string | ZIP or postal code. | | `addressCity` | string | City of the address. | | `addressState` | string | State or province. | | `addressStreet` | string | Street name and number. | | `addressLocation` | string | Additional location info (e.g., building, floor). | | `identificationType` | string | Type of ID document (e.g., `PASSPORT`, `NATIONAL_ID`). | | `identificationValue` | string | ID number as shown in the identification document. | | `identificationDocumentId` | string | Document ID from **Upload Customer Document API** for identification. | | `addressProofDocumentId` | string | Document ID from **Upload Customer Document API** for address proof. | | `companyInfo` | object | Company details block. Required when creating a company-type customer. | | `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | `createdBy` | string | | | `updateAt` | date (yyyy-MM-dd'T'HH:mm:ss+00:00) | | | `updatedBy` | string | | | pspCustomers | object | | | └─pspId | string | Identifier of the PSP | | └─pspCustomerId | string | Identifier of the Customer in PSP | | └─status | string | status of the customer | | └─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | └─`createdBy` | string | | `Comapny Information:` | Field | Type | Description | | --- | --- | --- | | `name` | string | Legal name of the company. | | `website` | string | Company website URL. | | `registrationNumber` | string | Company registration number. | | `incorporationCountry` | string | Country where the company is incorporated (ISO 3166-1 alpha-2 code). | | `incorporationDate` | string | Incorporation date in `YYYY-MM-DD` format. | | `email` | string | Company contact email. | | `phoneCountryCode` | string | Country code for the company phone number. | | `phoneNumber` | string | Company phone number. | | `addressCountry` | string | Company address country. | | `addressZipCode` | string | ZIP or postal code. | | `addressCity` | string | City of the company address. | | `addressState` | string | State or province. | | `addressStreet` | string | Street address. | | `addressLocation` | string | Additional address details (e.g., unit, building). | | `incorporationCertificateDocumentId` | string | Document ID for the incorporation certificate (from Upload API). | | `addressProofDocumentId` | string | Document ID for company address proof (from Upload API). | | `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | `createdBy` | string | | | `updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | `updatedBy` | string | | 400 BAD REQUEST - 403 FORBIDDEN - 401 UNAUTHORIZED - 500 INTERNAL ERROR | **Field** | type | | --- | --- | | timestamp | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | title | string | | type | string | | status | number | | soaCode | string | | detail | string |

Query parameters

pagestringOptional
pageSizestringOptional

Response

OK
datalist of objects
totalIteminteger
totalPageinteger
currentPageinteger