NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Fidel API

fidel_api

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.

Developer ToolsWeb del proveedor
Acciones
18
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (18)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create BrandFIDEL_API_CREATE_BRANDAcción

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.

Parámetros de entrada

  • iconstring

    URL to brand's icon (image)

  • namestringObligatorio

    Brand name

  • websitestring

    URL to brand's website

  • metadataobject

    Metadata object (key-value pairs) up to 1024 chars

  • privacyPolicyUrlstring

    URL to brand's privacy policy

  • termsAndConditionsUrlstring

    URL to brand's terms and conditions

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ProgramFIDEL_API_CREATE_PROGRAMAcción

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

Parámetros de entrada

  • iconstring

    Emoji icon representation (colon-wrapped), e.g., ':avocado:'.

  • namestringObligatorio

    Name of the program to create.

  • metadataobject

    Optional custom metadata key/value pairs.

  • iconBackgroundstring

    Background color for the icon in hex format, e.g., '#BADA55'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Program WebhookFIDEL_API_CREATE_PROGRAM_WEBHOOKAcción

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.

Parámetros de entrada

  • urlstringObligatorio

    HTTPS URL where webhook notifications will be sent

  • eventstringObligatorioenum

    Event type to receive notifications for

    card.linkedcard.failedprogram.statuslocation.statustransaction.authtransaction.auth.qualifiedtransaction.clearingtransaction.clearing.qualifiedtransaction.refundtransaction.refund.qualified
  • programIdstringObligatorio

    Unique ID of the program to which to register the webhook

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete OfferFIDEL_API_DELETE_OFFERAcción

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

Parámetros de entrada

  • offerIdstringObligatorio

    The unique identifier of the offer to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Program WebhookFIDEL_API_DELETE_PROGRAM_WEBHOOKAcción

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

Parámetros de entrada

  • hookIdstringObligatorio

    Unique identifier of the webhook to delete

  • programIdstringObligatorio

    Unique identifier of the program containing the webhook

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookFIDEL_API_DELETE_WEBHOOKAcción

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

Parámetros de entrada

  • hookIdstringObligatorio

    The unique identifier of the webhook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get BrandFIDEL_API_GET_BRANDAcción

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

Parámetros de entrada

  • brandIdstringObligatorio

    The unique identifier of the brand to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OfferFIDEL_API_GET_OFFERAcción

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

Parámetros de entrada

  • offerIdstringObligatorio

    Unique identifier of the offer to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ProgramFIDEL_API_GET_PROGRAMAcción

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

Parámetros de entrada

  • programIdstringObligatorio

    Unique identifier for the Program.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WebhookFIDEL_API_GET_WEBHOOKAcción

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

Parámetros de entrada

  • hookIdstringObligatorio

    Unique identifier of the webhook to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List BrandsFIDEL_API_LIST_BRANDSAcción

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

Parámetros de entrada

  • limitinteger

    Number of brands to return (1-100).

  • startingAfterstring

    Cursor for pagination. Returns brands after this cursor.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CardsFIDEL_API_LIST_CARDSAcción

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

Parámetros de entrada

  • limitinteger

    Number of cards to return per page.

  • statusstring

    Filter cards by status (e.g., 'active', 'inactive').

  • metadataobject

    Filter by card metadata; provide key-value pairs.

  • accountIdstring

    Filter by account ID.

  • programIdstringObligatorio

    The unique identifier of the program whose cards you want to list.

  • endingBeforestring

    Cursor for pagination; return results before this card ID.

  • startingAfterstring

    Cursor for pagination; return results after this card ID.

Parámetros de salida

  • dataobject[]Obligatorio

    Array of card objects.

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Object type, always 'list'.

  • hasMorebooleanObligatorio

    True if more results are available.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • totalCountintegerObligatorio

    Total number of cards found.

List LocationsFIDEL_API_LIST_LOCATIONSAcción

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

Parámetros de entrada

  • countinteger

    (Deprecated) Number of locations to return. Use 'limit' instead.

  • limitinteger

    Number of locations to return per page (1-100).

  • searchstring

    Filter locations by name or address substring.

  • programIdstringObligatorio

    Unique identifier of the program to list locations for.

  • countryCodestring

    Filter locations by 2-letter country code, e.g., 'GB'.

  • endingBeforestring

    Cursor for pagination to return locations before a specific ID.

  • startingAfterstring

    Cursor for pagination to return locations after a specific ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OffersFIDEL_API_LIST_OFFERSAcción

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

Parámetros de entrada

  • pageinteger

    Page number of results to return (must be >= 1).

  • statusstringenum

    Filter by offer status.

    ACTIVEINACTIVE
  • brandIdstring

    Filter offers by associated brand UUID.

  • endDatestring

    Filter offers ending on or before this date (ISO 8601).

  • perPageinteger

    Number of results per page (1–100).

  • programIdstring

    Filter offers by associated program UUID.

  • startDatestring

    Filter offers starting on or after this date (ISO 8601).

  • locationIdstring

    Filter offers by associated location UUID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ProgramsFIDEL_API_LIST_PROGRAMSAcción

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

Parámetros de entrada

  • limitinteger

    Maximum number of programs to return (must be ≥ 1).

  • startingAfterstring

    Cursor returned by a previous call for pagination.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Program WebhooksFIDEL_API_LIST_PROGRAM_WEBHOOKSAcción

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

Parámetros de entrada

  • programIdstringObligatorio

    The unique identifier of the program whose webhooks you want to list.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TransactionsFIDEL_API_LIST_TRANSACTIONSAcción

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

Parámetros de entrada

  • endstring

    Only return transactions created before this timestamp (RFC3339).

  • limitinteger

    Number of transactions to return (1-100).

  • startstring

    Only return transactions created after this timestamp (RFC3339).

  • cardIdstring

    Filter by tokenized card ID.

  • fieldsstring

    Comma-separated list of fields to include in each transaction record.

  • offsetinteger

    Number of transactions to skip before starting to collect the result set.

  • programIdstring

    Filter by Fidel program ID.

  • insertedAtstring

    Only return transactions inserted at this timestamp (RFC3339).

  • locationIdstring

    Filter by location ID.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ProgramFIDEL_API_UPDATE_PROGRAMAcción

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

Parámetros de entrada

  • iconstring

    Emoji icon representation (colon-wrapped), e.g., ':avocado:'

  • namestring

    New name for the Program

  • activeboolean

    Program active status

  • metadataobject

    Custom metadata as key/value pairs

  • programIdstringObligatorio

    Unique identifier of the Program to update.

  • iconBackgroundstring

    Background color for the icon in hex format, e.g., '#BADA55'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not