/v1/orders/{id}/refund

post

https://api-sandbox.flexfactor.io/v1/orders/{id}/refund

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The FlexFactor order ID returned by /evaluate.

Body Params

idempotencyKey

uuid | null

Optional idempotency key. Resubmit the same refund with the same key to retry safely — the
original result is returned instead of issuing a second refund. Omit it only if you do not
need retry-safety.

isConsumerRequestedRefund

boolean

true when the cardholder requested the refund.

amountToRefund

double

deprecated

Deprecated — use amount (minor units / cents) instead. Refund amount in the order's
major currency unit (for example, dollars).

amount

int32 | null

Amount to refund, in cents. Send amount or amountToRefund, not both. A request with neither fails validation with HTTP 400.

refundMessage

string | null

Free-text message stored with the refund, for example the reason.

supportedGatewayId

uuid | null

FlexFactor identifier of the gateway that processes the refund.

transactionId

uuid | null

FlexFactor identifier of the transaction to refund.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

500

Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad Request. The request failed validation; the body names the fields in error.

404Not Found

409Conflict. An idempotent request with the same key is still in progress, or the idempotency key was reused with a materially different payload.

503Service Unavailable. The duplicate-request check is temporarily unavailable; honor the Retry-After header and retry.