Skip to main content
GET
/
offset-gateway
/
orders
List All Offset Orders
curl --request GET \
  --url https://api.sandbox.external.bnznow.com/offset-gateway/orders \
  --header 'x-api-key: <x-api-key>'
{
  "metadata": {
    "current_page": 123,
    "total_records": 123,
    "limit": 123
  },
  "overview": {
    "total_orders": 123,
    "total_amount_paid": 123,
    "total_users": 123
  },
  "orders": [
    {
      "order_id": "<string>",
      "emission_amount": 123,
      "emission_unit": "<string>",
      "user": {
        "name": "<string>",
        "email": "<string>",
        "tax_id": "<string>"
      },
      "callback_url": "<string>",
      "payment_url": "<string>",
      "status": "pending",
      "payment_status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "project": {
        "name": "<string>",
        "registry": "<string>",
        "project_id": "<string>",
        "category": "<string>",
        "type": "<string>",
        "public_url": "<string>"
      }
    }
  ]
}

Headers

x-api-key
string
required

API key for authentication

Query Parameters

email
string

Email of user to get orders for

tax_id
string

Tax ID of user to get orders for

limit
integer<int32>
default:20

The maximum number of results to return

Required range: 1 <= x <= 100
page
integer<int32>
default:1

The page number to return

Required range: 1 <= x <= 1000
sort
enum<string>
default:desc

The sort order of the results

Available options:
asc,
desc
status
enum<string>

Filter orders by status

Available options:
pending,
completed,
failed

Response

Successfully retrieved list of orders

metadata
object
overview
object
orders
object[]