List Customers

Fetch a list of all customers

Customers

GET https://api.finove.com.br/api/v1/merchant/customers

Returns a list of customers and information about their payments and credit line. This endpoint can also be used to find a specific customer through the query parameters.

Query Parameters

Name	Type	Description
search	string	cnpj of the client, to retrieve only report for that client. Digits only.

Headers

Name	Type	Description
Authorization	string	Access token received from Authentication API. Needs to be on format "Bearer <YOUR_ACCESS_TOKEN>"

200 The response will return a list of customers that matched your query. If you don't pass any parameters, it will return a list of all of your customers.

{
   data: [
      {
         id: "c34a4345-57e9-43a1-b308-92fe21767023",
         customerLegalName: "The Customer Inc.",
         customerTaxId: "66848270000165",
         creditLineInterestRate: 0.03,
         applicationDecisionStatus: "APPROVED,
         applicationCreatedAt: "2019-05-23T12:43:41.758Z",
         applicationStatus: "FULL_APPLICATION_COMPLETE",
         customerCreatedAt: "2019-04-12T19:44:11.837Z",
         creditLineStatus: "ACTIVE",
         creditLineAvailableBalance: 9706000,
         customerPaymentsTotalValue: 267090,
         creditLineCurrency: "BRL",
         customerLatestPaymentDate: "2021-07-05T16:43:41.798Z",
         customerPaymentsCount: 1
      }
   ],
   count: 1
}