Integration guide
Authentication, environments, identifiers, balances, reservations, retries, errors, and complete workflows.
Read the guide →Official external API · V1
Build reliable credit integrations with confidence.
The approved server-to-server contract for Thales Credit Core. Start with the mental model and Quick start, then use the generated reference for exact schemas, scopes, status codes, and examples.
Test availableServer-to-server onlyProduction not provisioned
Fastest path to a working integration
Get from zero to your first Test request
You do not need repository access. Follow these four steps with synthetic Test data and an environment-specific key.
01
Request a Test key
Use the approved API-client owner or platform process.
02
Store it server-side
Keep the key in a secret manager; never expose it in browser code.
03
Run a read-only lookup
Start with the exact customer lookup shown in Quick start.
04
Test a mutation
Use synthetic data, scopes, and a stable idempotency key.
Choose your path
The documentation host is separate from the API host. The API servers below are the systems that receive authenticated requests.
API reference
All 13 approved V1 operations with searchable paths, operation IDs, parameters, examples, scopes, and error responses.
Browse the reference →OpenAPI contract
Download the generated OpenAPI 3.1 artifact used for client generation and contract validation.
Download YAML →Environments
Use the correct host and key
Test and Production credentials are separate. Test is available for integration work. Production has not been provisioned or approved; the reference marks that URL as a configuration placeholder.
Documentation host
thales-credit-core-api-docs.pages.devTest API host
thales-credit-core-test.hamed-saffarian.workers.devProduction API host
Pending approved provisioningPublic V1 boundary
This site publishes the approved external HTTP API contract and the Test-only outbound Webhook receiver contract.
Published
- Customers and exact identity lookup
- Account summary and transaction read
- Credit, debit, and reversal
- Reservation create, read, capture, release, and extend
- Reward program read and governed reward issuance through
POST /v1/credits - Webhook envelope, signatures, event types, retries, and receiver rules
Not published
- Admin or UI/reference routes
- Test-only or spike routes
- CSV import routes
- Incomplete account-history routes
- Inbound Credit Core webhook routes, Production endpoints, or credentials