List Refunds

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

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first.

Request

Query Parameters

cursor string

Starting ID for pagination

limit int32

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

status string

Filter option: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.

created_at_min string

Filter option: refund initiation start time (unix timestamp)

created_at_max string

Filter option: refund initiation end time (unix timestamp)

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

Response: Refund order list

has_moreboolean

list object[]

List of refund orders

Array [

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)

]

cursorstring

cursor for pagination

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "has_more": true,
    "list": [
      {
        "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"
      }
    ],
    "cursor": "string"
  }
}

400

InvalidParameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

json

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

Example

json

{
  "code": "InvalidParameter",
  "message": "wrong cursor"
}