Fidel API

BUSINESS · COMMERCE & FINANCE

Card-linking programs, cards, transactions, and offers on their own key.

Connecting Fidel API in practice

Fidel authenticates with a `fidel-key` header rather than an Authorization one, and the environment is a property of the key, not the request: an `sk_test_` key and an `sk_live_` key call the same endpoints against different data. Some endpoints exist in only one mode — creating a transaction is test-only, sending an offer to a brand is live-only — so the live path cannot be rehearsed.

Scopes that draw scrutiny

fidel-key: sk_live_… (secret key) Server-side only. Fidel’s documentation says "Do not share or include your secret API keys on client-side code", because the key reaches enrolled cards, transactions and live offers.
Public key The client-side SDK credential used for card enrolment, which is the point at which a cardholder’s primary account number enters the flow.

Worth knowing

Switching between test and live means swapping the key, so a mis-set environment variable moves real card data instead of failing loudly.
Create Transaction exists only in test mode, so end-to-end behaviour of a live programme cannot be simulated with synthetic transactions.
Send Offer to Brand is live-only, which means the offer-distribution step of an integration has no test-mode equivalent to develop against.
Webhooks are registered separately per brand and per programme, so a new programme silently receives no events until its own webhook is created.

Checked against Fidel API authentication (2026-09-29), Fidel API reference index (2026-09-29)

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

fidel_delete_brands_by_brandidWRITE

Delete Brand via DELETE /brands/{brandId}

api

fidel_delete_cards_by_cardidWRITE

Delete Card via DELETE /cards/{cardId}

api

fidel_delete_hooks_by_hookidWRITE

Delete Webhook via DELETE /hooks/{hookId}

api

fidel_delete_locations_by_locationidWRITE

Delete Location via DELETE /locations/{locationId}

api

fidel_delete_offers_by_offeridWRITE

Delete Offer via DELETE /offers/{offerId}

api

fidel_delete_offers_by_offerid_cards_by_cardidWRITE

Deactivate Offer on Card via DELETE /offers/{offerId}/cards/{cardId}. Removes a card from an offer. The usage count resets to 0 on the removed card.

api

fidel_delete_offers_by_offerid_locations_by_locationidWRITE

Unlink Location to Offer via DELETE /offers/{offerId}/locations/{locationId}. Unlinks a location from an offer.

api

fidel_get_brandsREAD

List Brands via GET /brands

api

fidel_get_brands_by_brandidREAD

Get Brand via GET /brands/{brandId}

api

fidel_get_brands_by_brandid_programs_by_programid_locationsREAD

List Locations by Brand via GET /brands/{brandId}/programs/{programId}/locations

api

fidel_get_cards_by_cardidREAD

Get Card via GET /cards/{cardId}

api

fidel_get_cards_by_cardid_transactionsREAD

List Transactions by Card via GET /cards/{cardId}/transactions

api

fidel_get_cards_metadata_by_metadataidREAD

List Cards from Metadata ID via GET /cards/metadata/{metadataId}

api

fidel_get_hooks_by_hookidREAD

Get Webhook via GET /hooks/{hookId}

api

fidel_get_locations_by_locationidREAD

Get Location via GET /locations/{locationId}. Receive information about a specific location based on the LocationId.

api

fidel_get_marketplace_offersREAD

Get Marketplace Offers via GET /marketplace-offers

api

fidel_get_missing_transaction_requests_by_missingtransactionrequestidREAD

Get missing transaction request via GET /missing-transaction-requests/{missingTransactionRequestId}

api

fidel_get_offersREAD

List Offers via GET /offers

api

fidel_get_offers_by_offeridREAD

Get Offer via GET /offers/{offerId}

api

fidel_get_offers_by_offerid_cardsREAD

List Cards with Active Offer via GET /offers/{offerId}/cards

api

fidel_get_offers_by_offerid_cards_by_cardidREAD

Check Active Offer on Card via GET /offers/{offerId}/cards/{cardId}

api

fidel_get_offers_by_offerid_locationsREAD

List Locations by Offer via GET /offers/{offerId}/locations. Lists all locations linked to an offer.

api

fidel_get_programsREAD

List Programs via GET /programs

api

fidel_get_programs_by_programidREAD

Get Program via GET /programs/{programId}

api

fidel_get_programs_by_programid_cardsREAD

List Cards via GET /programs/{programId}/cards

api

fidel_get_programs_by_programid_hooksREAD

List Webhooks via GET /programs/{programId}/hooks

api

fidel_get_programs_by_programid_locationsREAD

List Locations via GET /programs/{programId}/locations

api

fidel_get_programs_by_programid_mid_insightsREAD

List Mid Insights via GET /programs/{programId}/mid-insights. Returns paginated mid insight records for a program.

api

fidel_get_programs_by_programid_mid_requestsREAD

List mid requests via GET /programs/{programId}/mid-requests

api

fidel_get_programs_by_programid_mid_requests_by_midrequestidREAD

Get mid request via GET /programs/{programId}/mid-requests/{midRequestId}

api

fidel_get_programs_by_programid_midsREAD

List mids via GET /programs/{programId}/mids

api

fidel_get_programs_by_programid_mids_by_mididREAD

Get mid via GET /programs/{programId}/mids/{midId}

api

fidel_get_programs_by_programid_missing_transaction_requestsREAD

List missing transaction requests via GET /programs/{programId}/missing-transaction-requests

api

fidel_get_programs_by_programid_transactionsREAD

List Transactions by Program via GET /programs/{programId}/transactions

api

fidel_get_transactions_by_transactionidREAD

Get Transaction via GET /transactions/{transactionId}

api

fidel_patch_brands_by_brandidWRITE

Update Brand via PATCH /brands/{brandId}

api

fidel_patch_hooks_by_hookidWRITE

Update Webhook via PATCH /hooks/{hookId}

api

fidel_patch_locations_by_locationidWRITE

Update Location via PATCH /locations/{locationId}. Update location details.

api

fidel_patch_offers_by_offeridWRITE

Update Offer via PATCH /offers/{offerId}. Update specific offer properties.

api

fidel_patch_programs_by_programidWRITE

Update Program via PATCH /programs/{programId}

api

fidel_post_brandsWRITE

Create Brand via POST /brands

api

fidel_post_cards_by_cardid_missing_transaction_requestsWRITE

Create missing transaction request via POST /cards/{cardId}/missing-transaction-requests

api

fidel_post_hooksWRITE

Create Webhook (Brand) via POST /hooks

api

fidel_post_marketplace_offers_by_marketplaceofferid_offersWRITE

Create Offer from Marketplace Offer via POST /marketplace-offers/{marketplaceOfferId}/offers

api

fidel_post_offersWRITE

Create Offer via POST /offers

api

fidel_post_offers_by_offerid_cards_by_cardidWRITE

Activate Offer on Card via POST /offers/{offerId}/cards/{cardId}

api

fidel_post_offers_by_offerid_locations_by_locationidWRITE

Link Location to Offer via POST /offers/{offerId}/locations/{locationId}. Links locations to an offer.

api

fidel_post_offers_by_offerid_programs_by_programid_locationsWRITE

Link All Brand Locations to Offer via POST /offers/{offerId}/programs/{programId}/locations. Links locations to an offer.

api

fidel_post_programsWRITE

Create Program via POST /programs

api

fidel_post_programs_by_programid_cardsWRITE

Create Card via POST /programs/{programId}/cards

api

fidel_post_programs_by_programid_hooksWRITE

Create Webhook (Program) via POST /programs/{programId}/hooks

api

fidel_post_programs_by_programid_locationsWRITE

Create Location via POST /programs/{programId}/locations. Creating a location requires a programId, brandId, and address details. Optionally, you can add merchantIDs.

api

fidel_post_programs_by_programid_mid_requestsWRITE

Create mid request via POST /programs/{programId}/mid-requests

api

fidel_post_transactions_testWRITE

Create Transaction via POST /transactions/test. This API endpoint only works in the test environment.

api

fidel_put_cards_by_cardid_metadataWRITE

Update Card Metadata via PUT /cards/{cardId}/metadata

api