Skip to main content
POST
Create a refund

Authorizations

x-api-key
string
header
required

Your API key. Public production API-key endpoints accept kyren_live_* keys. Staging credentials are environment-specific and must be used only with the staging environment for which Kyren issued them.

Path Parameters

orderId
string
required

The Kyren order ID to refund

Body

application/json
amount
string
required

Refund amount as a decimal string. Must be greater than 0 and not exceed the remaining refundable amount.

reason
string | null

Optional refund reason.

refundNo
string | null

Optional merchant refund number used for idempotency.

Response

Refund request accepted or processed

code
integer
Example:

0

message
string
Example:

"success"

data
object