Skip to main content
POST
/
v1
/
payments
/
{paymentId}
/
refund
Refund a payment
curl --request POST \
  --url https://api.yuvexpay.com/v1/payments/{paymentId}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "amount": 25,
  "reason": "Customer requested refund"
}
'
{
  "refund": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "txId": "<string>",
    "amount": 123,
    "reason": "<string>",
    "processedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Headers

​
X-Idempotency-Key
string
required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.

Maximum string length: 100

Path Parameters

​
paymentId
string<uuid>
required

The payment ID to refund.

Body

application/json
​
amount
number

Refund amount. Omit for a full refund.

Required range: x >= 0.01
​
reason
string

Reason for the refund.

Maximum string length: 500

Response

Refund created.

​
refund
object