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 in the Sage Partner API (PAPI). This endpoint is the primary method to register banks in both Sandbox (SBX) and Production (PROD) environments.

Key Endpoint: POST /banks

Sandbox (SBX)

  • Use POST /banks to create test banks for development and testing purposes.

Production (PROD)

  • Use POST /banks to submit banks for production beta enrollment.
  • Provide the following fields to your enablement engineer to enable the bank in production (pending PM approval):
    • BankName: The name of the connection (e.g., “Adele’s Bank (Powered by Sage)”).
    • principal_id: Your Sage-assigned BankID (UUID).
    • external_reference: Also known as AggregatorId (UUID) for tracking.

Once submitted, the request will be escalated internally, and if approved the connection will be visible in the product.

POST /banks

Connector APIBanking Service -> Provider

The /banks endpoint allows you to push bank documents into the Banking Service. Use this endpoint to manage bank registrations, updates, and removals.

The following fields are supported in the request body:

Field Description
toCreate Array of objects to create new banks. Refer to the API specification for details.
toUpdate Array of objects to update existing banks. Refer to the API specification for details.
toRemove Array of objects to remove banks. Refer to the API specification for details.

For detailed field descriptions and examples, refer to the API specification and the Postman collection.

</div>

Storing and Using principalID and externalRef

Creating a New Bank

  1. POST /banks:
    • Send a request with the bank details.
    • Store the principalID from the response.
    • Store the externalRef provided by the aggregator.

Updating an Existing Bank

  1. GET /banks:
    • Retrieve the _id (used as principalID).
  2. PUT /banks/{principalID}:
    • Send a request with updated details and the externalRef (aggregator ID).

Additional Notes

  • Postman Collection: Use the PAPI Postman collection provided to test /banks calls in SBX, including toCreate, toUpdate, and toRemove. Postman Collection Link
  • Deleting Banks: Use toRemove only in SBX. This option is not available in PROD. Contact support if you need to remove any connections.
  • Storage: For each bank created, store the principalID and externalRef on your end.

What’s Next?

After completing your sandbox testing, you are ready to move into production. Learn how to upgrade to beta in Stage 4: Go Live and Support.

Was this helpful?