ATH Móvil icon

ATH Móvil

Process payments, refunds, and transactions using ATH Móvil, Puerto Rico's mobile payment platform
Join our community

Actions6

Overview

This node integrates with ATH Móvil, Puerto Rico's mobile payment platform, to perform various payment-related operations. Specifically, the 'Create Payment' operation allows users to initiate a new payment transaction by providing details such as the customer's phone number, payment amount, itemized purchase details, and metadata. This operation is useful for e-commerce platforms or businesses that want to process mobile payments seamlessly through ATH Móvil. For example, an online store can use this node to create a payment request for a customer's purchase, including item details and tax information, and receive transaction identifiers for further processing.

Use Case Examples

  1. Creating a payment transaction for a customer purchasing multiple items, specifying item names, prices, quantities, and tax amounts.
  2. Adding metadata to transactions for tracking or reporting purposes.
  3. Setting a custom timeout for the payment transaction to control how long the payment request remains valid.

Properties

Name Meaning
Phone Number The ATH Móvil account phone number of the customer to whom the payment request is sent.
Total The total payment amount to be charged, constrained between 1.00 and 1500.00.
Items A collection of items included in the payment, each with details such as name, description, price, quantity, tax, and optional metadata.
Metadata 1 First metadata field for the transaction, limited to 40 characters.
Metadata 2 Second metadata field for the transaction, limited to 40 characters.
Additional Fields Optional additional parameters for the payment such as transaction timeout (120-600 seconds), total tax amount, and subtotal amount.

Output

JSON

  • ecommerceId - The unique identifier for the created payment transaction, used for future operations.
  • auth_token - Authorization token returned upon payment creation, required for authorizing or refunding payments.
  • status - Current status of the payment transaction (e.g., OPEN, CONFIRM, COMPLETED, CANCEL).
  • details - Additional details about the payment transaction response.

Dependencies

  • Requires an API key credential for ATH Móvil API authentication (publicToken and privateToken).

Troubleshooting

  • Common issues include invalid phone numbers, amounts outside the allowed range (1.00-1500.00), or missing required fields such as metadata or items.
  • Errors from the ATH Móvil API are parsed and returned with descriptive messages; users should ensure correct API credentials and valid input data.
  • Timeout values must be within the specified range (120-600 seconds) to avoid errors.

Links

Discussion