curl --request GET \
--url https://api.interchange.io/api/v2/buyer/credit-applications/v2 \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/credit-applications/v2"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/credit-applications/v2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "42",
"customerId": 0,
"customerName": "<string>",
"requestedCreditLimit": 0,
"requestedPaymentTerms": "net_15",
"currency": "<string>",
"status": "PENDING",
"justification": "<string>",
"grantedCreditLimit": 0,
"grantedPaymentTerms": "net_15",
"acceptedBy": "<string>",
"acceptedAt": "2023-11-07T05:31:56Z",
"reviewedBy": "<string>",
"reviewerName": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewerNotes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}List payment-term requests
List the authenticated organization’s credit and payment-term request history, newest first.
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/credit-applications/v2 \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/credit-applications/v2"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/credit-applications/v2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "42",
"customerId": 0,
"customerName": "<string>",
"requestedCreditLimit": 0,
"requestedPaymentTerms": "net_15",
"currency": "<string>",
"status": "PENDING",
"justification": "<string>",
"grantedCreditLimit": 0,
"grantedPaymentTerms": "net_15",
"acceptedBy": "<string>",
"acceptedAt": "2023-11-07T05:31:56Z",
"reviewedBy": "<string>",
"reviewerName": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewerNotes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Response
List payment-term requests
Surrogate id of the application row (BIGINT serialized as string).
"42"
Credit-bearing customer the application is for (PARENT or STANDALONE).
-9007199254740991 <= x <= 9007199254740991Display 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.
Requested limit in currency minor units.
-9007199254740991 <= x <= 9007199254740991Post-pay terms requested by the buyer. Null only for applications created before payment terms were collected.
net_15, net_30, net_45, net_60, net_90 ISO 4217 currency of the limits on this application.
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.
PENDING, COUNTEROFFERED, APPROVED, REJECTED, WITHDRAWN Free-text context supplied on submit. Null when not given.
Limit granted on approval or proposed in a counteroffer, in currency minor units. Null until review.
-9007199254740991 <= x <= 9007199254740991Terms granted on approval or proposed in a counteroffer. Null until review.
net_15, net_30, net_45, net_60, net_90 Buyer user id that explicitly accepted a counteroffer. Null for direct approvals and service-token acceptances; acceptedAt still records service-token acceptance.
When the buyer accepted a counteroffer. Null when no acceptance was required.
^(?:(?:\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))$User id of the superadmin who decided (BIGINT serialized as string). Null while pending.
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.
When the decision was recorded (ISO 8601). Null while pending.
^(?:(?:\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))$Superadmin note attached to the decision. Null while pending.
When the application was submitted (ISO 8601).
^(?:(?:\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))$When the row was last modified (ISO 8601).
^(?:(?:\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))$