Create Payout with Xendit API on New Transaction Created from Ramp (Sandbox) API

Pipedream makes it easy to connect APIs for Xendit, Ramp (Sandbox) and 2,500+ other apps remarkably fast.

Trigger workflow on

New Transaction Created from the Ramp (Sandbox) API

Next, do this

Create Payout with the Xendit 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 Ramp (Sandbox) trigger and Xendit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Transaction Created trigger
1. Connect your Ramp (Sandbox) account
2. Configure timer
3. Optional- Select a Department ID
4. Optional- Select a Location ID
Configure the Create Payout action
1. Connect your Xendit account
2. Configure Reference ID
3. Configure Channel Code
4. Configure Account Holder Name
5. Configure Account Number
6. Optional- Configure Account Type
7. Configure Amount
8. Optional- Configure Description
9. Optional- Configure Currency
10. Optional- Configure Email To
11. Optional- Configure Email Cc
12. Optional- Configure Email Bcc
13. Optional- Configure Metadata
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 Transaction Created on Ramp (Sandbox)

Description:Emit new event for each new transaction created in Ramp.

Version:0.0.2

Key:ramp_sandbox-new-transaction-created

View on GitHub

Ramp (Sandbox) Overview#

The Ramp (Sandbox) API provides programmatic access to manage corporate cards and spending in a controlled environment, ideal for testing and development. With this API on Pipedream, developers can automate financial operations, synchronize accounting data, and streamline expense management workflows. Leveraging Pipedream's capabilities, users can integrate Ramp with other services to enhance financial visibility, automate reconciliation processes, and trigger actions based on spending activities.

Trigger Code#

import common from "../common/base.mjs";
import newTransactionCreated from "@pipedream/ramp/sources/new-transaction-created/new-transaction-created.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "ramp_sandbox-new-transaction-created",
  name: "New Transaction Created",
  description: "Emit new event for each new transaction created in Ramp.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    departmentId: {
      propDefinition: [
        common.props.ramp,
        "departmentId",
      ],
    },
    locationId: {
      propDefinition: [
        common.props.ramp,
        "locationId",
      ],
    },
  },
  methods: {
    ...common.methods,
    ...newTransactionCreated.methods,
  },
  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
Ramp (Sandbox)	`ramp`	`app`	This component uses the Ramp (Sandbox) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Department ID	`departmentId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

transactions:readcards:readcards:writespend_programs:readspend_programs:writeusers:readusers:writelocations:readlocations:writelimits:readlimits:writedepartments:readdepartments:writebusiness:readreceipts:readtransfers:readvendors:readmerchants:readaccounting:readreceipts:write

About Ramp (Sandbox)#

The Ramp sandbox is a full-fledged environment in which you can explore different API endpoints and test your application.

Action#

Create Payout on Xendit

Description:Create a new payout on Xendit platform [See the documentation](https://developers.xendit.co/api-reference/#create-payout)

Version:0.0.1

Key:xendit-create-payout

View on GitHub

Xendit Overview#

Leveraging the Xendit API on Pipedream, you can automate an array of financial tasks related to payments, disbursements, and accounting. Xendit simplifies handling transactions in Southeast Asia, offering services such as direct debit, credit card processing, and real-time payment tracking. By connecting it with Pipedream, you can create powerful workflows that trigger actions based on payment events, sync transaction data with other business systems, and streamline notification processes for financial operations.

Action Code#

import { v7 as uuidV7 } from "uuid";
import { parseObject } from "../../common/utils.mjs";
import xendit from "../../xendit.app.mjs";

export default {
  key: "xendit-create-payout",
  name: "Create Payout",
  version: "0.0.1",
  description: "Create a new payout on Xendit platform [See the documentation](https://developers.xendit.co/api-reference/#create-payout)",
  type: "action",
  props: {
    xendit,
    referenceId: {
      type: "string",
      label: "Reference ID",
      description: "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.",
    },
    channelCode: {
      type: "string",
      label: "Channel Code",
      description: "Channel code of destination bank, e-wallet or OTC channel. List of supported channels can be found [here](https://docs.xendit.co/xendisburse/channel-codes)",
    },
    accountHolderName: {
      type: "string",
      label: "Account Holder Name",
      description: "Name of account holder as per the bank or e-wallet's records. Needs to match the registered account name exactly.",
    },
    accountNumber: {
      type: "string",
      label: "Account Number",
      description: "Account number of destination. Mobile numbers for e-wallet accounts.",
    },
    accountType: {
      type: "string",
      label: "Account Type",
      description: "Account type of the destination for currencies and channels that supports proxy transfers (ie: Using mobile number as account number)",
      optional: true,
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "Amount to be sent to the destination account. Should be a multiple of the minimum increment for the selected channel.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "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: true,
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "ISO 4217 Currency Code.",
      optional: true,
    },
    emailTo: {
      type: "string[]",
      label: "Email To",
      description: "A list of email addresses to receive the payout details upon successful payout. **Maximum of three email addresses**.",
      optional: true,
    },
    emailCc: {
      type: "string[]",
      label: "Email Cc",
      description: "A list of email addresses to receive the payout details upon successful payout. **Maximum of three email addresses**.",
      optional: true,
    },
    emailBcc: {
      type: "string[]",
      label: "Email Bcc",
      description: "A list of email addresses to receive a hidden copy of the payout details upon successful payout. **Maximum of three email addresses**.",
      optional: true,
    },
    metadata: {
      type: "object",
      label: "Metadata",
      description: "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: true,
    },
  },
  async run({ $ }) {
    const response = await this.xendit.createPayout({
      $,
      headers: {
        "idempotency-key": uuidV7(),
      },
      data: {
        reference_id: this.referenceId,
        channel_code: this.channelCode,
        channel_properties: {
          account_holder_name: this.accountHolderName,
          account_number: this.accountNumber,
          account_type: this.accountType,
        },
        amount: parseFloat(this.amount),
        description: this.description,
        currency: this.currency,
        receipt_notification: {
          email_to: this.emailTo,
          email_cc: this.emailCc,
          email_bcc: this.emailBcc,
        },
        metadata: parseObject(this.metadata),
      },
    });

    $.export("$summary", `A new payout with ID: ${response.id} was successfully created!`);
    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
Xendit	`xendit`	`app`	This component uses the Xendit app.
Reference ID	`referenceId`	`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.
Channel Code	`channelCode`	`string`	Channel code of destination bank, e-wallet or OTC channel. List of supported channels can be found here
Account Holder Name	`accountHolderName`	`string`	Name of account holder as per the bank or e-wallet's records. Needs to match the registered account name exactly.
Account Number	`accountNumber`	`string`	Account number of destination. Mobile numbers for e-wallet accounts.
Account Type	`accountType`	`string`	Account type of the destination for currencies and channels that supports proxy transfers (ie: Using mobile number as account number)
Amount	`amount`	`string`	Amount to be sent to the destination account. Should be a multiple of the minimum increment for the selected channel.
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.
Currency	`currency`	`string`	ISO 4217 Currency Code.
Email To	`emailTo`	`string[]`	A list of email addresses to receive the payout details upon successful payout. Maximum of three email addresses.
Email Cc	`emailCc`	`string[]`	A list of email addresses to receive the payout details upon successful payout. Maximum of three email addresses.
Email Bcc	`emailBcc`	`string[]`	A list of email addresses to receive a hidden copy of the payout details upon successful payout. Maximum of three email addresses.
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.