Back to the guide

API: services, prices, orders, status and refill

Parameters and responses for published actions.

Last updated:

How it works, step by step

  1. services returns an array including service, name, description, platform, min, max, rate, price_per_item, pricing_unit, refill, cancel and EUR currency. rate is a per-1000 reference, not a quote for every quantity.
  2. Use balance for credit and add with service, link and quantity to order. Keep order, charge and currency from the response. The site’s pricing engine calculates totals including applicable minimums.
  3. Use a stable idempotency_key for each purchase and its retries. It is optional, limited to 120 characters and scoped to the API key.
  4. status accepts order or orders, up to 100 comma-separated numeric IDs, for your own API orders only. start_count and remains are currently null.
  5. refill accepts order and returns a refill identifier if accepted. No refill-status or cancellation action is published; catalog cancel is not an operational endpoint.

Important

API statuses are Pending, In progress, Processing, Partial, Completed and Canceled. Do not infer remaining quantity from null fields or assume refill acceptance.

API examples

services

curl --request POST https://nexwa.store/api/v2 \
  --header "Authorization: Bearer ${NEXWA_API_KEY}" \
  --data-urlencode "action=services"

balance

curl --request POST https://nexwa.store/api/v2 \
  --header "Authorization: Bearer ${NEXWA_API_KEY}" \
  --data-urlencode "action=balance"

add

curl --request POST https://nexwa.store/api/v2 \
  --header "Authorization: Bearer ${NEXWA_API_KEY}" \
  --data-urlencode "action=add" \
  --data-urlencode "service=${NEXWA_SERVICE_ID}" \
  --data-urlencode "link=${NEXWA_TARGET_URL}" \
  --data-urlencode "quantity=${NEXWA_QUANTITY}" \
  --data-urlencode "idempotency_key=${NEXWA_PURCHASE_ID}"

status

curl --request POST https://nexwa.store/api/v2 \
  --header "Authorization: Bearer ${NEXWA_API_KEY}" \
  --data-urlencode "action=status" \
  --data-urlencode "order=${NEXWA_ORDER_ID}"

refill

curl --request POST https://nexwa.store/api/v2 \
  --header "Authorization: Bearer ${NEXWA_API_KEY}" \
  --data-urlencode "action=refill" \
  --data-urlencode "order=${NEXWA_ORDER_ID}"

Public API reference

POST https://nexwa.store/api/v2
ActionParametersResponse
servicesactionArray<{service, name, category, platform, type, rate, price_per_item, pricing_unit, description, min, max, refill, cancel, currency}>
balanceaction{balance, currency}
addaction, service, link, quantity, idempotency_key?{order, charge, currency, balance?} | {order, duplicate: true}
statusaction, order | orders{charge, start_count: null, status, remains: null, currency} | {"<order>": result}
refillaction, order{refill}

Open the feature

API keysPricing

Related articles

Still need a hand?

Open account support for a specific request. If you cannot sign in, email us.

Open supportEmail us