Payments

Fidel api

Learn how to use Fidel api with Composio

Overview

SLUG: FIDEL_API

Description

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.

Authentication Details

generic_api_key
stringRequired

Connecting to Fidel api

Create an auth config

Use the dashboard to create an auth config for the Fidel api toolkit. This allows you to connect multiple Fidel api accounts to Composio for agents to use.

1

Select App

Navigate to [Fidel api](https://platform.composio.dev/marketplace/Fidel api).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Fidel api Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4fidel_api_auth_config_id = "ac_YOUR_FIDEL_API_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": user_api_key}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Fidel api for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, fidel_api_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Fidel api toolkit’s playground](https://app.composio.dev/app/Fidel api)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["FIDEL_API"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Brand

Description

Tool to create a new brand on fidel. use when you have brand details and need to register it. this tool sends a post request to /v1/brands with the provided brand data.

Action Parameters

icon
string
metadata
object
name
stringRequired
privacyPolicyUrl
string
termsAndConditionsUrl
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Program

Description

Tool to create a new program. use when registering an offline or online store. use after confirming program name and any optional metadata.

Action Parameters

icon
string
iconBackground
string
metadata
object
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Program Webhook

Description

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.

Action Parameters

event
stringRequired
programId
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Offer

Description

Tool to delete a specified offer by its id. use after confirming the correct offer id.

Action Parameters

offerId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Program Webhook

Description

Tool to delete a specified webhook for a program. use when you need to remove a program webhook after confirming programid and hookid.

Action Parameters

hookId
stringRequired
programId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete a specified webhook. use when you need to remove a webhook by its id.

Action Parameters

hookId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Brand

Description

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

Action Parameters

brandId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Offer

Description

Tool to fetch details of a specific offer. use when you have an offer id and need its full details.

Action Parameters

offerId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Program

Description

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

Action Parameters

programId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhook

Description

Tool to retrieve details of a specific webhook. use when you have a webhook id and need its full details.

Action Parameters

hookId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Brands

Description

Tool to list all brands. use when you need to retrieve a paginated list of all available brands.

Action Parameters

limit
integerDefaults to 20
startingAfter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Cards

Description

Tool to list all cards for a specific program. use when you have a programid and need to retrieve associated card records.

Action Parameters

accountId
string
endingBefore
string
limit
integer
metadata
object
programId
stringRequired
startingAfter
string
status
string

Action Response

data
arrayRequired
error
string
hasMore
booleanRequired
object
stringRequired
successful
booleanRequired
totalCount
integerRequired

Tool Name: List Locations

Description

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

Action Parameters

count
integer
countryCode
string
endingBefore
string
limit
integer
programId
stringRequired
search
string
startingAfter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Offers

Description

Tool to list all offers. use when you need to retrieve offers after applying optional filters.

Action Parameters

brandId
string
endDate
string
locationId
string
page
integerDefaults to 1
perPage
integer
programId
string
startDate
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Programs

Description

Tool to list fidel programs. use when you need to retrieve available programs with optional pagination.

Action Parameters

limit
integer
startingAfter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Program Webhooks

Description

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

Action Parameters

programId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Transactions

Description

Tool to list transactions. use when you need to page through and/or filter transactions.

Action Parameters

cardId
string
end
string
fields
string
insertedAt
string
limit
integerDefaults to 10
locationId
string
offset
integer
programId
string
start
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Update Program

Description

Tool to update a program's name, icon, metadata, or status. use after confirming the program id and desired updates.

Action Parameters

active
boolean
icon
string
iconBackground
string
metadata
object
name
string
programId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired