v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB

Transactions

Refund a payment transaction

This is the endpoint to refund a transaction on any of the supported providers. Full as well as partial refunds are supported, so it is not mandatory to inform the total value of the original transaction in the case of a full refund. Note: While the parameters within the body are optional, you must at least pass in a valid JSON body, e.g. { }.

post/payments/transactions/{id}/refund

Path parameters

idstring required

Unique identifier of the transaction to be refunded

Headers

X-Idempotency-Keystring uuid

Meld-Passthrough-Referencestring

Meld-Passthrough-Key-Idstring

Meld-Passthrough-Key-Publicstring

Meld-Passthrough-Key-Privatestring

Meld-Passthrough-Oauthstring

Request body

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

reasonstring

Reason for the refund

sourceAmountnumber required

Amount to be refunded. Can be a partial refund. If not provided, a refund for the total value will be submitted

Response

Payment successfully refunded