Docs Navigation
List Programs
Endpoint structure for fetching programs under a merchant account.
POST
/api/integrations/merchant/programs/listList programs by merchant id.
Request Fields
Field
Type
Required
Description
merchantIdstring
Yes
Merchant id used to fetch related programs.
Response Fields
Field
Type
Description
codenumber
Response code.
successboolean
Present when the program list is returned successfully.
programsarray
Program list returned for the merchant.
messagestring
Human-readable summary.
Response Codes
Yuter standardizes the booking integration response into four top-level codes so merchant-side documentation and cashier UI can stay simple.
Code
Meaning
Notes
1
Success
The booking is valid or redeemed successfully.
2
Already redeemed
The booking has already been redeemed before this request.
3
Invalid booking
The booking id is invalid or the booking record cannot be found.
4
Other errors
Authentication failed, booking not redeemable, merchant not allowed, or other controlled failure.
List Programs cURL
Request and response for the list programs endpoint.
cURL example
API_KEY='<raw merchant api key>'
MERCHANT_ID='<merchant id>'
TIMESTAMP=$(($(date +%s) * 1000))
NONCE=$(uuidgen)
BODY='{"merchantId":"'"$MERCHANT_ID"'"}'
PATH='/api/integrations/merchant/programs/list'
PAYLOAD="POST
$PATH
$TIMESTAMP
$NONCE
$BODY"
SIGNATURE=$(printf "%s" "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_KEY" -hex | sed 's/^.* //')
curl -X POST "https://www.yuterwellness.com$PATH" \
-H "Content-Type: application/json" \
-H "x-api-key: $API_KEY" \
-H "x-timestamp: $TIMESTAMP" \
-H "x-nonce: $NONCE" \
-H "x-signature: $SIGNATURE" \
-d "$BODY"Response Example
{
"code": 1,
"success": true,
"message": "Programs fetched successfully",
"programs": [
{
"_id": "69ce982e96a5b33a356ab001",
"title": "Private Merchant Test Event"
}
]
}