Skip to main content
PATCH
Refund order payment

Authorizations

x-fngs-public-key
string
header
required
x-fngs-secret-key
string
header
required

Path Parameters

orderIdOrNumber
required

PATCH /v0/orders/:orderIdOrNumber/refund Parameter

Body

application/json

PATCH /v0/orders/:orderIdOrNumber/refund Request body

amount
integer<int64>
Required range: x <= 9007199254740991
reason
enum<string>
Available options:
duplicate,
fraudulent,
requested_by_customer
metadata
object
idempotencyKey
string

Optional caller-supplied Stripe idempotency key. Prefer this when retrying after a lost response — a keyless retry of a partial refund can double-refund once amount_refunded has changed.

Required string length: 1 - 255

Response

PATCH /v0/orders/:orderIdOrNumber/refund Positive response

status
string
required
Allowed value: "success"
data
object
required