Create Payment Reference with ifthenpay API

Pipedream makes it easy to connect APIs for ifthenpay and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Payment Reference with the ifthenpay 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#

Create a workflow to Create Payment Reference with the ifthenpay API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Payment Reference action
1. Connect your ifthenpay account
2. Select a Payment Method
3. Configure Mb Key
4. Configure Mb Way Key
5. Configure Order Id
6. Configure Amount
7. Configure Mobile Number
8. Optional- Configure Description
9. Optional- Configure URL
10. Optional- Configure Client Code
11. Optional- Configure Client Name
12. Optional- Configure Email
13. Optional- Configure Client Username
14. Optional- Configure Client Phone
15. Optional- Configure Expiry Days
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Payment Reference with ifthenpay API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ifthenpay

Try it

Create Payment Reference with ifthenpay API on New Submission from Typeform API

Typeform + ifthenpay

Try it

Create Payment Reference with ifthenpay API on New Submission (Instant) from Jotform API

Jotform + ifthenpay

Try it

Create Payment Reference with ifthenpay API on New Scheduled Tasks from Pipedream API

Pipedream + ifthenpay

Try it

Create Payment Reference with ifthenpay API on New Download Counts from npm API

npm + ifthenpay

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Payment Reference on ifthenpay

Description:Generates a Multibanco or MB WAY payment reference with a specified amount, entity code, and deadline. [See the documentation](https://ifthenpay.com/docs/en/)

Version:0.0.1

Key:ifthenpay-create-payment-reference

View on GitHub

Code#

import { PAYMENT_METHOD_OPTIONS } from "../../common/constants.mjs";
import ifthenpay from "../../ifthenpay.app.mjs";

export default {
  key: "ifthenpay-create-payment-reference",
  name: "Create Payment Reference",
  description: "Generates a Multibanco or MB WAY payment reference with a specified amount, entity code, and deadline. [See the documentation](https://ifthenpay.com/docs/en/)",
  version: "0.0.1",
  type: "action",
  props: {
    ifthenpay,
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "The payment method to use for Ifthenpay (e.g., MB WAY, Multibanco)",
      options: PAYMENT_METHOD_OPTIONS,
      reloadProps: true,
    },
    mbKey: {
      propDefinition: [
        ifthenpay,
        "mbKey",
      ],
      hidden: true,
    },
    mbWayKey: {
      propDefinition: [
        ifthenpay,
        "mbWayKey",
      ],
      hidden: true,
    },
    orderId: {
      type: "string",
      label: "Order Id",
      description: "Payment identifier defined by the client (e.g., invoice number, order number, etc.)",
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The amount to be paid with decimal separator \".\"",
    },
    mobileNumber: {
      type: "string",
      label: "Mobile Number",
      description: "Place the country code before the mobile number without any spaces (use '#'' to separate the country code from the mobile number - p.e. 351#912345678)",
      hidden: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the payment, with a maximum length of 200 characters",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL address, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientCode: {
      type: "string",
      label: "Client Code",
      description: "Client's code, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientName: {
      type: "string",
      label: "Client Name",
      description: "Client's name, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The Client's name.",
      optional: true,
    },
    clientUsername: {
      type: "string",
      label: "Client Username",
      description: "Client's username, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientPhone: {
      type: "string",
      label: "Client Phone",
      description: "Client's cell phone or phone number, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    expiryDays: {
      type: "integer",
      label: "Expiry Days",
      description: "How many days the payment reference is valid for. [See the documentation](https://ifthenpay.com/docs/en/api/multibanco/#tag/multibanco/POST/init) for further details.",
      optional: true,
      hidden: true,
    },
  },
  async additionalProps(props) {
    const isMb = this.paymentMethod === "Multibanco";
    props.mbKey.hidden = !isMb;
    props.mbWayKey.hidden = isMb;
    props.mobileNumber.hidden = isMb;
    props.url.hidden = isMb;
    props.clientCode.hidden = isMb;
    props.clientName.hidden = isMb;
    props.email.label = "Client Email";
    props.email.description = "Client's email address, with a maximum length of 200 characters";
    props.clientUsername.hidden = isMb;
    props.clientPhone.hidden = isMb;
    props.expiryDays.hidden = isMb;
    return {};
  },
  async run({ $ }) {
    const response = await this.ifthenpay.generatePaymentReference({
      $,
      paymentMethod: this.paymentMethod,
      data: {
        mbKey: this.mbKey,
        mbWayKey: this.mbWayKey,
        orderId: this.orderId,
        amount: parseFloat(this.amount),
        mobileNumber: this.mobileNumber,
        email: this.email,
        description: this.description,
        url: this.url,
        clientCode: this.clientCode,
        clientName: this.clientName,
        clientUsername: this.clientUsername,
        clientPhone: this.clientPhone,
        expiryDays: this.expiryDays,
        expirationDate: this.expirationDate,
        clientEmail: this.email,
      },
    });

    $.export("$summary", `Successfully created payment reference with Order ID: ${response.OrderId}`);
    return response;
  },
};

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
ifthenpay	`ifthenpay`	`app`	This component uses the ifthenpay app.
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu:`MB WAYMultibanco`
Order Id	`orderId`	`string`	Payment identifier defined by the client (e.g., invoice number, order number, etc.)
Amount	`amount`	`string`	The amount to be paid with decimal separator "."
Description	`description`	`string`	Description of the payment, with a maximum length of 200 characters
Email	`email`	`string`	The Client's name.