View as Markdown
ifthenpay icon

ifthenpay ACTION

Create Payment Reference

Generates a Multibanco or MB WAY payment reference with a specified amount, entity code, and deadline. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ifthenpay account once, then configure and run Create Payment Reference from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ifthenpay-create-payment-reference",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ifthenpay: { authProvisionId: "apn_xxxxxxx" },
    paymentMethod: "Payment Method",
    mbKey: "Mb Key",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Payment Reference inputs
Property Type Description
paymentMethod Payment Method string
The payment method to use for Ifthenpay (e.g., MB WAY, Multibanco)
Required
mbKey Mb Key string
The key for the Multibanco payment method.
Required
mbWayKey Mb Way Key string
The key for the MB Way payment method.
Required
orderId Order Id string
Payment identifier defined by the client (e.g., invoice number, order number, etc.)
Required
amount Amount string
The amount to be paid with decimal separator "."
Required
mobileNumber Mobile Number string
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)
Required
description Description string
Description of the payment, with a maximum length of 200 characters
Optional
url URL string
URL address, with a maximum length of 200 characters
Optional
clientCode Client Code string
Client's code, with a maximum length of 200 characters
Optional
clientName Client Name string
Client's name, with a maximum length of 200 characters
Optional
email Email string
The Client's name.
Optional
clientUsername Client Username string
Client's username, with a maximum length of 200 characters
Optional
clientPhone Client Phone string
Client's cell phone or phone number, with a maximum length of 200 characters
Optional
expiryDays Expiry Days integer
How many days the payment reference is valid for. See the documentation for further details.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ifthenpay-create-payment-reference
Version
0.0.2
App
ifthenpay
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes