Endpoints

FNB Smart Blocked statistics

Returns count and amount totals bucketed by state (pending, released, blocked) over a date range. Defaults to the last 30 days.

POST
/v1/fnbsb/stats

Authorization

bearerAuth
AuthorizationBearer <token>

A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

{
  "pending": {
    "count": 0,
    "amount": 0
  },
  "released": {
    "count": 0,
    "amount": 0
  },
  "blocked": {
    "count": 0,
    "amount": 0
  },
  "fromdate": "2019-08-24T14:15:22Z",
  "todate": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "validation_failed",
    "message": "MINIMUM_EFT_AMOUNT must be numeric.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page