ATH Móvil Tool icon

ATH Móvil Tool

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

Actions6

Cancel Payment

AI-generated

Overview

This node integrates with ATH Móvil, Puerto Rico's mobile payment platform, to manage payment transactions. Specifically, the 'Cancel Payment' operation allows users to cancel a pending payment transaction that has not been completed. This is useful in scenarios where a payment was initiated but needs to be voided before completion, such as customer cancellation or error correction.

Use Case Examples

  1. Cancel a pending payment transaction using the transaction ID (ecommerceId) obtained from a previous payment creation.
  2. Use this operation to ensure that incomplete or unwanted payment transactions do not proceed to completion.

Properties

Name Meaning
Ecommerce ID The transaction ID returned from the Create Payment operation, used to identify the payment transaction to cancel.

Output

JSON

  • status - The status of the cancellation request, indicating success or failure.
  • message - A message providing additional details about the cancellation result.
  • ecommerceId - The transaction ID of the payment that was requested to be canceled.

Dependencies

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

Troubleshooting

  • Common issues include providing an invalid or already completed ecommerceId, which will prevent cancellation.
  • Errors may occur if the payment is already completed or if the API credentials are incorrect or missing.
  • Error messages from the ATH Móvil API are parsed and returned; ensure the ecommerceId is correct and the payment is still pending before attempting cancellation.

Links

Discussion