Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Payment

Create a refund

Creates a new refund for a payment

post/api/payment/{paymentId}/refund

Path parameters

paymentIdstring required

Request body

reasonstring

The refund reason

amountInCentsnumber

Amount to refund in cents (HT, tax-exclusive — same basis as payment.amount). The PSP is refunded the gross amount (HT + applicable tax). When omitted, refunds the full remaining refundable amount. Multiple partial refunds are supported as long as their sum does not exceed the original captured base amount.

Example request

{
  "reason": "Refund for a failed payment",
  "amountInCents": 1500
}

Response

Create a refund successful

object required