Postman Collections

The Candescent OpenAPI repository publishes Postman collections for external integrators alongside the Candescent DI API OpenAPI specification. Use these collections to explore, test, and validate Digital Banking API operations from Postman without writing custom HTTP clients first.

Who Should Use the Collections

These collections are for external users only: Marketplace Partners, fintechs, and FI developers integrating with Candescent on behalf of one or more financial institutions (FIs).

Postman collections are available for selected API areas today. Additional collections will be published in upcoming releases as they become ready for external integrators.

Environments

Environment files name the Apigee tier in the filename:

Suffix	Tier	When to use
-sbx	Sandbox	Early integration testing and exploration
-stg	Stage	Development, integration testing, and FI validation
-prd	Production	Production certification (restricted access)

Start with Sandbox or Stage unless your integration PM directs you to Production.

Quick Start

Prerequisites

• A Postman account and workspace
• A Developer Console application with Shared Key (client_id) and Secret Key (client_secret)
• FI-provided values for institution, user, and customer identifiers

1. Get the collection files

Browse Postman Collections in the private OpenAPI repository and obtain the *.postman_collection.json and *.postman_environment.json files for the API areas you need.

Common starting points:

API area	Folder
Authentication	postman-collection/Authentication/OAuth V2/
Accounts	postman-collection/Core Banking/Accounts/
Transactions	postman-collection/Core Banking/Transactions/

2. Import a collection and environment

1. Create or select a Postman workspace.
2. Import the *.postman_collection.json file for your API category.
3. Import the matching environment from that collection’s environment/ folder (start with -sbx or -stg).
4. Set the imported environment as active.

Import a matching environment for every collection you use.

3. Configure environment variables

In the active environment, set every relevant variable that appears before access_token. Leave access_token blank until you run an Authentication request.

Important: FI-provided values

All environment variables listed before access_token must come from the FI associated with your application. This includes apigee_base_url, institution identifiers, and test user or customer credentials. Your FI integration contact or Candescent Integration PM provides these values for each tier.

Typical required values:

Variable	Source
apigee_base_url	FI / Candescent: gateway base URL for the target tier
client_id	Developer Console: Shared Key
client_secret	Developer Console: Secret Key
institution_id	FI: institution identifier
User / customer IDs	FI: test retail or business user identifiers as needed

4. Obtain an access token

1. Select your Sandbox (-sbx) or Stage (-stg) environment.
2. Open the Authentication - OAuth V2 collection.
3. For client credentials, run Generate Access Token under Retail User → Access Token → Client Credential (or the equivalent for your user type).
4. Confirm access_token is stored in your environment (collection test scripts set this automatically).

For password-grant testing, set FI-provided user credentials and run the Password token request instead. See Create OAuth Token (V2) for grant types and request fields.

5. Run an API request

1. Open an API collection (for example Accounts).
2. Choose a read-only request such as List Accounts. See the List Accounts API reference for request parameters and response details.
3. Confirm the request uses Authorization: Bearer {{access_token}} and the required headers.
4. Send the request.

A 200 response confirms your credentials, FI-provided variables, and token flow are configured correctly.

Many collections expect this order: Authentication → discovery/setup requests (to capture IDs) → API operations under test.

Full Guide

For detailed installation steps, environment variable lists, and troubleshooting, see the guide in the private OpenAPI repository:

Candescent API Postman Collections: Postman Guide

Related Resources

Resource	Description
Candescent DI API	Full REST API reference
Quick Start	Obtain API credentials and your first access token
Developer Console overview	Create applications and generate Shared Key / Secret Key
Create OAuth Token (V2)	Token endpoint reference used by Authentication collections