Refunds

Full or partial refunds.

View as Markdown

Full flow at Refunds & Idempotency.

GET/api/Refund— List refunds
PropertyValue
Required scoperefunds:read
Idempotency-KeyNot required
ParameterInTypeRequired
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/Refund— Request a refund on a payment (requires Idempotency-Key)
PropertyValue
Required scoperefunds:write
Idempotency-KeyRequired
Financial mutationYes — moves money
ParameterInTypeRequired
amountbodyinteger (int32)
paymentIdbodystring
reasonbodystring
GET/api/Refund/{refundId}— Retrieve a single refund
PropertyValue
Required scoperefunds:read
Idempotency-KeyNot required
ParameterInTypeRequired
refundIdpathstringRequired