Request payment terms and credit

Authorizations

Authorization

string

header

required

API key or access token

Body

application/json

Request body for a buyer submitting a credit-line application. The applicant customer is taken from the auth context, not this body.

requestedCreditLimit

integer

required

Requested credit limit in the currency minor units (e.g. cents). Must be > 0 and at most 100,000,000,000 (≈ $1B) — prepay (no line) needs no application.

Required range: 1 <= x <= 100000000000

currency

string

default:USD

ISO 4217 currency the requested limit is denominated in. Defaults to USD.

requestedPaymentTerms

enum<string>

default:net_60

Requested post-pay terms. Defaults to net_60; the seller must counteroffer rather than silently substitute different terms.

Available options:

net_15,

net_30,

net_45,

net_60,

net_90

justification

string

Free-text context for the request (expected volume, business case).

Maximum string length: 4000

Response

Request payment terms and credit

A versioned credit application with explicit counteroffer lifecycle state.

string

required

Surrogate id of the application row (BIGINT serialized as string).

Example:

"42"

customerId

integer

required

Credit-bearing customer the application is for (PARENT or STANDALONE).

Required range: -9007199254740991 <= x <= 9007199254740991

customerName

string | null

required

Display name of the applicant account (company name, falling back to the customer's name). Resolved server-side from the core customer record; null on buyer-facing reads or when the customer cannot be resolved.

requestedCreditLimit

integer

required

Requested limit in currency minor units.

Required range: -9007199254740991 <= x <= 9007199254740991

requestedPaymentTerms

enum<string> | null

required

Post-pay terms requested by the buyer. Null only for applications created before payment terms were collected.

Available options:

net_15,

net_30,

net_45,

net_60,

net_90

currency

string

required

ISO 4217 currency of the limits on this application.

status

enum<string>

required

Lifecycle state. PENDING until review; COUNTEROFFERED when Scope3 proposes a different limit or payment term and awaits buyer acceptance; APPROVED once the agreed standing is effective; REJECTED when declined; WITHDRAWN when the applicant pulls an open request.

Available options:

PENDING,

COUNTEROFFERED,

APPROVED,

REJECTED,

WITHDRAWN

justification

string | null

required

Free-text context supplied on submit. Null when not given.

grantedCreditLimit

integer | null

required

Limit granted on approval or proposed in a counteroffer, in currency minor units. Null until review.

Required range: -9007199254740991 <= x <= 9007199254740991

grantedPaymentTerms

enum<string> | null

required

Terms granted on approval or proposed in a counteroffer. Null until review.

Available options:

net_15,

net_30,

net_45,

net_60,

net_90

acceptedBy

string | null

required

Buyer user id that explicitly accepted a counteroffer. Null for direct approvals and service-token acceptances; acceptedAt still records service-token acceptance.

acceptedAt

string<date-time> | null

required

When the buyer accepted a counteroffer. Null when no acceptance was required.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

reviewedBy

string | null

required

User id of the superadmin who decided (BIGINT serialized as string). Null while pending.

reviewerName

string | null

required

Display name (or email) of the superadmin who decided, resolved server-side from the core user record. Null while pending, on buyer-facing reads, or when the reviewer cannot be resolved.

reviewedAt

string<date-time> | null

required

When the decision was recorded (ISO 8601). Null while pending.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

reviewerNotes

string | null

required

Superadmin note attached to the decision. Null while pending.

createdAt

string<date-time>

required

When the application was submitted (ISO 8601).

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

When the row was last modified (ISO 8601).

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$