View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.

`RefundInvoiceInput`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Input for the operator-facing refund of an invoice's collected payments.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

reason required

string

Operator-supplied reason for the refund. Recorded on the refund entry and on the invoice's activity timeline, and threaded onto the gateway operation's audit note. nullablemax length 500

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

idempotencyKey required

string

Optional caller-supplied idempotency key. When omitted, the service derives a deterministic key per refunded payment so a retry after a timeout replays the original outcome rather than returning the money twice. Conditional: When IdempotencyKey is not empty. Pattern: ^[A-Za-z0-9._:-]+$. nullablemax length 128

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.