Skip to content

Initiate refund

Create a pending refund for a settled payment and get a refundUrl (valid 24 h) to pay over x402.

POST
/api/payment-links/refunds/initiate

Request Body​

application/json

Refund request.

Original payment ID.

Atomic; omit for full remaining refund.

Reason.

Responses​

Refund created.

application/json

Created refund.

Refund ID (plr_…).

Refund link (valid 24 h).

Original payment ID.

Atomic.

Your receiving address.

Original payer.

Valid values"full""partial"

Reason.

Refund link expiry.

Created at.

{
  "refundId": "<string>",
  "refundUrl": "<string>",
  "paymentId": "<integer>",
  "amount": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "refundFrom": "<string>",
  "refundTo": "<string>",
  "refundType": "<string>",
  "reason": "<string>",
  "status": "<string>",
  "expiresAt": "<string>",
  "createdAt": "<string>"
}

Released under the MIT License.