Customers

Request a credit check

You may request a credit check on a customer who hasn't previously been credit checked. This endpoint returns no content. You'll be able to see the date you requested the credit check (credit_check_requested_at) and credit_status updated to pending or, in the case of an instant decision, approved or declined by fetching the Customer entity.

A hold credit status represents when a customer's credit account is over 15 days overdue. A deactivated credit status represents when a customer's credit account has been deactivated.

When a customer's credit_status is approved - the customer's net_terms_status represents the current state of a customer's enrollment in the approved net terms offer. See <a href="#operation/fetchCustomer">#fetchCustomer</a> for more details.

Note: Except for instant decisions, a decision should be reflected on the Customer entity within 1 business day.

post/customers/{customer_id}/credit-check

Request

Path parameters

customer_idstring required

ID of the customer being submitted for a credit check

Request body

amount_requestednumber required

Request an amount (plus buffer) to cover your customer's purchases over their payment term. This can be increased later.

business_descriptionstring nullable

A description of your customer's business.

has_purchase_historyboolean required

Indicates whether this customer has prior purchase history with the merchant. When true, the merchant has prior purchase history with this customer.

has_purchase_terms_historyboolean

Required if has_purchase_history = true. Indicates whether this customer has prior purchase history on net terms with the merchant. When true, the merchant has prior net terms purchase history with this customer.

Example request

{
  "amount_requested": 50000,
  "business_description": "Put a description your customer's business here.",
  "has_purchase_history": true
}

Response

Credit check request accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.