Skip to content

Get refund detail

GET
/api/payment-links/refunds/{refundId}

Responses​

Refund.

application/json

Refund.

Refund ID (plr_…).

Refund link; set only while pending.

Original payment ID.

Payment Link ID; null for UPL.

Valid values"payment_link""unify_payment_link"

Atomic.

Your receiving address.

Original payer.

Refund status; treat unknown values as processing.

Valid values"pending""processing""settled""failed""expired""cancelled"

Refund transaction hash.

Valid values"full""partial"

Reason.

Original payment amount.

Original transaction hash.

Initiating agent.

Refund link expiry.

Created at.

{
  "refundId": "<string>",
  "refundUrl": "<string>",
  "paymentId": "<integer>",
  "linkId": "<string>",
  "sourceType": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "refundFrom": "<string>",
  "refundTo": "<string>",
  "status": "<string>",
  "refundTxHash": "<string>",
  "refundType": "<string>",
  "reason": "<string>",
  "originalAmount": "<string>",
  "originalTxHash": "<string>",
  "agentName": "<string>",
  "expiresAt": "<string>",
  "createdAt": "<string>"
}

Released under the MIT License.