API Reference

Update Refund

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

OR
AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Path parameters

refundstringRequiredformat: "^re_.+"

Headers

Idempotency-KeystringOptional1-255 characters

Makes a POST safely retryable according to that operation’s documented idempotency policy. The durable 24-hour journal applies only where the resource documentation explicitly claims it. Reusing a key with different parameters or another endpoint returns an idempotency error.

Request

This endpoint expects an object.
metadatamap from strings to stringsOptional

Stripe-compatible public metadata: at most 50 merchant-visible entries, with keys up to 40 characters and string values up to 500 characters. Server-owned fluveo_ stamps are not part of the public allowance and are never returned.

Response

Stripe-compatible response

amountinteger
balance_transactionobject or string or null
chargeobject or string or null
createdinteger
currencystringformat: "currency"
idstringformat: "^re_.+"<=5000 characters

Fluveo narrowing: not in upstream pin; truthful public id-prefix constraint: re_.

metadatamap from strings to strings or null
objectenum

Fluveo narrowing annotation: truthful single-value public object constant.

payment_intentobject or string or null
reasonenum or null
receipt_numberstring or null<=5000 characters
source_transfer_reversalobject or string or null
statusstring or null<=5000 characters
transfer_reversalobject or string or null
descriptionstringOptional<=5000 characters
destination_detailsobjectOptional
failure_balance_transactionobject or stringOptional
failure_reasonstringOptional<=5000 characters
instructions_emailstringOptional<=5000 characters
next_actionobjectOptional
pending_reasonenumOptional
presentment_detailsobjectOptional