Testing with Postman
A ready-made Postman collection lets your integration engineers exercise the Lyriq Connector API end to end without writing any code. Every request in the collection is a real API call against a running Lyriq Connector; nothing is mocked or stubbed.
What you can do with it
Running the collection top to bottom walks the full lifecycle of an interbank position between two banks: Bank Alpha (the issuer) and Bank Beta (the holder). In one pass it demonstrates:
- Connectivity and tokens. A health check, then federated FIS assertion exchange for Alpha's maker/read-only and checker workloads. Demo-only fixtures still obtain operator and Gamma tokens directly.
- Bootstrap verification. Reads that confirm accounts, the bilateral holding account, and the configured issuance and exposure limits all exist before any value moves.
- The maker/checker (four-eyes) flow. A maker submits an interbank transfer, a separate checker approves it, and only then does it commit. The transfer is processed as an asynchronous operation that you poll to a terminal state.
- Reconciliation from both sides. Before-and-after reads of balances, exposures, and liabilities so the same movement reconciles on the issuer and holder sides.
- Redemption and automatic settlement. A redemption that reserves the holding immediately, followed by the platform-driven settlement cycle that cash-confirms and closes on its own.
- Negative tests. Requests that are expected to fail (an over-exposure transfer, spending a reserved holding, and a double redemption). Their test scripts go green on a rejection, proving the controls are enforced by the ledger and not merely by a cooperating client.
Download
Download the Postman archive (.zip)
The archive contains the collection and the hosted-demo environment:
| File | Purpose |
|---|---|
keystone-demo.postman_collection.json | The collection: every request, with test scripts. |
keystone-demo.postman_environment.json | Points at the shared hosted demo, with its demo credentials. |
Local and blank template environments are available in the source repository
under shared/postman/connector-edge/; they are intentionally not published in
the downloadable archive.
Configuration and credentials live in the environment, not the collection, so the collection can be shared while each engineer keeps their own credentials.
How to run it
- In Postman, choose Import and select the collection file and at least one environment file from the archive.
- Select an environment from the environment dropdown in the top right. Use the Dev or Local environment to run against the demo as-is, or fill in the Template environment to target your own deployment.
- Run the 2. Get API Tokens folder first. Each request stores a per-role
bearer token; re-run the folder if you start seeing
401responses, since tokens expire. - Send the remaining requests top to bottom, or use the Postman Collection Runner. Later steps consume IDs captured by earlier steps, and the polling steps ("re-send until ...") assert a target state, so a failing assertion there just means "not there yet; send again."
The Alpha FIS assertion requests use the disposable simulator's shared secret
and are restricted to sandbox environments. They never send a Keycloak client
secret. In production, the workload authenticates to FIS with a bank-controlled
asymmetric assertion and exchanges the returned FIS assertion with
services/bank-connector/deploy/keycloak/get-token.sh; do not use the Postman
simulator requests as a production authentication flow.