KKonsol Developers

Identifiers

Konsol ids

Every record has a Konsol id, a UUID. Paths use it: /integration/v1/companies/{id}.

Your external references

Enterprises, companies, tradings and acquirers also take your own external_ref, which is unique among your live records. Set it when you create the record, so you can find it later by your own reference:

GET /integration/v1/companies?external_ref=HQ-C-1001

On an enterprise, company or trading you can set external_ref once. On an acquirer you can change or clear it.

Most bodies and filters that refer to one of these records take either <name>_id or <name>_external_ref, never both. For example, a trading's company is company_id or company_external_ref. The transaction list is an exception: it takes trading_id only.

Product codes

Each product has a code that never changes. A product object calls it code. Paths, filters, request bodies and other records call it product_code. List the products with GET /integration/v1/products.

On this page