Get Refund

GET 
/openapi/2024-07/shoplazza-payment/refunds/:id

Retrieves the details of an existing refund.

Request

Path Parameters

id stringrequired

refund order id

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

Response: Refund order

refund_order object

refund order

idstring

Refund order ID

store_idstring

Store ID

balance_currencystring

Settlement account currency

transaction_order_idstring

Associated transaction order ID

statusstring

Refund status (e.g., "succeeded", "failed", "processing") succeeded: The refund was successfully processed, and the funds have been returned to the payer. failed: The refund attempt failed, and no funds were returned to the payer. processing: The refund is currently being processed, and the final result is pending confirmation.

amountstring

Refund amount

currencystring

Transaction currency

original_order_amountstring

Original order total amount

created_atstring

Refund initiation time (unix timestamp)

completed_atstring

Refund completion time (unix timestamp)

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "refund_order": {
      "id": "string",
      "store_id": "string",
      "balance_currency": "string",
      "transaction_order_id": "string",
      "status": "string",
      "amount": "string",
      "currency": "string",
      "original_order_amount": "string",
      "created_at": "string",
      "completed_at": "string"
    }
  }
}

500

UnknownError

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

{
  "code": "string",
  "message": "string"
}

Example

{
  "code": "InvalidParameter",
  "message": "Unknown error, please contact shoplazza technical support to resolve the issue."
}