Create a New Charge with OPN (formerly Omise) API on New Customer Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for OPN (formerly Omise), WooCommerce and 2,200+ other apps remarkably fast.

Trigger workflow on

New Customer Event (Instant) from the WooCommerce API

Next, do this

Create a New Charge with the OPN (formerly Omise) 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 WooCommerce trigger and OPN (formerly Omise) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Customer Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create a New Charge action
1. Connect your OPN (formerly Omise) account
2. Configure Amount
3. Select a Currency
4. Optional- Select a Authorization Type
5. Optional- Configure Capture
6. Optional- Select a Customer ID
7. Optional- Select a Card
8. Optional- Configure Description
9. Optional- Configure Expires At
10. Optional- Configure IP
11. Optional- Configure Metadata
12. Optional- Configure Platform Fee
13. Optional- Configure Return URI
14. Optional- Configure Source ID
15. Optional- Configure Webhook Endpoints
16. Optional- Configure Zero Interest Installments
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 Customer Event (Instant) on WooCommerce

Description:Emit new event each time the specified customer event(s) occur

Version:0.0.3

Key:woocommerce-new-customer-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-customer-event",
  name: "New Customer Event (Instant)",
  description: "Emit new event each time the specified customer event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCustomers({
        per_page: perPage,
        orderby: "registered_date",
      });
    },
    getTopic(topicType) {
      return `customer.${topicType}`;
    },
    generateMeta(eventType, {
      id, username, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Customer "${username || id}" ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create a New Charge on OPN (formerly Omise)

Description:Create a new charge for a specific customer and amount through the OPN platform. [See the documentation](https://docs.opn.ooo/charges-api#create)

Version:0.0.1

Key:omise-create-charge

View on GitHub

OPN (formerly Omise) Overview#

The OPN API, previously known as Omise, provides a powerful suite of features for handling online payments, from processing transactions to managing payment methods. With Pipedream's integration capabilities, you can automate various aspects of payment operations, link payment events to other services, and streamline financial workflows without the need for extensive coding.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import omiseApp from "../../omise.app.mjs";

export default {
  key: "omise-create-charge",
  name: "Create a New Charge",
  description: "Create a new charge for a specific customer and amount through the OPN platform. [See the documentation](https://docs.opn.ooo/charges-api#create)",
  version: "0.0.1",
  type: "action",
  props: {
    omiseApp,
    amount: {
      propDefinition: [
        omiseApp,
        "amount",
      ],
    },
    currency: {
      propDefinition: [
        omiseApp,
        "currency",
      ],
    },
    authorizationType: {
      type: "string",
      label: "Authorization Type",
      description: "The type of the authorization for the charge.",
      options: [
        "pre_auth",
        "final_auth",
      ],
      optional: true,
    },
    capture: {
      propDefinition: [
        omiseApp,
        "capture",
      ],
      optional: true,
    },
    customer: {
      propDefinition: [
        omiseApp,
        "customerId",
      ],
      optional: true,
    },
    card: {
      propDefinition: [
        omiseApp,
        "card",
        ({ customer }) => ({
          customer,
        }),
      ],
      description: "An unused token identifier to add as a new card to the charge.",
      optional: true,
    },
    description: {
      propDefinition: [
        omiseApp,
        "description",
      ],
      description: "Charge description. Supplying information about a purchase (e.g. number of items, type of items, date of delivery) helps Opn Payments better conduct fraud analysis.",
      optional: true,
    },
    expiresAt: {
      type: "string",
      label: "Expires At",
      description: "UTC datetime of desired charge expiration in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format `(YYYY-MM-DDThh:mm:ssZ)`.",
      optional: true,
    },
    ip: {
      type: "string",
      label: "IP",
      description: "IP address to attach to the charge. Supplying the customer's real IP address helps Opn Payments better conduct fraud analysis. May be IPv4 or IPv6.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        omiseApp,
        "metadata",
      ],
      description: "Custom metadata (e.g. `{\"answer\": 42}`) for charge.",
      optional: true,
    },
    platformFee: {
      type: "object",
      label: "Platform Fee",
      description: "Platform fee object as `fixed` amount and/or `percentage` of charge amount.",
      optional: true,
    },
    returnUri: {
      propDefinition: [
        omiseApp,
        "returnUri",
      ],
      optional: true,
    },
    source: {
      propDefinition: [
        omiseApp,
        "sourceId",
      ],
      optional: true,
    },
    webhookEndpoints: {
      type: "string[]",
      label: "Webhook Endpoints",
      description: "URLs to which charge notifications are to be sent. This field can contain a maximum of two URLs.",
      optional: true,
    },
    zeroInterestInstallments: {
      type: "boolean",
      label: "Zero Interest Installments",
      description: "Whether merchant absorbs the interest for installment payments; must match value in associated source.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.card && !this.customer && !this.source) {
      throw new ConfigurationError("`Source` is required if `card` and `customer` are not present.");
    }
    const {
      omiseApp,
      authorizationType,
      expiresAt,
      platformFee,
      returnUri,
      webhookEndpoints,
      zeroInterestInstallments,
      ...data
    } = this;
    const response = await omiseApp.createCharge({
      $,
      data: {
        ...data,
        authorization_type: authorizationType,
        expires_at: expiresAt,
        platform_fee: parseObject(platformFee),
        return_uri: returnUri,
        webhook_endpoints: parseObject(webhookEndpoints),
        zero_interest_installments: zeroInterestInstallments,
      },
    });

    $.export("$summary", `Successfully created a new charge with ID: ${response.id}`);
    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
OPN (formerly Omise)	`omiseApp`	`app`	This component uses the OPN (formerly Omise) app.
Amount	`amount`	`integer`	The amount for the charge in the smallest currency unit.
Currency	`currency`	`string`	Select a value from the drop down menu:`{ "label": "Japan", "value": "JPY" }{ "label": "Malaysia", "value": "MYR" }{ "label": "Singapore", "value": "SGD" }{ "label": "Thailand", "value": "THB" }`
Authorization Type	`authorizationType`	`string`	Select a value from the drop down menu:`pre_authfinal_auth`
Capture	`capture`	`boolean`	Whether the charge is set to be automatically captured (paid). Valid only for credit and debit card charges.
Customer ID	`customer`	`string`	Select a value from the drop down menu.
Card	`card`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Charge description. Supplying information about a purchase (e.g. number of items, type of items, date of delivery) helps Opn Payments better conduct fraud analysis.
Expires At	`expiresAt`	`string`	UTC datetime of desired charge expiration in ISO 8601 format `(YYYY-MM-DDThh:mm:ssZ)`.
IP	`ip`	`string`	IP address to attach to the charge. Supplying the customer's real IP address helps Opn Payments better conduct fraud analysis. May be IPv4 or IPv6.
Metadata	`metadata`	`object`	Custom metadata (e.g. `{"answer": 42}`) for charge.
Platform Fee	`platformFee`	`object`	Platform fee object as `fixed` amount and/or `percentage` of charge amount.
Return URI	`returnUri`	`string`	The URI to which the customer is redirected after authorization. Required if `card` and `customer` are not present.
Source ID	`source`	`string`	A valid source identifier or source object
Webhook Endpoints	`webhookEndpoints`	`string[]`	URLs to which charge notifications are to be sent. This field can contain a maximum of two URLs.
Zero Interest Installments	`zeroInterestInstallments`	`boolean`	Whether merchant absorbs the interest for installment payments; must match value in associated source.

Action Authentication#

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

To retrieve your API keys,

Navigate to your OPN (formerly Omise) account and sign in
Go to “API” > “Keys”

Create a New Charge with OPN (formerly Omise) API on New Customer Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for OPN (formerly Omise), WooCommerce and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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