Testing with Test Products
Use Test Products on the production API to run a real check, order, and code delivery without listing those SKUs in a normal catalog sync. This is not a separate API host and not a second set of API keys.
What this is
- Your live CardPlusPay API key and wallet.
- Catalog rows with
product_typetest(shown as Test Products). - A small charged price (for example
0.01USD) that is debited from your wallet like any other order. - Delivered codes on success, the same way as other gift-card SKUs.
Test Products are omitted from the member catalog and shop, and from GET /v1/catalog unless you ask for them.
Prerequisites
- An approved CardPlusPay account. Apply here if you do not have one.
- An API key from the dashboard. See Authentication.
- Wallet balance at least as large as the Test Product charged price.
1. List Test Products
Endpoint: GET https://api.cardpluspay.com/v1/catalog?include_test=1
Without include_test=1, Test Products are excluded even if you pass item_id. With the flag, each matching active product includes item_code (and the rest of the usual catalog fields). You can also filter product_type=test together with include_test=1.
curl -X GET "https://api.cardpluspay.com/v1/catalog?include_test=1&per_page=50" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Accept: application/json"
Single SKU:
curl -X GET "https://api.cardpluspay.com/v1/catalog?item_id=YOUR-TEST-ITEM-CODE&include_test=1" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Accept: application/json"
Full catalog field list: How to display products.
2. Check availability
Use the item_code from the catalog as item_id on POST /orders/check. Test Products are not skipped here. See check availability.
3. Create the order
Call POST /orders with the same item_code and quantity. The SKU must be active and in stock. The charged amount is deducted from your wallet. Then poll order status if needed and read codes when the order completes. See create an order.
What not to expect
- A separate testing hostname or “sandbox keys”.
- Test Products on the CardPlusPay member shop or member catalog.
- A
$0.00charge — a zero price can be rejected. Use the catalogcharged_price.
← Display products · Integration Guide · Check availability →