create_webhook
Creates a new webhook subscription for a specific event type in a Program. When the event occurs, Fidel API sends an HTTP POST to the specified URL. Use an HTTPS destination. Brand consent and offer-location events are account-scoped; program events use the supplied Program.
list_programs
Lists all Programs in your Fidel API account. Supports pagination to navigate through large sets of programs.
list_cards
Lists all enrolled cards in a specific Program. Returns card tokens, schemes, and metadata for each enrolled card.
list_locations
Lists all Locations in a specific Program. Returns locations with their addresses, statuses, and onboarding information.
delete_brand
Deletes a Brand from your Fidel API account. This is a destructive action that cannot be undone.
delete_location
Deletes a Location from a Program. This is a destructive action that cannot be undone and will stop transaction tracking at this location.
get_program
Retrieves details of a specific Program by its ID, including its name, status, and metadata.
get_card
Retrieves details of a specific enrolled card by its ID. Returns the card's token, scheme, last digits, and metadata.
delete_card
Unlinks and deletes an enrolled card from a Program. The card network will stop sending transactions for this card. This action cannot be undone.
create_program
Creates a new Program in Fidel API. A Program is the parent object of the card-linked structure that groups locations, cards, webhooks, and transactions. Use this to set up a new loyalty or rewards scheme.
update_program
Updates an existing Program's name or metadata.
update_webhook
Updates an existing webhook's URL or event type.
get_transaction
Retrieves details of a specific transaction by its ID. Returns the full transaction record including amount, currency, card details, merchant info, and any offer qualification data.
create_brand
Creates a new Brand in Fidel API. Brands aggregate different locations that a brand operates at for transaction tracking. Brands are shared across Programs.
enroll_card
Enrolls a payment card in a Fidel API Program. The card is verified with the associated card network and a token is created to represent it. Requires PCI compliance for direct API enrollment.
manage_offer_locations
Links or unlinks a Location to/from an Offer. Linking a location makes transactions at that location eligible for the offer. Unlinking removes the eligibility.
delete_webhook
Deletes a webhook subscription from a Program. The endpoint will stop receiving notifications for the associated event.
manage_offer_card
Activates or deactivates an Offer on a specific Card. Activating makes the card eligible for the offer's rewards. Deactivating removes the card's eligibility.
create_test_transaction
Creates a test transaction for development and testing purposes. Only works in test mode. Simulates a payment at a specific location with a linked card.
get_brand
Retrieves details of a specific Brand by its ID.
list_brands
Lists all Brands in your Fidel API account. Brands are shared across programs and represent the business entities whose transactions are tracked.
list_transactions
Lists transactions for a Program or a specific Card. Supports filtering by date range. Returns authorization, clearing, and refund events with full transaction details.
get_offer
Retrieves details of a specific Offer by its ID, including its type, value, status, and date range.
get_location
Retrieves details of a specific Location by its ID, including its address, status, and onboarding information.
update_brand
Updates an existing Brand's logo, website, or metadata. The legacy name field is retained, but name changes are not documented by Fidel.
list_webhooks
Lists all webhooks configured for a specific Program. Returns each webhook's event type, URL, and configuration.
create_offer
Creates a card-linked Offer for a Brand. Link locations with manage_offer_locations or link_all_offer_locations to make it eligible in a Program. Offers can be fixed-amount cashback or percentage-based discounts. When a qualifying transaction occurs at a linked location, the offer is applied automatically.
create_location
Creates a new Location under a Program for a specific Brand. Locations represent physical or online stores identified by Merchant IDs (MIDs) where transactions from linked cards will be tracked.
update_offer
Updates an existing Offer's name, date range, max reward, or metadata.
list_offers
Lists all Offers in a specific Program. Returns offer details including type, value, status, and linked brands.
create_missing_transaction_request
Ask the card network to investigate a missing transaction for a linked card at a known location.
list_cards_by_metadata
Find enrolled cards across programs using their metadata.id index, for customer reconciliation.
link_all_offer_locations
Request linking all locations of the offer brand in a program to the offer. Fidel processes this request asynchronously.
update_card_metadata
Replace the metadata on an enrolled card. Send an empty object to clear its metadata.
list_offer_locations
List the merchant locations linked to an offer and their onboarding details.
get_missing_transaction_request
Retrieve a missing transaction investigation and any network result.
list_offer_cards
List cards on which an offer is activated.
update_location
Update a merchant location address, metadata, or known merchant IDs. Supply the complete address as required by Fidel.
check_offer_card
Check whether an offer is active on a card, without changing its activation.
delete_offer
Delete a self-sourced offer created by a publisher. Marketplace and content-provider offers cannot be deleted.
get_webhook
Retrieve an account or program webhook by its ID, including its URL, event, and verification secret.
list_missing_transaction_requests
List missing transaction investigations in a program, optionally filtering by card, location, brand, or status.