Customers
Customers are any companies that have done a payment (financing) with a merchant or have registered through a merchant's invite link.
Endpoints
List Customers - Fetch a list of all customers
Customer Object
Attribute | Type | ID of the customer (same ID found in Payment.customer.id) |
id | string | Internal ID of customer |
legalName | string | Legal name of customer |
cnpj | string | CNPJ of customer |
customerLatestPaymentDate | date | Customer's most recent payment (aka financing) to your merchant account |
customerPaymentsTotalValue | number | Total value of all payments (aka financings) made from customer to your merchant account (in cents - ex. 10050 = $100.50) |
customerPaymentsCount | number | Number of payments (aka financings) customer has made to your merchant account |
applicationDecisionStatus | enum | Outcome of the application (APPROVED, DECLINED, FAILED, REVIEW_REQUIRED) |
applicationCreatedAt | date | Date that the customer applied |
applicationStatus | enum | Status of the application (PENDING, FULL_APPLICATION_PROCESSING, FULL_APPLICATION_COMPLETE) |
creditLineInterestRate | number | Customer's monthly interest rate for payments to your merchant account (in decimal - ex. 0.02 = 2%) |
creditLineStatus | enum | Status of customer's credit line (PENDING, ACTIVE, FROZEN) |
creditLineAvailableBalance | number | Total available credit balance for customer (in cents - ex. 10050 = $100.50) |
creditLineCurrency | string | Currency of credit line balance |
customerCreatedAt | date | Date that the customer joined |
Last updated