Skip to main content
PUT
/
payments
/
{paymentId}
/
refund
Refund payment
curl --request PUT \
  --url https://api.example.com/payments/{paymentId}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-environment: <x-environment>' \
  --data '{
  "amount": 123
}'
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Headers

​
x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Path Parameters

​
paymentId
string<uuid>
required

Id of payment to refund.

Body

application/json

Refund options.

​
amount
integer<int64> | null

Response

OK