API Compte2026-11Aperçu

Solde

L’argent avec lequel vos commandes sont payées, en CN¥. Vous l’alimentez sur ninjabuy.com ; l’API le lit et ne débite jamais de carte.

Une commande que votre solde ne couvre pas attend en awaiting_payment et repart d’elle-même après une recharge.
Les remboursements, pour une commande annulée ou une ligne que nous n’avons pas pu acheter, reviennent sur le solde. Frais liste chaque frais.

Endpoints

GET/v1/balanceRécupérer le solde
GET/v1/balance/transactionsLister les transactions

L’objet Balance

availablemoney: Ce que les nouvelles commandes peuvent dépenser, en CN¥.
reservedmoney: Réservé pour les commandes en cours d’achat et les colis en attente de pesée.
top_up_urlstring: Où vous ajoutez de l’argent, connecté sur ninjabuy.com.

balance

{
  "available": { "amount": "2140.00", "currency": "CNY" },
  "reserved": { "amount": "264.20", "currency": "CNY" },
  "top_up_url": "https://www.ninjabuy.com/me/balance/top-up",
  "updated_at": "2026-11-04T09:20:03Z"
}

Récupérer le solde

GET/v1/balance

Vérifiez-le avant d’envoyer un gros lot de commandes.

Scopebalance:read

curl "https://www.ninjabuy.com/api/v1/balance" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"

Response 200

HTTP/2 200 OK

{
  "available": { "amount": "2140.00", "currency": "CNY" },
  "reserved": { "amount": "264.20", "currency": "CNY" },
  "top_up_url": "https://www.ninjabuy.com/me/balance/top-up",
  "updated_at": "2026-11-04T09:20:03Z"
}

Lister les transactions

GET/v1/balance/transactions

Recharges, frais de commande et d’expédition, et remboursements, les plus récents d’abord. Les montants sont signés : un débit est négatif.

Scopebalance:read

Paramètres de requête

typestring: Facultatif. top_up, order, shipping ou refund.
orderstring: Facultatif. Un identifiant de commande : tout ce que cette commande a fait bouger.
limit, cursor: Pagination

curl "https://www.ninjabuy.com/api/v1/balance/transactions?limit=3" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"

Response 200

HTTP/2 200 OK

{
  "data": [
    {
      "id": "txn_k22a",
      "type": "shipping",
      "order": "ord_3n7q",
      "amount": { "amount": "-134.52", "currency": "CNY" },
      "created_at": "2026-11-03T05:58:00Z"
    },
    {
      "id": "txn_k21d",
      "type": "order",
      "order": "ord_3n7q",
      "amount": { "amount": "-57.00", "currency": "CNY" },
      "created_at": "2026-11-01T09:14:02Z"
    },
    {
      "id": "txn_k1zz",
      "type": "top_up",
      "order": null,
      "amount": { "amount": "2000.00", "currency": "CNY" },
      "created_at": "2026-10-31T16:40:12Z"
    }
  ],
  "has_more": true,
  "cursor": "c_k1zz"
}