Skip to main content
POST
Refund a payment transaction

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Headers

X-Idempotency-Key
string<uuid>
Meld-Passthrough-Reference
string
Meld-Passthrough-Key-Id
string
Meld-Passthrough-Key-Public
string
Meld-Passthrough-Key-Private
string
Meld-Passthrough-Oauth
string

Path Parameters

id
string
required

Unique identifier of the transaction to be refunded

Minimum string length: 1

Body

application/json
sourceAmount
number
required

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

Required range: x >= 0
description
string

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

reason
string

Reason for the refund

Response

Payment successfully refunded

transaction
object

Payment transaction information