Skip to main content
POST
/
merchant
/
checkout
/
list
Get Merchant Checkout list
curl --request POST \
  --url https://api.unibee.dev/merchant/checkout/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "SearchKey": "<string>"
}
'
{
  "code": 123,
  "data": {
    "merchantCheckouts": [
      {
        "createTime": 123,
        "data": {},
        "description": "<string>",
        "id": 123,
        "isDefault": true,
        "merchantId": 123,
        "name": "<string>",
        "stagingData": {},
        "updateTime": 123
      }
    ]
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/checkout/list Get Merchant Checkout list

Authorization

All UniBee Merchant API requests require authentication via API key.
HeaderRequiredDescription
AuthorizationYesBearer <your_api_key>
Content-TypeYesapplication/json (for request body)

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body

NameTypeRequiredDescription
SearchKeystringNoSearch checkout id|name|description

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/checkout/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchKey": ""
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/checkout/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchKey": ""
}'

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.
FieldTypeDescription
codeintegerResponse code. 0 = success
dataobjectResponse payload
data.merchantCheckoutsarrayMerchantCheckout List Object
messagestringHuman-readable message
requestIdstringRequest ID for support

Error handling

HTTP statusMeaning
400Bad request — invalid or missing parameters. Check message in the body.
401Unauthorized — missing or invalid API key.
404Not found — invalid path or resource.
500Server error — retry with backoff.
When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
SearchKey
string<string>

Search checkout id|name|description

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>