Notify product changes for a customer

This endpoint is called by Integration Hub to notify downstream banking provider systems about product changes that occurred in the Wallet system. The endpoint should be implemented by third-party banking providers to receive and process product change notifications.

When this endpoint is called, it indicates that products associated with a customer have been modified in the Wallet system and need to be synchronized in the banking provider's system. The notification can contain:

  • Products to upsert: A list of products that should be created if they don't exist, or updated if they already exist in the provider's system. Each product contains complete information including account details, balances, status, and metadata.

  • Products to delete: A list of product IDs that should be removed from the provider's system. These are products that have been deleted or deactivated in the Wallet and should no longer be accessible.

The provider system receiving this notification should:

  1. Validate that the customerId corresponds to an existing customer in their system
  2. Process all product upserts by creating new products or updating existing ones based on the product ID
  3. Process all product deletions by removing or deactivating the specified products
  4. Return a successful response (HTTP 200) if all operations completed successfully
  5. Return an error response (HTTP 400/404) if validation fails or operations cannot be completed

The endpoint is idempotent - calling it multiple times with the same data should produce the same result. Product upserts should use the product ID as the unique identifier to determine whether to create or update.

This is a critical synchronization point to ensure consistency between Toqio and the integration products catalog for each customer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the customer in the banking provider's system. This ID must correspond to an existing customer record. All product changes in the request will be associated with this customer.

Body Params

The product change notification containing products to create/update (upsert) and/or product IDs to delete. At least one of the arrays (products or deleteProductIds) should be provided, though both can be included in a single request.

products
array of objects

List of products to create or update (upsert). Each product in this array should be processed idempotently - if a product with the given ID already exists in the connector, it should be updated; if it doesn't exist, it should be created. This array can be null or empty if there are only deletions to process.

products
deleteProductIds
array of strings

List of product IDs to delete from the connector. The connector should remove these products or mark them as inactive. These are product IDs that were previously sent in the 'products' array but should now be deleted. This array can be null or empty if there are only upserts to process.

deleteProductIds
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json