Skip to main content
POST
/
offset-gateway
/
orders
Create Offset Order
curl --request POST \
  --url https://api.sandbox.external.bnznow.com/offset-gateway/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-body-signature: <x-body-signature>' \
  --data '
{
  "emission_amount": 1,
  "emission_unit": "kgCO2",
  "callback_url": "<string>",
  "user": {
    "name": "<string>",
    "email": "[email protected]",
    "tax_id": "<string>"
  }
}
'
{
  "order_id": "<string>",
  "emission_amount": 123,
  "emission_unit": "<string>",
  "user": {
    "name": "<string>",
    "email": "<string>",
    "tax_id": "<string>"
  },
  "callback_url": "<string>",
  "payment_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Headers

​
x-api-key
string
required

API key for authentication

​
x-body-signature
string
required

Signature of the request body signed with API secret (private key)

Body

application/json
​
emission_amount
number
required

Amount of carbon credits to purchase

Required range: x >= 0
​
emission_unit
enum<string>
default:kgCO2

Unit of measurement for emissions (defaults to kgCO2 if not specified)

Available options:
kgCO2,
tonCO2e
​
callback_url
string<uri>

URL to receive webhook notifications about order status changes

​
user
object

User information

Response

Order created 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

​
created_at
string<date-time>

Order creation timestamp