Fidel API

39 tools available

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.

payment processing developer tools

Connect Fidel API Visit Fidel API ↗

Connect Fidel API to Definable to recover failed charges, triage refunds against policy, detect churn signals. Personas call Fidel API's 39 tools directly from chat or scheduled flows. Hook to a finance or growth persona — react to revenue events the moment they happen.

Common workflows with Fidel API

Failed charge recovery

Webhook on failed payment
Persona pulls customer context
Drafts a recovery message

Refund triage

Refund request arrives
Agent checks policy + history
Approves or routes for human review

Subscription churn detection

Pull cancellations
Identify common reasons
Trigger a save-flow

Fidel API actions 39

Every Fidel API action below is a callable tool any Definable persona can invoke.

Create Brand

Create 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.

Create Brand Webhook

Tool 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.

Create Location

Create 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 MID Request

Tool 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.

Create Offer

Create 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.

Create Program

Creates 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.

Create Program Webhook

Tool 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 Location

Tool 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 Offer

Tool to delete a specified offer by its ID. Use after confirming the correct offer ID.

Delete Program Webhook

Permanently 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.

Get Brand

Tool to retrieve information about a specific brand. Use when you have a brand ID and need its details.

Get Location

Tool to retrieve details of a specific location by its ID. Use when you have a location ID and need its full details.

Get MID

Tool 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 MID Request

Tool 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.

Get Offer

Retrieves 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 (active, expired, requests) - Check offer configuration (schemes, days of week, transaction limits) - View brand and location information for an offer Returns comprehensive offer details including reward configuration, eligibility criteria, and metadata.

Get Program

Tool to retrieve details of a specific program. Use when you have a program ID and need its full details.

Get Transaction

Tool 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.

Get Webhook

Retrieve 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.

Link All Program Locations to Offer

Tool 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 Offer

Link 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 eligible for the offer's rewards.

List Brands

Retrieves 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.

List Cards

List 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.

List Cards By Metadata

Tool 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.

List Cards with Active Offer

List 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.

List Locations

Tool to list all locations for a program. Use when you need to retrieve paginated store locations within a specific program.

List Locations by Brand

Tool 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.

List Locations by Offer

Tool to list all locations linked to a specific offer. Use when you need to retrieve locations where an offer is valid or active.

List MID Requests

List 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.

List MIDs

Tool 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 Missing Transaction Requests

Tool 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.

List Offers

List 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.

List Programs

List 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.

List Program Webhooks

Tool to list all registered webhooks for a specific program. Use when you need to retrieve existing webhooks after confirming the programId.

List Transactions

List 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 programId.

Unlink Location From Offer

Tool to unlink a location from an offer by removing the location association. Use after confirming the correct offer ID and location ID.

Update Brand

Update 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_brand or list_brands.

Update Offer

Updates 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 update. Returns the complete updated offer object with all current properties.

Update Program

Updates 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.

Update Webhook

Tool 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.

Frequently asked questions

What can I automate with Fidel API on Definable?

Anything Fidel API exposes through its API. Common payment processing workflows on Definable include recover failed charges, triage refunds against policy, detect churn signals. Personas can call any of the 39 Fidel API tools directly, then chain the result into another integration without you writing code.

How does Fidel API authentication work?

Fidel API uses API_KEY on Definable. You connect once from the integrations page, scoped to the permissions you choose, and from then on any persona that has the integration enabled can act on your behalf. Tokens are encrypted at rest and rotated automatically.

Is the Fidel API integration included in my Definable plan?

Yes — every Definable plan, including Starter, includes access to all 39 Fidel API tools. You only need a separate Fidel API subscription if Fidel API itself charges per seat or per API call.

Is using Fidel API through Definable secure?

Every call from a persona to Fidel API is logged with the user, persona, prompt, and response. Tokens never leave Definable's secrets vault, scopes are configurable per persona, and you can revoke access at any time from the integration page.

How do I get started with Fidel API on Definable?

Sign up for Definable, open the integrations page, find Fidel API, and connect via OAuth or API key. You can immediately attach Fidel API to any persona and start running workflows. The free Starter plan includes 5,000 credits/month.

What Fidel API actions does Definable expose?

Definable exposes all 39 Fidel API actions as callable tools — including `Create Brand`, `Create Brand Webhook`, `Create Location`, plus 36 more. Each tool gets a typed parameter schema so personas know exactly how to call it.

Ready to automate with Fidel API?

Wire it up in minutes. No coding required.

Start for free Schedule a demo

← All integrations