Refund a deposit

Authorization

string

header

required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

X-Idempotency-Key

string<uuid>

required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

X-Trace-Version

string

API version. Omit to use the default version.

Example:

"1"

operationId

string<uuid>

required

UUID of the operation.

application/json

Request to refund a completed deposit. The refund is always for the full deposit amount and returns the funds to the original payer.

motive

object

required

Why the deposit is being refunded. Recorded as the reason on the operation's REFUNDED state.

Show child attributes

Refund accepted for processing. No response body. Poll GET /v1/operations/{operationId} to follow the deposit to REFUNDED.