Two Limits API (1.0)

Download OpenAPI specification:Download

Overview and usage

This API allows you to retrieve the credit limit of your buyers.

To be specific, you can lookup credit limit for your buyers using organization number or canonical ID which you can obtain via our Company API.

Environments

Limits

Retrieve company credit limit

Retrieve buyer company credit limit based on buyer country code and organization number.

SecurityX-Api-Key
Request
path Parameters
buyer_country_code
required
string

Buyer country code

buyer_organization_number
required
string

Buyer organization number

Responses
200

Credit limits

403

Access denied

404

Buyer company not found

default

Error response

get/limits/v1/company/{buyer_country_code}/{buyer_organization_number}
Request samples
Response samples
application/json
{
  • "decision": {
    },
  • "credit": {
    },
  • "recourse": null,
  • "buyer_company_name": "string",
  • "company_number": "string",
  • "country_code": "AT",
  • "currency": "NOK"
}

Retrieve company credit limit by canonical ID

Retrieve buyer company credit limit based on company canonical ID. This is a unique ID that represents a company on our system and can be obtained using our Company API.

SecurityX-Api-Key
Request
path Parameters
buyer_company_canonical_id
required
string

Buyer company canonical ID

Responses
200

Credit limits

403

Access denied

404

Buyer company not found

default

Error response

get/limits/v1/company/{buyer_company_canonical_id}
Request samples
Response samples
application/json
{
  • "decision": {
    },
  • "credit": {
    },
  • "recourse": null,
  • "buyer_company_name": "string",
  • "company_number": "string",
  • "country_code": "AT",
  • "currency": "NOK"
}