API Status: Affected

ProgramsImprove this page

What is a Program

A program represents a distinct group of linked cards. The program is the parent object of your card-linked structure. Other objects such as cards and transactions will link to a program. Programs are unique and independent of each other, allowing you to have several independent programs with different uses inside your account.

To be able to use the Transaction Stream API, you need to create a program first.

Hierarchy diagram of the Fidel API object structure.

Create a Program

You can create a program through the Fidel API dashboard or via API. In test mode, you can create programs that use either Select Transactions API or Transaction Stream API, and in live mode, you can create programs that use the API type that your account is approved for. Once a program is created, a program identifier will be generated and is used as a data property when using the SDKs and APIs to link cards to this program. Cards are linked to programs and consequently are able to track all purchases in the program.

To create a new program on the Fidel API dashboard, go to the Programs page and click the New program button. If in test mode, choose the API type and enter a name for the new program.

For Developers

You can create programs using the API. Using curl, we can add 'Program X' as follows:

curl -X POST \
  -H 'content-type: application/json' \
  -H 'fidel-key: <secret key>' \
  -d '{
    "name": "Program X",
    "metadata": {
      "customKey1": "customValue1",
      "customKey2": "customValue2"
    "type" : "transaction-stream"

Learn More