Refund an invoice

Refunds an invoice. The invoice must currently have a status of paid.If an invoice has a status of created it cannot be refunded, but can be canceled. An invoice can have multiple refunds. The total refunded amount cannot exceed the invoice's amount.

Required scope: write_payments.

Path Params
uuid
required

Podium unique identifier for invoice.

Body Params

Invoice refund params

integer
required
≥ 1

Amount to refund on the invoice, represented in cents.

uuid
required

Podium unique identifier for location.

string

Detailed note for why the refund was initiated.

uuid
required

Podium unique identifier for payment.

string
enum
required

Generic reason for why the refund was initiated.

Allowed:
Responses

Callback
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json