@setarnv/directus-extension-payaw v1.0.3

Directus Pay.aw Extension

This Directus extension integrates Pay.aw, Aruba’s mobile payment platform, directly into your Directus instance.

What is Pay.aw?

Pay.aw is a popular Aruban payment solution allowing users to send and receive money using their mobile phones. It's widely used across the island for both peer-to-peer and commercial transactions.

Features

• Integrates Pay.aw payment gateway with Directus.
• Provides custom payment fields and status tracking.
• Allows payment triggering via flows.
• Automatically installs database tables for transaction management.

Pay.aw Settings

After installation, you can configure the extension in the Directus settings panel under Pay.aw Settings.

These include:

• API Host: The Pay.aw endpoint to use.
• API Key and Secret: Your credentials provided by Pay.aw.
• Status Poll Interval: How often to check transaction status (in ms).

Installed Tables

When the extension is installed, the following data models are added to your Directus project:

• payaw_meta_info: Contains metadata such as the extension version.
• payaw_transactions: Stores all transaction records and states.

Usage

To initiate payments, use the "Pay with Pay.aw" operation available in the flows builder.

Operation Options

• Phone Number: The user’s Pay.aw ID (an Aruban phone number).
• Amount: The amount to charge.
• Description: Shown to the user in the Pay.aw app via push notification.

These options support dynamic templating using Directus flow context variables, for example:

• {{$trigger.user_phone_number}}
• {{$last.value}}
• Static values like "2971234567" or "Payment for invoice #123"

Operation Setup Example

Below is an example showing how to configure the operation inputs using values from the trigger payload in the data chain:

Example

Below is a visual example of the Pay with Pay.aw flow operation in use within a Directus flow:

Result

The operation adds a payaw_transactions entry and outputs the result under the key defined in the operation block.

Refer to the Directus documentation for more on flow operations and data output.