Get Many Non-Payment Reasons
Returns the reasons Nabis drivers recorded for not collecting payment on your organization's
orders, newest first: sorted by createdAt, when the driver recorded the reason.
When a driver is due to collect payment on delivery and the retailer doesn't pay, the driver records why in the Nabis driver app. Each record is one unpaid order on one delivery, so an order can have more than one if payment was missed on more than one delivery. Reasons appear as soon as the driver submits them.
nonPaymentReason | Meaning |
|---|---|
PRICING_DISCREPANCY | The retailer disputes the prices of the products they received |
PRODUCT_QUALITY_DISCREPANCY | The retailer disputes the quality or accuracy of the products they received |
INSUFFICIENT_FUNDS | The retailer didn't have the funds to pay |
INSOLVENCY_RISK | The retailer is at risk of insolvency |
NO_AUTHORIZED_PAYER | No one authorized to pay was on site |
ALREADY_PAID_TO_BRAND | The retailer says they already paid the invoice to your organization |
ALREADY_PAID_TO_NABIS | The retailer says they already paid the invoice to Nabis |
FORM_8300_REFUSAL | The retailer refused to complete IRS Form 8300, required for cash payments over $10,000 |
New reasons may be added. nonPaymentReason is null if the driver didn't give one.
A driver may try to collect on the same order more than once, on different days, for example
while delivering another order to the same retailer. Each attempt is its own record, with the
deliveryDate of the delivery it was made on and the createdAt time the driver recorded it.
Use startCreatedAt and endCreatedAt to find the reasons recorded in a time window,
whichever order they're for.
Every filter is optional and they can be combined. For example, to get the reasons recorded on one order in March 2026:
curl "https://customer-api.nabis.pro/v3/non-payment-reasons?page=0&limit=10&orderNumber=123456&startCreatedAt=2026-03-01&endCreatedAt=2026-03-31" \
-H 'x-nabis-access-token: <access-token>'
Query Parameters
- page integer required
Page to return. Pages start at
0 - limit integer required
Possible values:
>= 1and<= 500Number of records per page, up to
500 - orderId uuid
Only return non-payment reasons for this order
- orderNumber integer
Possible values:
>= 1Only return non-payment reasons for the order with this order number, as shown in the Nabis app and on order documents
- startDeliveryDate date
Only return non-payment reasons recorded on deliveries on or after this date, in
yyyy-mm-ddformat - endDeliveryDate date
Only return non-payment reasons recorded on deliveries on or before this date, in
yyyy-mm-ddformat - startCreatedAt date
Only return non-payment reasons the driver recorded on or after this date, in
yyyy-mm-ddformat. Dates are in UTC - endCreatedAt date
Only return non-payment reasons the driver recorded on or before this date, in
yyyy-mm-ddformat. Dates are in UTC - licensedLocationId uuid
Only return non-payment reasons for orders to this retailer
- nonPaymentReason string
Possible values: [
PRICING_DISCREPANCY,PRODUCT_QUALITY_DISCREPANCY,INSUFFICIENT_FUNDS,INSOLVENCY_RISK,NO_AUTHORIZED_PAYER,ALREADY_PAID_TO_BRAND,ALREADY_PAID_TO_NABIS,FORM_8300_REFUSAL]Only return this non-payment reason
- 200
- 400
- 401
- 429
Successful Operation
Response Headers
X-RateLimit-Limit integer
Requests per minute your access token can make
X-RateLimit-Remaining integer
Requests you can still make right now, after this one
X-RateLimit-Reset integer
Seconds until your oldest request in the last minute stops counting, freeing up room for another. Not a countdown to your whole limit refilling: each request stops counting one minute after you make it
- application/json
- Schema
- Example
Schema
data object[]
id uuidNabis ID of the non-payment reason
orderId uuidNabis ID of the order that went unpaid. See Get Order by Nabis ID
orderNumber integerOrder number shown in the Nabis app and on order documents
licensedLocationId uuidNabis ID of the retailer the order is for. See Get Retailer by Nabis ID
licensedLocationName stringName of the retailer the order is for
deliveryDate dateDate of the delivery on which payment was not collected, in
yyyy-mm-ddformatnonPaymentReason stringWhy payment was not collected. See Get Many Non-Payment Reasons for every value.
nullif the driver gave no reasoncreatedAt date-timeWhen the driver recorded the non-payment
- page integer
The page returned
- totalCount integer
Total number of records across all pages
- totalNumPages integer
Total number of pages
- nextPage integer
The next page, or
nullon the last page - prevPage integer
The previous page, or
nullon the first page
{
"data": [
{
"id": "5f1c9a2e-7b3d-4e8a-9c6f-2d4b8e0a1c3f",
"orderId": "0e7b3d9f-4a2c-4b6e-8d1a-3c5e7f9b1d2a",
"orderNumber": 123456,
"licensedLocationId": "a1d3c5e7-2b4d-4f6a-8c0e-1f3a5c7e9b2d",
"licensedLocationName": "Green Leaf Dispensary",
"deliveryDate": "2026-03-15",
"nonPaymentReason": "INSUFFICIENT_FUNDS",
"createdAt": "2026-03-15T19:42:10.000Z"
},
{
"id": "8a2d4f6b-1c3e-4a5b-9d7f-0e2c4a6b8d1f",
"orderId": "0e7b3d9f-4a2c-4b6e-8d1a-3c5e7f9b1d2a",
"orderNumber": 123456,
"licensedLocationId": "a1d3c5e7-2b4d-4f6a-8c0e-1f3a5c7e9b2d",
"licensedLocationName": "Green Leaf Dispensary",
"deliveryDate": "2026-03-01",
"nonPaymentReason": "NO_AUTHORIZED_PAYER",
"createdAt": "2026-03-01T17:05:33.000Z"
}
],
"page": 0,
"totalCount": 2,
"totalNumPages": 1,
"nextPage": null,
"prevPage": null
}
Invalid request parameters
Invalid API key
Too Many Requests. You've used up your rate limit; wait Retry-After seconds and try again
Response Headers
Retry-After integer
Seconds to wait before making another request
X-RateLimit-Limit integer
Requests per minute your access token can make
X-RateLimit-Remaining integer
Requests you can still make right now, after this one
X-RateLimit-Reset integer
Seconds until your oldest request in the last minute stops counting, freeing up room for another. Not a countdown to your whole limit refilling: each request stops counting one minute after you make it