Sign in

v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Customers

Get a customer's credit

Get a customer's credit summary.

A linkToken is required in the HTTP Header Slope-Link-Token in addition to the regular auth headers, see Link Flow.

NOTE: Do not store this endpoint response as a customer's credit limit may change dynamically. You should not use the credit response information to determine whether to display Slope as a payment option as there are other factors that determine eligibility.

get/v4/customers/{customerId}/credit

Path parameters

customerIdstring required

The Slope customer ID or the partner external customer ID

Headers

Slope-Link-Tokenstring

The link token generated when the customer granted you access to their Slope account.

Slope-Access-Tokenstring required

The access token returned from exchanging the short lived authorizationCode /v4/auth/token endpoint.

Response

The customers current credit information.

customerIdstring required

The customer ID

preApprovedAmountnumber required

The total pre-approved amount that the customer is given in cents for the given currency

outstandingAmountnumber required

The outstanding amount that the customer has utilized scoped to your merchant

eligibleboolean required

Whether or not the customer is pre-approved for financing

pendingboolean required

Whether or not the customer account is pending review or action

currency'mxn' | 'usd' required
shouldApplyboolean required

Whether or not the customer should apply or re-apply for financing