Fidel Api | Composio

Overview

Enum

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

API_KEY

api_key

stringRequired

Actions

FIDEL_API_CREATE_BRAND

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

object

error

string

successful

boolean

FIDEL_API_CREATE_PROGRAM

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

object

error

string

successful

boolean

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

Action Parameters

event

stringRequired

programId

stringRequired

url

stringRequired

Action Response

data

object

error

string

successful

boolean

FIDEL_API_DELETE_OFFER

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

Action Parameters

offerId

stringRequired

Action Response

data

object

error

string

successful

boolean

FIDEL_API_DELETE_PROGRAM_WEBHOOK

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

object

error

string

successful

boolean

FIDEL_API_DELETE_WEBHOOK

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

Action Parameters

hookId

stringRequired

Action Response

data

object

error

string

successful

boolean

FIDEL_API_GET_BRAND

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

object

error

string

successful

boolean

FIDEL_API_GET_OFFER

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

object

error

string

successful

boolean

FIDEL_API_GET_PROGRAM

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

object

error

string

successful

boolean

FIDEL_API_GET_WEBHOOK

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

object

error

string

successful

boolean

FIDEL_API_LIST_BRANDS

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

object

error

string

successful

boolean

FIDEL_API_LIST_CARDS

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

array

error

string

hasMore

boolean

object

string

successful

boolean

totalCount

integer

FIDEL_API_LIST_LOCATIONS

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

string

startingAfter

string

Action Response

data

object

error

string

successful

boolean

FIDEL_API_LIST_OFFERS

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

object

error

string

successful

boolean

FIDEL_API_LIST_PROGRAMS

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

object

error

string

successful

boolean

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

Action Parameters

programId

stringRequired

Action Response

data

object

error

string

successful

boolean

FIDEL_API_LIST_TRANSACTIONS

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

array

error

string

successful

boolean

FIDEL_API_UPDATE_PROGRAM

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

object

error

string

successful

boolean