Cancel Payment
AI-generatedOverview
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
- Cancel a pending payment transaction using the transaction's ecommerce ID to prevent the payment from being processed.
- Use in workflows to automatically cancel payments that remain in a pending state beyond a certain time limit.
Properties
| Name | Meaning |
|---|---|
| Ecommerce ID | The transaction ID returned from the Create Payment operation, used to identify the payment to cancel. |
Output
JSON
ecommerceId- The transaction ID of the payment that was cancelled.status- The status of the payment transaction after cancellation, typically indicating it is cancelled.message- A message from the ATH Móvil API confirming the cancellation or providing additional information.
Dependencies
- Requires ATH Móvil API credentials including a public token for authentication.
Troubleshooting
- Common issues include providing an invalid or non-existent ecommerce ID, which will cause the cancellation to fail.
- Attempting to cancel a payment that is already completed or does not exist will result in an error from the ATH Móvil API.
- Ensure the API credentials are correctly configured and have the necessary permissions to perform cancellation operations.
Links
- ATH Móvil Developer Documentation - Official documentation for ATH Móvil API, including payment transaction management.