Skip to content
Developerhome
Product homepage
Banking Service

Posting Banks

  Less than to read

Flow diagram displaying the bank sync user flow

Overview

To register a third-party financial institution with Sage’s Banking Service, use the POST /banks endpoint from the Sage Partner API (PAPI). This endpoint allows you to create, update, or remove banks in both Sandbox (SBX) and Production (PROD) environments.

Environments

Sandbox (SBX)

Use POST /banks to:

  • Create and test dummy banks for integration development.
  • Simulate full bank sync and connectivity flows.

Production (PROD)

Use POST /banks to:

  • Submit banks for production beta onboarding.
  • Enable banks in the Sage product (PM approval required).

To enable a bank in production, submit the following details to your Enablement Engineer:

  • BankName – Name as it should appear to end users (e.g., “Adele’s Bank (Powered by Sage)”).
  • principal_id – Sage-assigned Bank ID (UUID).
  • external_reference – Aggregator ID (UUID), used for internal tracking.

Approved connections will become visible in the production environment.

API Details: POST /banks

Connector APIBanking Service → Provider

The /banks endpoint manages bank lifecycle actions, supporting the following fields in the request body:

Field Purpose
toCreate Array of new bank objects to register.
toUpdate Array of existing bank objects to update.
toRemove Array of bank objects to remove (SBX only).

🔗 See the full API reference and Postman collection for sample payloads and schema.

Managing Identifiers

When Creating a Bank

  1. POST /banks
    • Submit bank details via toCreate.
    • Store the returned principalID (Sage Bank ID).
    • Associate with the externalRef provided by your aggregator.

When Updating a Bank

  1. GET /banks
    • Retrieve the current _id (used as principalID).
  2. PUT /banks/{principalID}
    • Send updated bank details and externalRef.

Additional Notes

  • SBX Only: Use toRemove to delete test banks. Deletion in production is not permitted—contact support if needed.
  • Storage: Always store both the principalID and externalRef for future updates and tracking.
  • Testing: Use the Postman collection for testing all /banks operations in SBX.

What’s Next?

After testing your integration in SBX, proceed to production onboarding. See Stage 4: Go Live and Support for next steps.

Was this helpful?