POST /payments/refunds - Fanfare Documentation

POST

payments

refunds

cURL

curl --request POST \
  --url https://checkout.fanfare.io/api/payments/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "success": true,
  "refund": {}
}

Authorizations

Authorization

string

header

required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json

amount

string

required

idempotencyKey

string<uuid>

required

orderId

string<uuid>

required

reason

string

Response

Refund request accepted

success

boolean

required

refund

object

Show child attributes

Beacon APIReference for browser event collection endpoints.

cURL

curl --request POST \
  --url https://checkout.fanfare.io/api/payments/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "success": true,
  "refund": {}
}