39 available actions
What your AI agent can do in 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. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 39 actions.
Common starting points
- Get BrandTool to retrieve information about a specific brand.
- Get LocationTool to retrieve details of a specific location by its ID.
- Create BrandCreate a new brand in Fidel API.
- Create LocationCreate a new location for a program in Fidel API.
- Update BrandUpdate an existing brand's details in Fidel API.
- Update OfferUpdates specific properties of an existing offer.
Browse all 39 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 22 actions
- Get BrandTool to retrieve information about a specific brand.
- Get LocationTool to retrieve details of a specific location by its ID.
- Get MIDTool to retrieve details of a specific MID (Merchant ID).
- Get MID RequestTool to retrieve details of a specific MID request.
- Get OfferRetrieves detailed information about a specific offer by its unique ID.
- Get ProgramTool to retrieve details of a specific program.
- Get TransactionTool to retrieve details of a specific transaction by its ID.
- Get WebhookRetrieve details of a specific webhook by its unique identifier.
- List BrandsRetrieves a paginated list of all brands associated with your Fidel API account.
- List CardsList all payment cards linked to a Fidel program.
- List Cards By MetadataTool to list payment cards filtered by metadata ID.
- List Cards with Active OfferList all payment cards that have activated a specific offer.
- List LocationsTool to list all locations for a program.
- List Locations by BrandTool to list all locations for a specific brand within a program.
- List Locations by OfferTool to list all locations linked to a specific offer.
- List MID RequestsList all MID (Merchant ID) requests for a specific program.
- List MIDsTool to list all MIDs (Merchant IDs) for a program.
- List Missing Transaction RequestsTool to list all missing transaction requests for a specific program.
- List OffersList all offers in the Fidel API.
- List ProgramsList all Fidel programs in your account.
- List Program WebhooksTool to list all registered webhooks for a specific program.
- List TransactionsList transactions for a Fidel program with optional filtering and pagination.
Create & communicateCreate records or send supported messagesView 7 actions
- Create BrandCreate a new brand in Fidel API.
- Create Brand WebhookTool to create a webhook at the brand level for receiving real-time event notifications.
- Create LocationCreate a new location for a program in Fidel API.
- Create MID RequestTool to create a new MID (Merchant ID) request for a specific program and location.
- Create OfferCreate a new offer in Fidel API.
- Create ProgramCreates a new card-linked loyalty program in Fidel.
- Create Program WebhookTool to register a new webhook for program-related events.
Update & manageChange and manage existing recordsView 4 actions
- Update BrandUpdate an existing brand's details in Fidel API.
- Update OfferUpdates specific properties of an existing offer.
- Update ProgramUpdates a Fidel API program's properties.
- Update WebhookTool to update an existing webhook's configuration.
Remove & cancelRemove records or cancel supported workView 3 actions
- Delete LocationTool to delete a location by its ID.
- Delete OfferTool to delete a specified offer by its ID.
- Delete Program WebhookPermanently deletes a webhook by its ID.
Other actionsSpecialist and administrative actions.View 3 actions
- Link All Program Locations to OfferTool to link all brand locations in a program to an offer.
- Link Location to OfferLink a location to an offer in Fidel API.
- Unlink Location From OfferTool to unlink a location from an offer by removing the location association.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Fidel API
How does the agent connect to Fidel API?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Fidel API?
The page above lists the 39 actions currently available through the Fidel API connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Fidel API included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Fidel API is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Fidel API to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.