API de conta2026-11Prévia

Saldo

O dinheiro com que os seus pedidos são pagos, em CN¥. Você recarrega no ninjabuy.com; a API o lê e nunca cobra um cartão.

Um pedido que o seu saldo não cobre espera como awaiting_payment e segue sozinho depois de uma recarga.
Os reembolsos, por um pedido cancelado ou uma linha que não conseguimos comprar, voltam para o saldo. Taxas lista cada cobrança.

Endpoints

GET/v1/balanceObter o saldo
GET/v1/balance/transactionsListar transações

O objeto Balance

availablemoney: O que os novos pedidos podem gastar, em CN¥.
reservedmoney: Reservado para pedidos sendo comprados e pacotes aguardando pesagem.
top_up_urlstring: Onde você adiciona dinheiro, conectado no 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"
}

Obter o saldo

GET/v1/balance

Consulte antes de enviar um lote grande de pedidos.

Escopobalance: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"
}

Listar transações

GET/v1/balance/transactions

Recargas, cobranças de pedidos e de frete, e reembolsos, dos mais recentes aos mais antigos. Os valores têm sinal: uma cobrança é negativa.

Escopobalance:read

Parâmetros de consulta

typestring: Opcional. top_up, order, shipping ou refund.
orderstring: Opcional. Um id de pedido: tudo o que esse pedido movimentou.
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"
}