Skip to main content
GET
/
offset-gateway
/
orders
/
{id}
Get Order Details
curl --request GET \
  --url https://api.sandbox.external.bnznow.com/offset-gateway/orders/{id} \
  --header 'x-api-key: <x-api-key>'
{
  "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

Path Parameters

id
string
required

Order ID

Response

Order details retrieved successfully

order_id
string

Unique identifier for the order

emission_amount
number

Amount of emissions to offset

emission_unit
string

Unit of emission measurement

user
object
callback_url
string<uri>

URL to receive webhook notifications about order status changes

payment_url
string<uri>

URL to complete the payment

status
enum<string>

Current status of the order

Available options:
pending,
completed,
failed
payment_status
enum<string>

Status of the payment

Available options:
pending,
completed,
failed
created_at
string<date-time>

Order creation timestamp

project
object