{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aab64834-a246-41ef-a4f6-1eabd729f0ea","name":"Chooose Partner API Docs: Booking Flow Integrations","description":"Chooose builds digital tools so that we all can make climate action part of everyday life.\n\nThe Chooose Partner API enables partners to integrate carbon calculation and offset purchasing into their own products and services, and also enables related features of the Chooose Platform.\n\nChooose Partner API is designed to function as a Server-to-Server solution.\n\nThis collection of documentation references the most common endpoints used to facilitate carbon offsetting within a booking or other product purchase flow.\n\n# Quickstart\n\nThe Chooose Partner API offers integration options in a few easy steps:\n\n1. Authenticate\n    \n2. Create a quote to address one or more footprints\n    \n3. Complete the quote by calling Accept or Cancel\n    \n\nWhen accepting a quote, Chooose supports direct customer payment via Stripe or partner capture of payment with subsequent, periodic transfers and reconciliation with Chooose.\n\n# Concepts\n\n**Partnership**: The configuration governing the integration. Set-up by Chooose, accessible by the partner.\n\n**Customer**: The entity that purchases climate products from Chooose via orders.\n\n- **Guest customer**: An placeholder or unregistered customer created to provide ownership to orders. Using a “claim URL”, a guest customer can be “claimed” into a registered customer and manage their carbon footprint within the Chooose platform. Partners can retrieve these claim URLs and provide them to the customer.\n    \n- **Registered customer**: A registered customer. May be converted from a guest customer, or created as a \"rich\" customer from the outset.\n    \n\n**Footprint**: An estimate of the greenhouse gas emissions of an activity, measured in CO2 equivalents. Footprints are calculated and created in the Chooose platform when creating a Quote.\n\n**CO2e**: _Carbon Dioxide Equivalent._ This type of calculation includes the warming effect of non-CO2 greenhouse gasses like methane, but stated in terms of the equivalent effect of carbon dioxide. This is the standard way footprints are measured and communicated.\n\n**Radiative forcing (RF)**: is a measure of the additional environmental impact of aviation. These include emissions of nitrous oxides and water vapour when emitted at high altitude. This factor is set in the partner agreement, and the API will adapt accordingly. By default, Chooose uses a factor of 1.9, as per recommendation from UK Department for Business, Energy & Industrial Strategy.\n\n**Offset**: A monetary contribution that compensates one or more footprint(s). Accepting a quote will offset the footprints defined in the quote.\n\n**Project**: A representation of an activity that creates a verified and quantified positive carbon impact. Examples include renewable energy, forestation, waste handling, sustainable aviation fuel etc.\n\n**Portfolio**: A combination of one or more projects used to price and place carbon offset orders. Portfolios vary in price based on the underlying projects.\n\nThere is a limited amount of supply available for each project, so the projects in a portfolio may need to change with time (your Chooose account manager will provide continuous aid in this process).\n\n**Quote**: an offer to address one or more footprints using one or more portfolio(s). A quote is either Accepted or Cancelled. Accepting a quote creates an order and requires a form of payment. A. Patner transfer: funds captured by the partner + periodically reconciled and transferred to Chooose. B. paid for by the end customer directly using a Stripe payment method.\n\n**Order**: When a quote is accepted, an order will purchase offset(s) to address the footprint(s).\n\n**Stripe**: Stripe is the default payment gateway Chooose relies on for payments from customers. It supports all common credit cards and many other payment methods. By using the Partner API in combination with the Stripe API, all payment method information is securely stored by Stripe ensuring the highest level of PCI compliance.\n\n# Status codes\n\nWe are following the standard HTTP response status codes.\n\n| **Code** | **Description** |\n| --- | --- |\n| 200 | **OK** |\n| 201 | **Created** |\n| 400 | **Bad request** |\n| 401 | **Unauthorized** |\n| 404 | **Not found** |\n| 409 | **Conflict** |\n| 418 | **I'm a teapot** |\n| 500 | **Internal server error** |\n| 503 | **Service is down** |\n\n# Supported currencies\n\nUse one of these when creating a Quote.\n\n| CODE | Currency | Zero decimal? |\n| --- | --- | --- |\n| AED | UAE Dirham | FALSE |\n| AFN | Afghani | FALSE |\n| ALL | Lek | FALSE |\n| AMD | Armenian Dram | FALSE |\n| ANG | Netherlands Antillean Guilder | FALSE |\n| AOA | Kwanza | FALSE |\n| ARS | Argentine Peso | FALSE |\n| AUD | Australian Dollar | FALSE |\n| AWG | Aruban Florin | FALSE |\n| AZN | Azerbaijanian Manat | FALSE |\n| BAM | Convertible Mark | FALSE |\n| BBD | Barbados Dollar | FALSE |\n| BDT | Taka | FALSE |\n| BGN | Bulgarian Lev | FALSE |\n| BIF | Burundi Franc | TRUE |\n| BMD | Bermudian Dollar | FALSE |\n| BND | Brunei Dollar | FALSE |\n| BOB | Boliviano | FALSE |\n| BRL | Brazilian Real | FALSE |\n| BSD | Bahamian Dollar | FALSE |\n| BWP | Pula | FALSE |\n| BYN | Belarusian Ruble | FALSE |\n| BZD | Belize Dollar | FALSE |\n| CAD | Canadian Dollar | FALSE |\n| CDF | Congolese Franc | FALSE |\n| CHF | Swiss Franc | FALSE |\n| CLP | Chilean Peso | TRUE |\n| CNY | Yuan Renminbi | FALSE |\n| COP | Colombian Peso | FALSE |\n| CRC | Costa Rican Colon | FALSE |\n| CVE | Cabo Verde Escudo | FALSE |\n| CZK | Czech Koruna | FALSE |\n| DJF | Djibouti Franc | TRUE |\n| DKK | Danish Krone | FALSE |\n| DOP | Dominican Peso | FALSE |\n| DZD | Algerian Dinar | FALSE |\n| EGP | Egyptian Pound | FALSE |\n| ETB | Ethiopian Birr | FALSE |\n| EUR | Euro | FALSE |\n| FJD | Fiji Dollar | FALSE |\n| FKP | Falkland Islands Pound | FALSE |\n| GBP | Pound Sterling | FALSE |\n| GEL | Lari | FALSE |\n| GIP | Gibraltar Pound | FALSE |\n| GMD | Dalasi | FALSE |\n| GNF | Guinea Franc | TRUE |\n| GTQ | Quetzal | FALSE |\n| GYD | Guyana Dollar | FALSE |\n| HKD | Hong Kong Dollar | FALSE |\n| HNL | Lempira | FALSE |\n| HRK | Kuna | FALSE |\n| HTG | Gourde | FALSE |\n| HUF | Forint | FALSE |\n| IDR | Rupiah | FALSE |\n| ILS | New Israeli Sheqel | FALSE |\n| INR | Indian Rupee | FALSE |\n| ISK | Iceland Krona | FALSE |\n| JMD | Jamaican Dollar | FALSE |\n| JPY | Yen | TRUE |\n| KES | Kenyan Shilling | FALSE |\n| KGS | Som | FALSE |\n| KHR | Riel | FALSE |\n| KMF | Comoro Franc | TRUE |\n| KRW | Won | TRUE |\n| KYD | Cayman Islands Dollar | FALSE |\n| KZT | Tenge | FALSE |\n| LAK | Kip | FALSE |\n| LBP | Lebanese Pound | FALSE |\n| LKR | Sri Lanka Rupee | FALSE |\n| LRD | Liberian Dollar | FALSE |\n| LSL | Loti | FALSE |\n| MAD | Moroccan Dirham | FALSE |\n| MDL | Moldovan Leu | FALSE |\n| MGA | Malagasy Ariary | TRUE |\n| MKD | Denar | FALSE |\n| MMK | Kyat | FALSE |\n| MNT | Tugrik | FALSE |\n| MOP | Pataca | FALSE |\n| MRO | Ouguiya | FALSE |\n| MUR | Mauritius Rupee | FALSE |\n| MVR | Rufiyaa | FALSE |\n| MWK | Malawi Kwacha | FALSE |\n| MXN | Mexican Peso | FALSE |\n| MYR | Malaysian Ringgit | FALSE |\n| MZN | Mozambique Metical | FALSE |\n| NAD | Namibia Dollar | FALSE |\n| NGN | Naira | FALSE |\n| NIO | Cordoba Oro | FALSE |\n| NOK | Norwegian Krone | FALSE |\n| NPR | Nepalese Rupee | FALSE |\n| NZD | New Zealand Dollar | FALSE |\n| PAB | Balboa | FALSE |\n| PEN | Sol | FALSE |\n| PGK | Kina | FALSE |\n| PHP | Philippine Peso | FALSE |\n| PKR | Pakistan Rupee | FALSE |\n| PLN | Zloty | FALSE |\n| PYG | Guarani | TRUE |\n| QAR | Qatari Rial | FALSE |\n| RON | Romanian Leu | FALSE |\n| RSD | Serbian Dinar | FALSE |\n| RUB | Russian Ruble | FALSE |\n| RWF | Rwanda Franc | TRUE |\n| SAR | Saudi Riyal | FALSE |\n| SBD | Solomon Islands Dollar | FALSE |\n| SCR | Seychelles Rupee | FALSE |\n| SEK | Swedish Krona | FALSE |\n| SGD | Singapore Dollar | FALSE |\n| SHP | Saint Helena Pound | FALSE |\n| SLL | Leone | FALSE |\n| SOS | Somali Shilling | FALSE |\n| SRD | Surinam Dollar | FALSE |\n| STD | Dobra | FALSE |\n| SZL | Lilangeni | FALSE |\n| THB | Baht | FALSE |\n| TJS | Somoni | FALSE |\n| TOP | Pa’anga | FALSE |\n| TRY | Turkish Lira | FALSE |\n| TTD | Trinidad and Tobago Dollar | FALSE |\n| TWD | New Taiwan Dollar | FALSE |\n| TZS | Tanzanian Shilling | FALSE |\n| UAH | Hryvnia | FALSE |\n| UGX | Uganda Shilling | TRUE |\n| USD | US Dollar | FALSE |\n| UYU | Peso Uruguayo | FALSE |\n| UZS | Uzbekistan Sum | FALSE |\n| VND | Dong | TRUE |\n| VUV | Vatu | TRUE |\n| WST | Tala | FALSE |\n| XAF | CFA Franc BEAC | FALSE |\n| XCD | East Caribbean Dollar | FALSE |\n| XOF | CFA Franc BCEAO | TRUE |\n| XPF | CFP Franc | TRUE |\n| YER | Yemeni Rial | FALSE |\n| ZAR | Rand | FALSE |\n| ZMW | Zambian Kwacha | FALSE |\n\n# Supported languages\n\nUse one of these to set the customer preferred language when completing a quote (Accept / Cancel).\n\n| **Language codes** |\n| --- |\n| en |\n| ar |\n| at |\n| ca |\n| cs |\n| da |\n| de |\n| el |\n| en-US |\n| es |\n| es-MX |\n| fi |\n| fr |\n| hu |\n| id |\n| is |\n| it |\n| ja |\n| ko |\n| ms |\n| nb-NO |\n| nl |\n| pl |\n| pt |\n| pt-BR |\n| ro |\n| ru |\n| sv |\n| th |\n| tl |\n| tr |\n| uk |\n| vi |\n| zh-Hans |\n| zh-Hant |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17603313","team":380874,"collectionId":"aab64834-a246-41ef-a4f6-1eabd729f0ea","publishedId":"2s93JnW7uS","public":true,"publicUrl":"https://bookingflow.docs.chooose.today","privateUrl":"https://go.postman.co/documentation/17603313-aab64834-a246-41ef-a4f6-1eabd729f0ea","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"634d88"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ecc38c10-109f-4c1d-b858-c136dd8d23b3/Y2hvb29zZSBsb2dvLXdoaXRlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"b4c0ff"}},{"name":"light","logo":"https://content.pstmn.io/6a14dcb0-4179-4fb3-8be0-7cd1b24af141/Y2hvb29zZSBsb2dvLWJsYWNrLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"634d88"}}]}},"version":"8.10.0","publishDate":"2025-12-12T10:48:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/6a14dcb0-4179-4fb3-8be0-7cd1b24af141/Y2hvb29zZSBsb2dvLWJsYWNrLnBuZw==","logoDark":"https://content.pstmn.io/ecc38c10-109f-4c1d-b858-c136dd8d23b3/Y2hvb29zZSBsb2dvLXdoaXRlLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c8d734a4fcab572c3b963d4cce85a51ac1239e1fb79334b3b25e9c0c4fab79d4","favicon":"https://res.cloudinary.com/postman/image/upload/v1592600615/team/ocfwrzwxjayjtleasoyy.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://bookingflow.docs.chooose.today/view/metadata/2s93JnW7uS"}