For the complete documentation index, see llms.txt. This page is also available as Markdown.

Refund Request APIs

Refund Request APIs provide merchants with the ability to initiate and track the return of collected funds back to the original payer when a transaction needs to be reversed. By leveraging NeoX Global Collections' refund infrastructure, merchants can manage refund lifecycles programmatically without manual intervention, ensuring a seamless experience for both the merchant and the end customer.

By integrating with these APIs, organizations can:

  • Initiate refunds programmatically: Submit a refund request against any eligible collection transaction (identified by orderId) using a single API call, specifying who bears the refund transfer fee.

  • Track refund outcomes asynchronously: Receive real-time refund status updates via the TRADE_COLLECTION_REFUND_PROCESS/TRADE_COLLECTION_REFUND_SUCCESS webhook events, eliminating the need for constant polling. See Webhook.

  • Monitor collection transaction state: Observe refund progress directly on the related collection transaction, which transitions through REFUND_PROCESS and REFUND_SUCCESS states as the refund progresses — see Get Detail Collection Order.

  • Ensure idempotent operations: Use a merchant-generated requestId (UUID) on every refund submission to safely retry requests without creating duplicate refunds.

In essence, Refund Request APIs empower you to automate the full refund lifecycle — from initiation through final settlement confirmation — within your existing payments workflow.

Available Endpoints

Endpoint
Method
Description

POST

Initiate a refund for an incoming collection order.

Last updated

Was this helpful?