Skip to Content
FastracDocs
API reference

List balance logs

GET
/b2b/user-balance/logs

Lists every credit and debit on your balance, newest first: order payments, refunds of cancelled shipments, price adjustments, return (RTS) fees, COD proceeds and top-ups. Use it to reconcile your balance with your own records.

Any valid API key can call it; no extra permission is needed.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An access token from the OAuth2 client-credentials grant. Exchange your API key (client_id + client_secret) at the token endpoint and send Authorization: Bearer <access_token>.

Query Parameters

type?string

Only credits (money in) or debits (money out).

Value in"CREDIT""DEBIT"
shipmentId?string

Text search on description. Pass a shipment code, order code or airway bill to find the logs that mention it.

Lengthlength <= 50
startDate?string

Logs at or after this time. ISO 8601; include an offset.

Formatdate-time
endDate?string

Logs at or before this time. ISO 8601; include an offset.

Formatdate-time
limit?integer

Items per page. Values above 100 are capped at 100.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous page. Omit for the first page.

Response Body

One page of balance logs.

application/json
  1. response
statusCode*integer
message*string
data*
Example Request
curl -X GET 'https://sandbox-api.fastrac.example/b2b/user-balance/logs'
Example Response
{  "statusCode": 200,  "message": "Request successful.",  "data": {    "logs": [      {        "id": 77120,        "userId": 512,        "type": "CREDIT",        "amount": 12984,        "description": "Cancel shipment SHP-261120-P4T7W2 for order FSO-261120-D4E5F6 (wallet refund)",        "createdAt": "2026-11-20T04:10:00.000Z",        "cursor": "NzcxMjA="      },      {        "id": 77098,        "userId": 512,        "type": "DEBIT",        "amount": 12984,        "description": "Payment for order FSO-261120-A1B2C3 shipment SHP-261120-K9M2Q7",        "createdAt": "2026-11-20T02:05:12.000Z",        "cursor": "NzcwOTg="      }    ],    "nextCursor": null  }}

Was this page helpful?