Skip to main content
GET
Retrieve a credit facility
Use this endpoint to retrieve the current state of a buyer’s active credit facility. The response tells you the total approved credit limit, how much is currently available to use, how much is already committed to outstanding orders and invoices, and when the facility expires. This is useful for gating checkout flows – check the buyer’s available credit before authorizing an order to prevent requests that would exceed the facility limit.
Before creating an order for a buyer, compare the order total against available_amount. This prevents order authorization failures caused by insufficient credit. Amounts are in the smallest currency unit – divide by 100 to convert cents to euros.
This endpoint returns a 404 if the buyer has no credit facility – either because one was never requested, or because the request was rejected. Use Create facility to request one.

Authorizations

Authorization
string
header
required

Your Tilta API key, sent as Bearer <key>.

Path Parameters

external_id
string
required

Unique identifier of a buyer.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$

Response

Active facility of the buyer.

buyer_external_id
string
required

Unique identifier for buyer.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
Example:

"5f6374a46a5e8e0104aa5cd4"

pending_orders_amount
integer
required

Blocked by pending deferred orders portion of the Credit Limit. As minimum currency unit (e.g cents/pence).

Example:

2500

risk_band
enum<string>
required
Available options:
REJECT,
A1,
A2,
B1,
B2,
C1,
C2,
D1,
D2
created_at
number
required

Timestamp indicating when the facility was created (unix time in seconds).

Example:

1582896122

updated_at
number
required

Timestamp indicating the last time the facility was updated (unix time in seconds).

Example:

1582896122

pending_actions
object[] | null
required

List of pending actions for the facility.

status
enum<string>
required

Status of the Active facility

Available options:
ACTIVE,
PENDING,
FROZEN,
EXPIRED
Example:

"ACTIVE"

reviewed_at
number | null
required

Review Date of the Active facility

currency
enum<string>
required

ISO 4217 three-letter currency code.

Available options:
EUR,
GBP,
USD,
CHF,
PLN,
CZK,
RON,
BGN,
DKK,
HUF,
SEK,
NOK,
JPY,
AUD,
NZD,
CAD
total_amount
integer
required

Total credit limit available to the Buyer. As minimum currency unit (e.g cents/pence).

Example:

10000

available_amount
integer
required

Available portion of the Credit Limit. As minimum currency unit (e.g cents/pence).

Example:

5200

used_amount
integer
required

Credit Limit portion currently in use (not repaid). As minimum currency unit (e.g cents/pence).

Example:

4800