Fidel API for AI agents
Agents read Fidel API at once. Changes and sends are held for a person's approval by default.
About Fidel API
Fidel API provides a developer-friendly, secure, and reliable API for businesses to link payment cards with mobile and web applications, enabling real-time transaction monitoring and event-based experiences.
What an agent can do in Fidel API
Every Fidel API action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Fidel API without asking first. 22 actions.
- Get BrandTool to retrieve information about a specific brand. Use when you have a brand ID and need its details.
- Get LocationTool to retrieve details of a specific location by its ID. Use when you have a location ID and need its full details.
- Get MIDTool to retrieve details of a specific MID (Merchant ID). Use when you have a program ID and MID ID to get full MID details.
- Get OfferRetrieves detailed information about a specific offer by its unique ID. Use this tool when you need to: - Get full details about a known offer (reward type, value, dates, etc.) - Verify offer status (
- Get ProgramTool to retrieve details of a specific program. Use when you have a program ID and need its full details.
- 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 metada
- 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
- 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
- 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
- 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 partici
- List LocationsTool to list all locations for a program. Use when you need to retrieve paginated store locations within a specific program.
- 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.
Show all 22
- List Locations by OfferTool to list all locations linked to a specific offer. Use when you need to retrieve locations where an offer is valid or active.
- 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.
- 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
- 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
- List Program WebhooksTool to list all registered webhooks for a specific program. Use when you need to retrieve existing webhooks after confirming the programId.
- List TransactionsList transactions for a Fidel program with optional filtering and pagination. Use this tool to retrieve card-linked transaction data for loyalty, rewards, or analytics purposes. Requires a valid progr
- Get MID RequestTool to retrieve details of a specific MID request. Use when you have a program ID and MID request ID and need to check the status or details of a Merchant ID request.
- 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
- 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' parame
- 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.
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 17 actions.
- 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
- 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,
- 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.
- 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
- 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 b
- 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.
- 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.
- Delete OfferTool to delete a specified offer by its ID. Use after confirming the correct offer ID.
- 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
- 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.
- Link Location to OfferLink a location to an offer in Fidel API. Use this action to associate a specific location with an offer, making the offer available at that location. Once linked, transactions at the location will be
- 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.
Show all 17
- Update BrandUpdate an existing brand's details in Fidel API. Use this to modify websiteURL, logoURL, or metadata for a brand. The brand name cannot be changed after creation. Requires a valid brand ID from get_br
- Update OfferUpdates specific properties of an existing offer. Use this when you need to modify offer details such as name, dates, transaction amounts, terms, or metadata. At least one field must be provided to up
- 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 pr
- 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.
- 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.
Changes wait in Needs you
Changes and sends in Fidel API are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Fidel API questions
Can an agent change data in Fidel API on its own?
Not by default. Changes and sends in Fidel API are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Fidel API?
This connector lists 22 read actions. Reads run at once, without waiting for approval.
How does Fidel API connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.