Gift Certificates
Partner can purchase tree or carbon tonnes anonymously (without specifying the customer). Our API will provide redeem code for such purchase and certificate in PDF or PNG. There are similar reservation rules for carbon offset tonnes to receive a certificate the order has to be below reservation threshold.
These endpoints are protected and requires authorization.
Authorization
Authorization parts:
- Whitelisted IP - we allow only traffic from whitelisted IP of our partners (not needed for sandbox environment)
- Partner ID - Partner ID is part of the path see endpoints below
- Secret key - stored in
Authorization: Api-Key <secret>
header of the request
Buy a gift certificate
Partner can buy a carbon tonne or trees as a certificate. Partner will receive a redeem code and id of the certificate (id is redeem code hashed with SHA3-256 to secure redeem code not to appear in access logs) Redeem code could be used in Earthbanc's Carbon Market to get purchased trees or carbon tonnes displayed on a Portfolio page. This code could be printed on a gift certificate. Earthbanc also provides gift certificates as PDF or PNG see chapter Printable gift certificate.
More details: API definition
Gift Certificate detail
A partner can use gift certificate id to fetch further certificate's details which could be then printed out on a certificate. Gift certificate contains many attributes such as redeem code
, vintage
, creditClassName
, creditClassVersion
, methodologyName
, methodologyVersion
and others.
More details: API definition
Printable gift certificate
There is possibility to receive an image of purchased gift certificate to give away. We support PDF and PNG image format. You can also apply for multiple certificate at once. In case of PDF you can decide to receive it as single page pdf documents compressed into and archived or multipage PDF.
More details: API definition
Example of certificate