Skip to main content
POST
Refund an in document

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Path Parameters

id
string<uuid>
required

In document Unique identifier

Body

application/json

Refund creation attributes

Refund creation body params

amount
integer
required

Amount in cents

Required range: x >= 1
description
string
required

Description of refund

Response

Document

Created in document refund response

data
V2 created in document refund · object

Refund requested for an in document. trio-spi creates it asynchronously; read it back through GET /v2/documents/in/refunds/{id} for its details and final state.

Example: