Get a refund

Retrieves a single refund by ID.

GET /v1/refunds/{id}

curl

cURL

curl https://api.paybridgenp.com/v1/refunds/ref_01j9x2k3m4n5p6q7r8s9t0u1v2 \
  -H "Authorization: Bearer pk_sandbox_your_key"

200

{
  "id": "ref_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "livemode": true,
  "paymentId": "pay_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "projectId": "<string>",
  "mode": "sandbox",
  "amount": 10000,
  "currency": "NPR",
  "reason": "customer_request",
  "status": "processing",
  "providerRefundId": "<string>",
  "failureReason": "<string>",
  "notes": "<string>",
  "mobileNumber": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Your PayBridge API key. Obtain one from the dashboard under Settings → API Keys. Prefix: pk_sandbox_ for testing, pk_live_ for production.

Path Parameters

id · string · required

Refund ID (prefix: ref_).

Response

200

application/json

Refund object.

id · string

Example:

"ref_01j9x2k3m4n5p6q7r8s9t0u1v2"

livemode · boolean

true when created with a live key, false for sandbox.

paymentId · string

Example:

"pay_01j9x2k3m4n5p6q7r8s9t0u1v2"

projectId · string

mode · enum<string>

Available options: sandbox, live

amount · integer

Refunded amount in paisa.

Example:

10000

currency · string

Example:

"NPR"

reason · enum<string>

Available options: customer_request, duplicate, fraudulent, other

status · enum<string>

succeeded — refund processed. requires_action — eSewa: must be processed manually via merchant portal. failed — provider rejected the refund.

Available options: processing, succeeded, failed, requires_action

providerRefundId · string | null

Provider's refund reference (Khalti only).

failureReason · string | null

Set when status is failed or requires_action.

notes · string | null

mobileNumber · string | null

createdAt · string<date-time>

updatedAt · string<date-time>