Request a credit check

Request

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 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 #fetchCustomer for more details.

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

Security

bearerAuth or basicAuth

Path

customer_idstringrequired

ID of the customer being submitted for a credit check

Bodyapplication/json

Request a credit check for a customer

amount_requestednumber, >= 1required

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

Example:50000

business_descriptionstring or null, <= 500 characters

A description of your customer's business.

Example:"Put a description your customer's business here."

has_purchase_historybooleanrequired

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

Example:true

has_purchase_terms_historyboolean

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

Example:false

curl -i -X POST \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/customers/{customer_id}/credit-check' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount_requested": 50000,
    "business_description": "Put a description your customer'\''s business here.",
    "has_purchase_history": true,
    "has_purchase_terms_history": false
  }'

Responses

Credit check request accepted.

Response

No content