Create Receipt with Loyverse API on New Card Linked (Instant) from Fidel API API

Pipedream makes it easy to connect APIs for Loyverse, Fidel API and 2,900+ other apps remarkably fast.

Trigger workflow on

New Card Linked (Instant) from the Fidel API API

Next, do this

Create Receipt with the Loyverse API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Fidel API trigger and Loyverse action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Card Linked (Instant) trigger
1. Connect your Fidel API account
2. Select a Program ID
Configure the Create Receipt action
1. Connect your Loyverse account
2. Select a Store ID
3. Configure Line Items
4. Select a Payment Type ID
5. Optional- Select a Employee ID
6. Optional- Configure Order
7. Optional- Select a Customer ID
8. Optional- Configure Source
9. Optional- Configure Receipt Date
10. Optional- Configure Total Discounts
11. Optional- Configure Note
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Card Linked (Instant) on Fidel API

Description:Emit new event each time a new card is linked to the Fidel API.

Version:0.0.1

Key:fidel_api-card-linked

View on GitHub

Fidel API Overview#

The Fidel API allows you to link credit and debit cards to specific offers or programs, track transactions in real-time, and receive event-driven data. It's a powerful tool for creating loyalty and reward programs, providing insights into customer spending patterns, and automating financial operations. With Pipedream, you can craft workflows that leverage Fidel API's capabilities to trigger actions, sync data, and connect with other apps for enhanced automation.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "fidel_api-card-linked",
  name: "New Card Linked (Instant)",
  description: "Emit new event each time a new card is linked to the Fidel API.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "card.linked";
    },
    getSummary(body) {
      return `New card linked: ${body.firstNumbers}****${body.lastNumbers}`;
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Fidel API	`fidelApi`	`app`	This component uses the Fidel API app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Program ID	`programId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Fidel API uses API keys for authentication. When you connect your Fidel API account, Pipedream securely stores the keys so you can easily authenticate to Fidel API APIs in both code and no-code steps.

To retrieve your API Key,

Navigate to your Fidel API account and sign in
Click the dropdown on the top left
Go to “Account settings” > “Plan” > “API Keys”

About Fidel API#

Make money programmable: Fidel API enables developers to build transformative experiences on top of payment cards.

Action#

Create Receipt on Loyverse

Description:Creates a new receipt for a specific store. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post)

Version:0.0.2

Key:loyverse-create-receipt

View on GitHub

Loyverse Overview#

The Loyverse API provides a suite of functions to access and manage the data for businesses using the Loyverse platform, which includes point of sale, inventory management, employee management, and analytics. With Pipedream, you can create automated workflows that trigger on new events from Loyverse, like a new sale, or that perform operations in Loyverse, like creating a new item in your inventory. By connecting Loyverse to other apps via Pipedream, you can sync data across platforms, get real-time notifications, and streamline operations.

Action Code#

import loyverse from "../../loyverse.app.mjs";
import { parseAsJSON } from "../../common/utils.mjs";

export default {
  key: "loyverse-create-receipt",
  name: "Create Receipt",
  description: "Creates a new receipt for a specific store. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    loyverse,
    storeId: {
      propDefinition: [
        loyverse,
        "storeId",
      ],
    },
    lineItems: {
      type: "string[]",
      label: "Line Items",
      description: "[An array of JSON-stringified objects](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post). You can use the **Generate Receipt Items** action to generate these items.",
    },
    paymentTypeId: {
      propDefinition: [
        loyverse,
        "paymentTypeId",
      ],
    },
    employeeId: {
      propDefinition: [
        loyverse,
        "employeeId",
      ],
    },
    order: {
      type: "string",
      label: "Order",
      description: "The order name or number associated with the receipt",
      optional: true,
    },
    customerId: {
      propDefinition: [
        loyverse,
        "customerId",
      ],
      description: "Select a customer or provide a customer ID.",
    },
    source: {
      type: "string",
      label: "Source",
      description: "The name of the source this receipt comes from. By default it is the name of the application that created the receipt.",
      optional: true,
    },
    receiptDate: {
      type: "string",
      label: "Receipt Date",
      description: "A date/time string such as `2022-03-15T18:30:00Z`. By default, this is the date/time the receipt was created.",
      optional: true,
    },
    totalDiscounts: {
      type: "string[]",
      label: "Total Discounts",
      description: "The list of all discounts applied in the receipt, as JSON-stringified objects. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post) for the expected properties.",
      optional: true,
    },
    note: {
      type: "string",
      label: "Note",
      description: "The receipt's note",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      lineItems, totalDiscounts,
    } = this;
    const discounts = totalDiscounts?.map?.(parseAsJSON);
    const response = await this.loyverse.createReceipt({
      $,
      data: {
        store_id: this.storeId,
        line_items: lineItems.map?.(parseAsJSON) ?? JSON.parse(lineItems),
        payments: [
          {
            payment_type_id: this.paymentTypeId,
          },
        ],
        employee_id: this.employeeId,
        order: this.order,
        customer_id: this.customerId,
        source: this.source,
        receipt_date: this.receiptDate,
        total_discounts: discounts ?? (totalDiscounts && JSON.parse(totalDiscounts)),
        note: this.note,
      },
    });
    $.export("$summary", `Successfully created receipt with number ${response.receipt_number}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Loyverse	`loyverse`	`app`	This component uses the Loyverse app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Line Items	`lineItems`	`string[]`	An array of JSON-stringified objects. You can use the Generate Receipt Items action to generate these items.
Payment Type ID	`paymentTypeId`	`string`	Select a value from the drop down menu.
Employee ID	`employeeId`	`string`	Select a value from the drop down menu.
Order	`order`	`string`	The order name or number associated with the receipt
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	The name of the source this receipt comes from. By default it is the name of the application that created the receipt.
Receipt Date	`receiptDate`	`string`	A date/time string such as `2022-03-15T18:30:00Z`. By default, this is the date/time the receipt was created.
Total Discounts	`totalDiscounts`	`string[]`	The list of all discounts applied in the receipt, as JSON-stringified objects. See the documentation for the expected properties.
Note	`note`	`string`	The receipt's note

Action Authentication#

Loyverse uses OAuth authentication. When you connect your Loyverse account, Pipedream will open a popup window where you can sign into Loyverse and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Loyverse API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEEMPLOYEES_READITEMS_READINVENTORY_WRITEPAYMENT_TYPES_READRECEIPTS_READRECEIPTS_WRITESTORES_READMERCHANT_READ

Create Receipt with Loyverse API on New Card Linked (Instant) from Fidel API API

Pipedream makes it easy to connect APIs for Loyverse, Fidel API and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular