View as Markdown
Xendit icon

Xendit ACTION

Create Payout

Create a new payout on Xendit platform See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xendit account once, then configure and run Create Payout 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: "xendit-create-payout",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xendit: { authProvisionId: "apn_xxxxxxx" },
    referenceId: "Reference ID",
    channelCode: "Channel Code",
  },
})

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 Payout inputs
Property Type Description
referenceId Reference ID string
A client defined payout identifier. This is the ID assigned to the payout on your system, such as a transaction or order ID. Does not need to be unique.
Required
channelCode Channel Code string
Channel code of destination bank, e-wallet or OTC channel. List of supported channels can be found here
Required
accountHolderName Account Holder Name string
Name of account holder as per the bank or e-wallet's records. Needs to match the registered account name exactly.
Required
accountNumber Account Number string
Account number of destination. Mobile numbers for e-wallet accounts.
Required
accountType Account Type string
Account type of the destination for currencies and channels that supports proxy transfers (ie: Using mobile number as account number)
Optional
amount Amount string
Amount to be sent to the destination account. Should be a multiple of the minimum increment for the selected channel.
Required
description Description string
Description to send with the payout. The recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf.
Optional
currency Currency string
ISO 4217 Currency Code.
Optional
emailTo Email To string[]
A list of email addresses to receive the payout details upon successful payout. Maximum of three email addresses.
Optional
emailCc Email Cc string[]
A list of email addresses to receive the payout details upon successful payout. Maximum of three email addresses.
Optional
emailBcc Email Bcc string[]
A list of email addresses to receive a hidden copy of the payout details upon successful payout. Maximum of three email addresses.
Optional
metadata Metadata object
A list of objects of metadata key-value pairs. The key must be a string and the value can be a string or number.
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
xendit-create-payout
Version
0.0.2
App
Xendit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes