Skip to content

Get refund detail

Get a single refund record. Same shape as a single entry in the list response.

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

Authorizations

agentJwt

Agent registration JWT. Send as Authorization: Bearer <agent-jwt>.

Type
HTTP (bearer)

Responses

Refund record.

application/json

Response for the refund detail endpoint. Same shape as a single list entry.

A refund record.

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

Released under the MIT License.