Choose the Documentation MX Merchant MX Connect

Refund a Transaction

Initiate a refund for a completed collection transaction. The refund is processed back to the original source of the funds and creates a new transaction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the original transaction. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the original transaction to refund.

Body Params

Refund details. If amount is omitted, the full transaction amount is refunded.

string

Amount to refund. If omitted, the full original transaction amount is refunded.

string

Free-text purpose for the refund.

string

Reason for the refund (e.g., ON_CUSTOMER_REQUEST).

Headers
string
enum
required

Controls response timing. Use NEVER for an immediate synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses

400

The request could not be processed. The original transaction may not be eligible for a refund.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

404

The requested transaction was not found.

500

An unexpected error occurred on the server while processing the request.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*