Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
q) Payments

Initiate a payment refund

Processes a partial or full refund. The refund amount cannot exceed the original payment amount.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/payments/{paymentId}/refunds

Path parameters

tenantIdinteger required
paymentIdinteger required

Request body

amountnumber required

The amount in the currency of the existing payment

callbackUrlstring
descriptionstring

Optional. Description or reason for the refund

externalUniqueIdstring required

Unique identifier for the refund. Duplicates are rejected to ensure double transactions are impossible. Note: This is NOT the externalUniqueId of the original payment

Response

OK

amountnumber
createdstring date-time
descriptionstring
errorDescriptionstring

This will only be populated if there was an error

externalUniqueIdstring
gatewayTransactionIdstring
lastModifiedstring date-time
paymentIdinteger
refundIdinteger
statusstring

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "lastModified": "2022-03-10T12:15:50-04:00"
}