Skip to main content

Reservations

Partners cannot purchase high volumes of carbon tonnes because the purchase itself is not instant with registry which holds that carbon. High volumes of carbon need to be reserved first. Customer will be contacted after price and availability check by Earthbanc's sales person with final parameters of the purchase. Payments for such purchases are also handled individually by sales team.

Reservation restrictions apply to a particular project when attribute quantityReservationThreshold of project is filled and buying amount is above this threashold.

These endpoints are protected and requires authorization.

Authorization

Authorization parts:

  1. Whitelisted IP - we allow only traffic from whitelisted IP of our partners (not needed for sandbox environment)
  2. Partner ID - Partner ID is part of the path see endpoints below
  3. Secret key - stored in Authorization: Api-Key <secret> header of the request

New Reservation

This API receives new partner reservation on behalf of a customer with volume above reservation threshold.

Path: POST https://app.earthbanc.io/api/partners/{partner-id}/reservations

More details: API definition

Customer reservations

This API provides partner's reservations for a customer

Path: GET https://app.earthbanc.io/api/partners/{partner-id}/reservations?emailSha3={emailSha3}

More details: API definition