Skip to main content
Version: v3

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.

nonPaymentReasonMeaning
PRICING_DISCREPANCYThe retailer disputes the prices of the products they received
PRODUCT_QUALITY_DISCREPANCYThe retailer disputes the quality or accuracy of the products they received
INSUFFICIENT_FUNDSThe retailer didn't have the funds to pay
INSOLVENCY_RISKThe retailer is at risk of insolvency
NO_AUTHORIZED_PAYERNo one authorized to pay was on site
ALREADY_PAID_TO_BRANDThe retailer says they already paid the invoice to your organization
ALREADY_PAID_TO_NABISThe retailer says they already paid the invoice to Nabis
FORM_8300_REFUSALThe 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: >= 1 and <= 500

    Number of records per page, up to 500

  • orderId uuid

    Only return non-payment reasons for this order

  • orderNumber integer

    Possible values: >= 1

    Only 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-dd format

  • endDeliveryDate date

    Only return non-payment reasons recorded on deliveries on or before this date, in yyyy-mm-dd format

  • startCreatedAt date

    Only return non-payment reasons the driver recorded on or after this date, in yyyy-mm-dd format. Dates are in UTC

  • endCreatedAt date

    Only return non-payment reasons the driver recorded on or before this date, in yyyy-mm-dd format. 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

Responses

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


Schema
  • data object[]
  • id uuid

    Nabis ID of the non-payment reason

  • orderId uuid

    Nabis ID of the order that went unpaid. See Get Order by Nabis ID

  • orderNumber integer

    Order number shown in the Nabis app and on order documents

  • licensedLocationId uuid

    Nabis ID of the retailer the order is for. See Get Retailer by Nabis ID

  • licensedLocationName string

    Name of the retailer the order is for

  • deliveryDate date

    Date of the delivery on which payment was not collected, in yyyy-mm-dd format

  • nonPaymentReason string

    Why payment was not collected. See Get Many Non-Payment Reasons for every value. null if the driver gave no reason

  • createdAt date-time

    When 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 null on the last page

  • prevPage integer

    The previous page, or null on the first page