- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 39
- Triggers: 0
- Slug:
FIDEL_API - Version: 20261101_00
Tools
Create Brand
Create Brand
FIDEL_API_CREATE_BRANDCreate a new brand in Fidel API. Use this action to register a brand with a unique name. Brands are independent of Programs and can be reused between different programs. Once created, the brand can be associated with locations and offers. Returns the created brand object with its unique ID and timestamps.Input Parameters
Output
Create Brand Webhook
Create Brand Webhook
FIDEL_API_CREATE_BRAND_WEBHOOKTool to create a webhook at the brand level for receiving real-time event notifications. Use when you need to be notified of brand-related events, such as when brand consent is approved. In test mode, the webhook triggers immediately after creating a brand; in live mode, it triggers when the brand user approves the consent request.Input Parameters
Output
Create Location
Create Location
FIDEL_API_CREATE_LOCATIONCreate a new location for a program in Fidel API. Use when you need to add a physical store or merchant location to track card transactions at that specific address.Input Parameters
Output
Create MID Request
Create MID Request
FIDEL_API_CREATE_MID_REQUESTTool to create a new MID (Merchant ID) request for a specific program and location. Use when you need to onboard a new MID or reassign an existing MID to a location.Input Parameters
Output
Create Offer
Create Offer
FIDEL_API_CREATE_OFFERCreate a new offer in Fidel API. Use this to set up promotional offers with reward configurations (fixed amount or percentage discount) for specific brands and countries. The offer will be associated with your publisher account and can be activated by customers.Input Parameters
Output
Create Program
Create Program
FIDEL_API_CREATE_PROGRAMCreates a new card-linked loyalty program in Fidel. A Program is the parent object for tracking card transactions - all Cards, Locations, Webhooks, and Transactions are linked to a Program. Use this before adding cards or locations.Input Parameters
Output
Create Program Webhook
Create Program Webhook
FIDEL_API_CREATE_PROGRAM_WEBHOOKTool to register a new webhook for program-related events. Use when you need to receive real-time notifications for specific program events in your application.Input Parameters
Output
Delete Location
Delete Location
FIDEL_API_DELETE_LOCATIONTool to delete a location by its ID. Use after confirming the correct location ID. The operation is idempotent - deleting an already-deleted location returns success.Input Parameters
Output
Delete Offer
Delete Offer
FIDEL_API_DELETE_OFFERDeletes a specified offer by ID. Only self-sourced offers created by publishers can be deleted; content provider and Fidel Marketplace offers cannot be deleted.Input Parameters
Output
Delete Program Webhook
Delete Program Webhook
FIDEL_API_DELETE_PROGRAM_WEBHOOKPermanently deletes a webhook by its ID. This is a destructive operation that cannot be undone. The webhook will immediately stop receiving event notifications. Use List Program Webhooks first to get the webhook ID if needed.Input Parameters
Output
Get Brand
Get Brand
Get Location
Get Location
Get MID
Get MID
Get MID Request
Get MID Request
Get Offer
Get Offer
Get Program
Get Program
Get Transaction
Get Transaction
FIDEL_API_GET_TRANSACTIONTool to retrieve details of a specific transaction by its ID. Use when you need to get complete information about a card-linked transaction including amount, currency, timestamp, and associated metadata.Input Parameters
Output
Get Webhook
Get Webhook
FIDEL_API_GET_WEBHOOKRetrieve details of a specific webhook by its unique identifier. Use this tool when you need to inspect webhook configuration, verify its URL, check the subscribed event type, or obtain the secret key for signature verification.Input Parameters
Output
Link All Program Locations to Offer
Link All Program Locations to Offer
FIDEL_API_LINK_ALL_PROGRAM_LOCATIONS_TO_OFFERTool to link all brand locations in a program to an offer. Use when you need to associate all locations from a specific program with an offer, making the offer available at all those brand locations.Input Parameters
Output
Link Location to Offer
Link Location to Offer
FIDEL_API_LINK_LOCATION_TO_OFFERLink a specific location to an offer in Fidel API, making the offer available at that location. Transactions must still satisfy the offer’s eligibility conditions to qualify for rewards.Input Parameters
Output
List Brands
List Brands
FIDEL_API_LIST_BRANDSRetrieves a paginated list of all brands associated with your Fidel API account. Use this tool to: - Get an overview of all brands in your account - Retrieve brand IDs for use in other operations (e.g., getting locations, creating offers) - Paginate through large sets of brands using the cursor-based pagination Returns brand details including name, ID, consent status, and live/test mode indicator.Input Parameters
Output
List Cards
List Cards
FIDEL_API_LIST_CARDSList all payment cards linked to a Fidel program. Returns card details including scheme (visa/mastercard/amex), last 4 digits, expiry date, and country. Use this to view which cards are enrolled in a loyalty/rewards program. Requires a valid programId - use list_programs first if you don’t have one.Input Parameters
Output
List Cards By Metadata
List Cards By Metadata
FIDEL_API_LIST_CARDS_BY_METADATATool to list payment cards filtered by metadata ID. Use when you need to retrieve all cards that share a specific metadata identifier. Returns card details including scheme, last 4 digits, expiry date, and country. Useful for segmenting cards by custom tags or user groups.Input Parameters
Output
List Cards with Active Offer
List Cards with Active Offer
FIDEL_API_LIST_CARDS_WITH_ACTIVE_OFFERList all payment cards that have activated a specific offer. Returns card details for cards enrolled in the offer, including activation status and timestamps. Use this to track which cards are participating in a specific loyalty offer. Requires a valid offerId - use list_offers first if you don’t have one.Input Parameters
Output
List Locations
List Locations
List Locations by Brand
List Locations by Brand
FIDEL_API_LIST_LOCATIONS_BY_BRANDTool to list all locations for a specific brand within a program. Use when you need to retrieve locations filtered by both brand and program IDs with optional pagination, status, and postcode filters.Input Parameters
Output
List Locations by Offer
List Locations by Offer
List MID Requests
List MID Requests
FIDEL_API_LIST_MID_REQUESTSList all MID (Merchant ID) requests for a specific program. Use when you need to retrieve MID requests associated with a program for card-linking operations. Supports pagination via the ‘start’ parameter using cursors from previous responses.Input Parameters
Output
List MIDs
List MIDs
FIDEL_API_LIST_MIDSTool to list all MIDs (Merchant IDs) for a program. Use when you need to retrieve merchant IDs associated with a specific program for transaction tracking or location management.Input Parameters
Output
List Missing Transaction Requests
List Missing Transaction Requests
FIDEL_API_LIST_MISSING_TRANSACTION_REQUESTSTool to list all missing transaction requests for a specific program. Use when you need to retrieve reports of transactions that were expected but not recorded in the system.Input Parameters
Output
List Offers
List Offers
FIDEL_API_LIST_OFFERSList all offers in the Fidel API. Retrieves offers associated with the account, optionally filtered by brand. Returns offer details including type (amount/discount), validity period, card schemes, and activation settings.Input Parameters
Output
List Programs
List Programs
FIDEL_API_LIST_PROGRAMSList all Fidel programs in your account. Use this to retrieve programs for card-linking, loyalty, or reward systems. Supports pagination via the ‘start’ parameter using cursors from previous responses. Returns program details including name, type, status, and sync state.Input Parameters
Output
List Program Webhooks
List Program Webhooks
List Transactions
List Transactions
FIDEL_API_LIST_TRANSACTIONSList card-linked transactions for a Fidel program with pagination and optional creation-date ordering. Use this to retrieve transaction data for loyalty, rewards, or analytics.Input Parameters
Output
Unlink Location From Offer
Unlink Location From Offer
FIDEL_API_UNLINK_LOCATION_FROM_OFFERTool to unlink a location from an offer by removing the location association. Use after confirming the correct offer ID and location ID.Input Parameters
Output
Update Brand
Update Brand
Update Offer
Update Offer
FIDEL_API_UPDATE_OFFERUpdates specified properties of an existing offer, such as its name, dates, transaction amounts, terms, or metadata. At least one field must be provided; the response contains selected updated offer properties.Input Parameters
Output
Update Program
Update Program
FIDEL_API_UPDATE_PROGRAMUpdates a Fidel API program’s properties. Can modify name (4-50 chars), icon (emoji in :name: format), iconBackground (HEX color), metadata (key/value pairs, max 2KB), or status (‘syncing’ for live programs only). Requires a valid program ID obtained from list_programs or create_program.Input Parameters
Output
Update Webhook
Update Webhook
FIDEL_API_UPDATE_WEBHOOKTool to update an existing webhook’s configuration. Use when you need to change the webhook URL or event type. The event field is required even when updating.