Skip to content

API overview

Use this base URL for every request:

text
https://taura.xashpay.com/api/v1

The examples use TOKEN as a placeholder for your API key.

Authentication

Send a Bearer token with every request:

http
Accept: application/json
Content-Type: application/json
Authorization: Bearer TOKEN

Content-Type is only needed when the request has a JSON body. Create and revoke tokens under Profile & API Keys in the panel. Contact Xash support if you need access.

Endpoints

MethodPathPurpose
GET/meCheck the account linked to the token
GET/wallet/balanceCheck the current wallet balance
GET/wallet/transactionsList wallet activity
GET/vendor/fundingsList funding history
GET/taura/topupsList Taura top-ups
POST/taura/topupsCreate a Taura top-up
GET/reports/summaryRead wallet and top-up totals

Response format

Responses are JSON objects. A single record uses a singular key, such as topup. A list uses a plural key, such as topups.

json
{
  "topup": {
    "uuid": "2236170a-85fb-4354-ab0b-941871ecfab0",
    "status": "completed"
  }
}

Identifiers are UUID strings and timestamps use ISO 8601. See Errors for unsuccessful requests.

Amounts

Wallet balances and Taura top-ups use UNITS. Send top-up amounts as positive numbers.

Rate limiting

POST /taura/topups accepts up to 30 requests per minute. A request over the limit returns HTTP 429. Wait for the Retry-After period, then retry with the same ref.

Pagination

List endpoints accept page and per_page and return the newest records first.

  • Wallet transactions accept per_page from 1 to 100 and return pagination details in meta.
  • Top-ups and fundings use a default per_page value of 20. An empty list means there are no more records on that page.

Check your token

GET/api/v1/me

Use /me to confirm which account is linked to the token.

bash
curl "https://taura.xashpay.com/api/v1/me" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer TOKEN"

Typical integration

  1. Check GET /wallet/balance.
  2. Create a top-up with a unique ref.
  3. Read the returned status before updating the customer order.
  4. Store the top-up uuid and your ref.
  5. Use the list and report endpoints when you need to review activity.

Taura Xashpay vendor API documentation. Contact Xash support for access.