{"openapi":"3.1.0","x-id":["deedster-api.routes.services/api"],"info":{"version":"1.3.0","title":"Deedster Climate Insight API","description":"## Introduction\nDeedster provides organizations with API-based services and UIs to educate and engage employees and customers in calculating, analyzing, and reducing their climate impact.\nThis Deedster Climate Insight API is a set of REST services which enable the enrichment of bank transactions with carbon footprint data and actionable insights.\nIf you are interested in using the service please contact contact@deedster.com to obtain an API key.\n\n## Getting Started\nThe API enriches bank transactions with climate footprint data, providing a carbon footprint per transaction, as well as an annualized total footprint. We use multiple global and national datasets and dynamic market data from trustworthy sources to ensure the most accurate calculations possible.\nProduction environment: https://api.deedster.com/\n\n### CO2e Footprint – Enriching Transactions with Carbon Data\n\nFor clients subscribed to the Climate Impact API, a CO2 footprint in kilograms (kg) will be included in the response for each transaction request.\n\n#### User Input Questions – Increasing Accuracy with Additional User Data\n\nTo enhance the accuracy of carbon calculations, optional user data can be added either in the transaction endpoint or saved to a user object through the user endpoint. This feature requires manual user input.\nThe following categories are available for user input:\n\n* user.housing.type\n* user.housing.electricity\n* user.food.diet\n* user.car.fuel-type\n\n#### User Region – Prerequisite for Using National Datasets\n\nThe user.region field specifies the user's region and is required to access national datasets. This field is mandatory for clients subscribing to national data services.\n\n### CO2e Cost – Societal Cost of Carbon Emissions\n\nThe CO2e cost represents the societal cost of carbon emissions in monetary terms. For clients subscribed to the Climate Impact API, this cost will be included in the transaction response, expressed in the same currency as the transaction.\n\n### Categorization\nThe API supports several categorization schemes including MCC, aggregator-specific schemes (e.g. Tink), and bank proprietary systems. In the case of a bank proprietary system, a categorization mapping and adjustment needs to be performed before the API can be used.\n\n### Annualized and Projected User Footprint\n\nThe annualized footprint projects the user's total carbon footprint based on their spending, using three months of transaction history. This requires a minimum of three months' transaction data per user.\n\n### Deeds – Personalized and Actionable Insights\n\nDeeds are a set of personalized and actionable insights tailored to the user, client, and market. Clients subscribed to Deeds will receive these as part of the transaction response.\n\n#### Translation for Different Markets\n\nTo receive localized deeds content, use the Accept-Language header. For example, to request content in Spanish with an English (US) fallback, specify:  Accept-Language: \"es-ES, en-US\"\n\n### Merchant Label – Enriching Transactions with Sustainability Labels\n\nEnriches transactions by labeling merchants with sustainability-related information. The label indicates whether a merchant is a sustainable choice. Clients can use this information in their UI to empower user decision-making or for user profiling. Clients subscribed to Merchant Label will receive this information as part of the transaction response.\n","contact":{"name":"Deedster","email":"support@deedster.com"}},"servers":[{"url":"https://api.deedster.com","description":"Production Server"},{"url":"https://stg.api.deedster.com","description":"Staging Server"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"accept-language":{"type":"string","description":"Language code to get translated content","example":"en-US","format":"language-code"},"customer":{"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed","example":"acme","type":"string","format":"string"},"partner":{"description":"Partner identifier will be provided to you with api key","example":"acme","type":"string","format":"string"}},"headers":{"accept-language":{"schema":{"$ref":"#/components/schemas/accept-language"}},"customer":{"schema":{"$ref":"#/components/schemas/customer"}},"partner":{"schema":{"$ref":"#/components/schemas/partner"}}}},"paths":{"/api/v1/transactions/enrich":{"post":{"parameters":[{"in":"query","name":"includeDeeds","required":false,"schema":{"type":"boolean","description":"Whether to include recommendedDeeds in the response"},"description":"Whether to include recommendedDeeds in the response"},{"in":"query","name":"categorization","required":false,"schema":{"enum":["six-v1.4","contovista","seb-baltics","six","kasparv2","mcc","deedster","tink","snowdrop"],"type":"string","description":"Categorization used when not provided on transaction"},"description":"Categorization used when not provided on transaction"},{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"amount":{"type":"number","format":"double"},"currency":{"enum":["NZD","SGD","HUF","MYR","ZAR","PHP","RON","TRY","MXN","AUD","ISK","KRW","JPY","BRL","IDR","EUR","GBP","SEK","ILS","DKK","HKD","CNY","BGN","CZK","CAD","PLN","THB","USD","NOK","INR","CHF"],"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"date":{"type":"string"},"categorization":{"enum":["six-v1.4","contovista","seb-baltics","six","kasparv2","mcc","deedster","tink","snowdrop"],"type":"string"}},"required":["id","amount","currency","code","description","date"],"title":"deedster-api.transactions/transaction"},"minItems":1,"description":"Bank Transactions","example":[{"id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","amount":100,"currency":"SEK","code":"3082","description":"description","date":"2019-12-15"},{"id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"3353","description":"description","date":"2019-12-15"},{"id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"8f30832aaa35480bbd88d683be480769","description":"description","date":"2019-12-15"},{"id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","amount":100,"currency":"SEK","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","description":"description","date":"2019-12-24"},{"id":"998fa134-1229-4c59-be95-2bd9f3a4d810","amount":100,"currency":"SEK","code":"7993","description":"description","date":"2020-01-01"},{"id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2022-01-01"},{"id":"id","amount":100,"currency":"SEK","code":"non-exsiting-code","description":"description","date":"2022-02-02"},{"id":"265791ef-54f2-4db2-add6-7f505f72f666","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2019-12-30"},{"id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","amount":100,"currency":"SEK","code":"4225","description":"description","date":"2019-12-28"}]},"user":{"type":"object","properties":{"housing":{"type":"object","properties":{"type":{"enum":["townhouse","apartment","housing","house"],"type":"string"},"electricity":{"enum":["standard","green","unknown"],"type":"string"}}},"food":{"type":"object","properties":{"game":{"type":"integer","format":"int64"},"fish":{"type":"integer","format":"int64"},"pork":{"type":"integer","format":"int64"},"beef":{"type":"integer","format":"int64"},"poultry":{"type":"integer","format":"int64"},"diet":{"enum":["omnivore","vegetarian","vegan"],"type":"string"}}},"car":{"type":"object","properties":{"fuel-type":{"enum":["electric","e85","hybrid-diesel","hybrid-gasoline","hybrid-hvo","gas","hvo","gasoline50","diesel","diesel50","gasoline","hybrid-diesel50"],"type":"string"}}},"region":{"type":"string","description":"ISO country code"}}}},"required":["transactions"]}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"amount":{"type":"number","format":"double"},"currency":{"enum":["NZD","SGD","HUF","MYR","ZAR","PHP","RON","TRY","MXN","AUD","ISK","KRW","JPY","BRL","IDR","EUR","GBP","SEK","ILS","DKK","HKD","CNY","BGN","CZK","CAD","PLN","THB","USD","NOK","INR","CHF"],"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"date":{"type":"string"},"categorization":{"enum":["six-v1.4","contovista","seb-baltics","six","kasparv2","mcc","deedster","tink","snowdrop"],"type":"string"}},"required":["id","amount","currency","code","description","date"],"title":"deedster-api.transactions/transaction"},"minItems":1,"description":"Bank Transactions","example":[{"id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","amount":100,"currency":"SEK","code":"3082","description":"description","date":"2019-12-15"},{"id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"3353","description":"description","date":"2019-12-15"},{"id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"8f30832aaa35480bbd88d683be480769","description":"description","date":"2019-12-15"},{"id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","amount":100,"currency":"SEK","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","description":"description","date":"2019-12-24"},{"id":"998fa134-1229-4c59-be95-2bd9f3a4d810","amount":100,"currency":"SEK","code":"7993","description":"description","date":"2020-01-01"},{"id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2022-01-01"},{"id":"id","amount":100,"currency":"SEK","code":"non-exsiting-code","description":"description","date":"2022-02-02"},{"id":"265791ef-54f2-4db2-add6-7f505f72f666","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2019-12-30"},{"id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","amount":100,"currency":"SEK","code":"4225","description":"description","date":"2019-12-28"}]},"user":{"type":"object","properties":{"housing":{"type":"object","properties":{"type":{"enum":["townhouse","apartment","housing","house"],"type":"string"},"electricity":{"enum":["standard","green","unknown"],"type":"string"}}},"food":{"type":"object","properties":{"game":{"type":"integer","format":"int64"},"fish":{"type":"integer","format":"int64"},"pork":{"type":"integer","format":"int64"},"beef":{"type":"integer","format":"int64"},"poultry":{"type":"integer","format":"int64"},"diet":{"enum":["omnivore","vegetarian","vegan"],"type":"string"}}},"car":{"type":"object","properties":{"fuel-type":{"enum":["electric","e85","hybrid-diesel","hybrid-gasoline","hybrid-hvo","gas","hvo","gasoline50","diesel","diesel50","gasoline","hybrid-diesel50"],"type":"string"}}},"region":{"type":"string","description":"ISO country code"}}}},"required":["transactions"]}},"application/transit+json":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"amount":{"type":"number","format":"double"},"currency":{"enum":["NZD","SGD","HUF","MYR","ZAR","PHP","RON","TRY","MXN","AUD","ISK","KRW","JPY","BRL","IDR","EUR","GBP","SEK","ILS","DKK","HKD","CNY","BGN","CZK","CAD","PLN","THB","USD","NOK","INR","CHF"],"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"date":{"type":"string"},"categorization":{"enum":["six-v1.4","contovista","seb-baltics","six","kasparv2","mcc","deedster","tink","snowdrop"],"type":"string"}},"required":["id","amount","currency","code","description","date"],"title":"deedster-api.transactions/transaction"},"minItems":1,"description":"Bank Transactions","example":[{"id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","amount":100,"currency":"SEK","code":"3082","description":"description","date":"2019-12-15"},{"id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"3353","description":"description","date":"2019-12-15"},{"id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"8f30832aaa35480bbd88d683be480769","description":"description","date":"2019-12-15"},{"id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","amount":100,"currency":"SEK","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","description":"description","date":"2019-12-24"},{"id":"998fa134-1229-4c59-be95-2bd9f3a4d810","amount":100,"currency":"SEK","code":"7993","description":"description","date":"2020-01-01"},{"id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2022-01-01"},{"id":"id","amount":100,"currency":"SEK","code":"non-exsiting-code","description":"description","date":"2022-02-02"},{"id":"265791ef-54f2-4db2-add6-7f505f72f666","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2019-12-30"},{"id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","amount":100,"currency":"SEK","code":"4225","description":"description","date":"2019-12-28"}]},"user":{"type":"object","properties":{"housing":{"type":"object","properties":{"type":{"enum":["townhouse","apartment","housing","house"],"type":"string"},"electricity":{"enum":["standard","green","unknown"],"type":"string"}}},"food":{"type":"object","properties":{"game":{"type":"integer","format":"int64"},"fish":{"type":"integer","format":"int64"},"pork":{"type":"integer","format":"int64"},"beef":{"type":"integer","format":"int64"},"poultry":{"type":"integer","format":"int64"},"diet":{"enum":["omnivore","vegetarian","vegan"],"type":"string"}}},"car":{"type":"object","properties":{"fuel-type":{"enum":["electric","e85","hybrid-diesel","hybrid-gasoline","hybrid-hvo","gas","hvo","gasoline50","diesel","diesel50","gasoline","hybrid-diesel50"],"type":"string"}}},"region":{"type":"string","description":"ISO country code"}}}},"required":["transactions"]}},"application/edn":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"amount":{"type":"number","format":"double"},"currency":{"enum":["NZD","SGD","HUF","MYR","ZAR","PHP","RON","TRY","MXN","AUD","ISK","KRW","JPY","BRL","IDR","EUR","GBP","SEK","ILS","DKK","HKD","CNY","BGN","CZK","CAD","PLN","THB","USD","NOK","INR","CHF"],"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"date":{"type":"string"},"categorization":{"enum":["six-v1.4","contovista","seb-baltics","six","kasparv2","mcc","deedster","tink","snowdrop"],"type":"string"}},"required":["id","amount","currency","code","description","date"],"title":"deedster-api.transactions/transaction"},"minItems":1,"description":"Bank Transactions","example":[{"id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","amount":100,"currency":"SEK","code":"3082","description":"description","date":"2019-12-15"},{"id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"3353","description":"description","date":"2019-12-15"},{"id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","amount":100,"currency":"SEK","code":"8f30832aaa35480bbd88d683be480769","description":"description","date":"2019-12-15"},{"id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","amount":100,"currency":"SEK","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","description":"description","date":"2019-12-24"},{"id":"998fa134-1229-4c59-be95-2bd9f3a4d810","amount":100,"currency":"SEK","code":"7993","description":"description","date":"2020-01-01"},{"id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2022-01-01"},{"id":"id","amount":100,"currency":"SEK","code":"non-exsiting-code","description":"description","date":"2022-02-02"},{"id":"265791ef-54f2-4db2-add6-7f505f72f666","amount":100,"currency":"SEK","code":"3752","description":"description","date":"2019-12-30"},{"id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","amount":100,"currency":"SEK","code":"4225","description":"description","date":"2019-12-28"}]},"user":{"type":"object","properties":{"housing":{"type":"object","properties":{"type":{"enum":["townhouse","apartment","housing","house"],"type":"string"},"electricity":{"enum":["standard","green","unknown"],"type":"string"}}},"food":{"type":"object","properties":{"game":{"type":"integer","format":"int64"},"fish":{"type":"integer","format":"int64"},"pork":{"type":"integer","format":"int64"},"beef":{"type":"integer","format":"int64"},"poultry":{"type":"integer","format":"int64"},"diet":{"enum":["omnivore","vegetarian","vegan"],"type":"string"}}},"car":{"type":"object","properties":{"fuel-type":{"enum":["electric","e85","hybrid-diesel","hybrid-gasoline","hybrid-hvo","gas","hvo","gasoline50","diesel","diesel50","gasoline","hybrid-diesel50"],"type":"string"}}},"region":{"type":"string","description":"ISO country code"}}}},"required":["transactions"]}}}},"responses":{"200":{"description":"List of transactions enriched with carbon data and recommended deeds","content":{"application/json":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"deedsterCategory":{"enum":["transport","food","shopping","income","uncategorized","wellness","transfer","home"],"type":"string"},"co2e":{"type":"number","format":"double","description":"kg CO2e emission","title":"deedster-api.transactions/co2e"},"co2eCost":{"type":"number","format":"double","description":"Social cost of CO2e emitted. Returned in same currency as transaction","title":"deedster-api.transactions/co2eCost"},"code":{"type":"string"},"date":{"type":"string"},"merchantLabels":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"]},"description":"Merchant labels","title":"deedster-api.transactions/merchantLabels"}},"required":["id","deedsterCategory","co2e","co2eCost","code","date"],"title":"deedster-api.transactions/transactionResponse"},"example":[{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.flights.airTravel","currency":"SEK","deedsterCategory":"transport","id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","code":"3082","merchantLabels":[],"co2e":12.0717936384,"projection":0.0,"co2eCost":14.48615236608},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.transportOther.rental","currency":"SEK","deedsterCategory":"transport","id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","code":"3353","merchantLabels":[],"co2e":4.7074488,"projection":0.0,"co2eCost":5.6489385599999995},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.publicTransport","currency":"SEK","deedsterCategory":"transport","id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","code":"8f30832aaa35480bbd88d683be480769","merchantLabels":[{"merchantLabel":"public_transport","sustainableChoice":true}],"co2e":3.8250727103999997,"projection":0.0,"co2eCost":4.590087252479999},{"description":"description","amount":100,"date":"2019-12-24","likelyhood":"high","deedsterCode":"expenses.food.restaurants","currency":"SEK","deedsterCategory":"food","id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","merchantLabels":[{"merchantLabel":"vegan_restaurant","sustainableChoice":true}],"co2e":1.8080983584,"projection":0.0,"co2eCost":2.16971803008},{"description":"description","amount":100,"date":"2020-01-01","likelyhood":"high","deedsterCode":"expenses.wellness.leisureOther.entertainmentFacility","currency":"SEK","deedsterCategory":"wellness","id":"998fa134-1229-4c59-be95-2bd9f3a4d810","code":"7993","co2e":1.7425265375999999,"projection":0.0,"co2eCost":2.09103184512},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"uncategorized.fallbackUncategorized","currency":"SEK","deedsterCategory":"uncategorized","id":"id","code":"non-exsiting-code","merchantLabels":[],"co2e":0.0,"projection":0.0,"co2eCost":0.0},{"description":"description","amount":100,"date":"2019-12-30","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"265791ef-54f2-4db2-add6-7f505f72f666","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"2019-12-28","likelyhood":"high","deedsterCode":"expenses.food.groceries.groceriesOther","currency":"SEK","deedsterCategory":"food","id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","code":"4225","merchantLabels":[],"co2e":3.9079454592,"projection":0.0,"co2eCost":4.6895345510399995}]},"footprint":{"type":"object"},"projection":{"type":"object"},"recommendedDeeds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"co2impactAdjusted":{"type":"number","format":"double","description":"Adjusted CO2e KG saving estimate on completing the deed by taking user's transactions into account","title":"deedster-api.transactions/co2impactAdjusted"}},"required":["id","co2impactAdjusted"],"description":"Deed data taken transaction into account","title":"deedster-api.transactions/transaction-deed"}}},"required":["transactions","footprint","projection"]}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"deedsterCategory":{"enum":["transport","food","shopping","income","uncategorized","wellness","transfer","home"],"type":"string"},"co2e":{"type":"number","format":"double","description":"kg CO2e emission","title":"deedster-api.transactions/co2e"},"co2eCost":{"type":"number","format":"double","description":"Social cost of CO2e emitted. Returned in same currency as transaction","title":"deedster-api.transactions/co2eCost"},"code":{"type":"string"},"date":{"type":"string"},"merchantLabels":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"]},"description":"Merchant labels","title":"deedster-api.transactions/merchantLabels"}},"required":["id","deedsterCategory","co2e","co2eCost","code","date"],"title":"deedster-api.transactions/transactionResponse"},"example":[{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.flights.airTravel","currency":"SEK","deedsterCategory":"transport","id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","code":"3082","merchantLabels":[],"co2e":12.0717936384,"projection":0.0,"co2eCost":14.48615236608},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.transportOther.rental","currency":"SEK","deedsterCategory":"transport","id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","code":"3353","merchantLabels":[],"co2e":4.7074488,"projection":0.0,"co2eCost":5.6489385599999995},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.publicTransport","currency":"SEK","deedsterCategory":"transport","id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","code":"8f30832aaa35480bbd88d683be480769","merchantLabels":[{"merchantLabel":"public_transport","sustainableChoice":true}],"co2e":3.8250727103999997,"projection":0.0,"co2eCost":4.590087252479999},{"description":"description","amount":100,"date":"2019-12-24","likelyhood":"high","deedsterCode":"expenses.food.restaurants","currency":"SEK","deedsterCategory":"food","id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","merchantLabels":[{"merchantLabel":"vegan_restaurant","sustainableChoice":true}],"co2e":1.8080983584,"projection":0.0,"co2eCost":2.16971803008},{"description":"description","amount":100,"date":"2020-01-01","likelyhood":"high","deedsterCode":"expenses.wellness.leisureOther.entertainmentFacility","currency":"SEK","deedsterCategory":"wellness","id":"998fa134-1229-4c59-be95-2bd9f3a4d810","code":"7993","co2e":1.7425265375999999,"projection":0.0,"co2eCost":2.09103184512},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"uncategorized.fallbackUncategorized","currency":"SEK","deedsterCategory":"uncategorized","id":"id","code":"non-exsiting-code","merchantLabels":[],"co2e":0.0,"projection":0.0,"co2eCost":0.0},{"description":"description","amount":100,"date":"2019-12-30","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"265791ef-54f2-4db2-add6-7f505f72f666","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"2019-12-28","likelyhood":"high","deedsterCode":"expenses.food.groceries.groceriesOther","currency":"SEK","deedsterCategory":"food","id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","code":"4225","merchantLabels":[],"co2e":3.9079454592,"projection":0.0,"co2eCost":4.6895345510399995}]},"footprint":{"type":"object"},"projection":{"type":"object"},"recommendedDeeds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"co2impactAdjusted":{"type":"number","format":"double","description":"Adjusted CO2e KG saving estimate on completing the deed by taking user's transactions into account","title":"deedster-api.transactions/co2impactAdjusted"}},"required":["id","co2impactAdjusted"],"description":"Deed data taken transaction into account","title":"deedster-api.transactions/transaction-deed"}}},"required":["transactions","footprint","projection"]}},"application/transit+json":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"deedsterCategory":{"enum":["transport","food","shopping","income","uncategorized","wellness","transfer","home"],"type":"string"},"co2e":{"type":"number","format":"double","description":"kg CO2e emission","title":"deedster-api.transactions/co2e"},"co2eCost":{"type":"number","format":"double","description":"Social cost of CO2e emitted. Returned in same currency as transaction","title":"deedster-api.transactions/co2eCost"},"code":{"type":"string"},"date":{"type":"string"},"merchantLabels":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"]},"description":"Merchant labels","title":"deedster-api.transactions/merchantLabels"}},"required":["id","deedsterCategory","co2e","co2eCost","code","date"],"title":"deedster-api.transactions/transactionResponse"},"example":[{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.flights.airTravel","currency":"SEK","deedsterCategory":"transport","id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","code":"3082","merchantLabels":[],"co2e":12.0717936384,"projection":0.0,"co2eCost":14.48615236608},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.transportOther.rental","currency":"SEK","deedsterCategory":"transport","id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","code":"3353","merchantLabels":[],"co2e":4.7074488,"projection":0.0,"co2eCost":5.6489385599999995},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.publicTransport","currency":"SEK","deedsterCategory":"transport","id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","code":"8f30832aaa35480bbd88d683be480769","merchantLabels":[{"merchantLabel":"public_transport","sustainableChoice":true}],"co2e":3.8250727103999997,"projection":0.0,"co2eCost":4.590087252479999},{"description":"description","amount":100,"date":"2019-12-24","likelyhood":"high","deedsterCode":"expenses.food.restaurants","currency":"SEK","deedsterCategory":"food","id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","merchantLabels":[{"merchantLabel":"vegan_restaurant","sustainableChoice":true}],"co2e":1.8080983584,"projection":0.0,"co2eCost":2.16971803008},{"description":"description","amount":100,"date":"2020-01-01","likelyhood":"high","deedsterCode":"expenses.wellness.leisureOther.entertainmentFacility","currency":"SEK","deedsterCategory":"wellness","id":"998fa134-1229-4c59-be95-2bd9f3a4d810","code":"7993","co2e":1.7425265375999999,"projection":0.0,"co2eCost":2.09103184512},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"uncategorized.fallbackUncategorized","currency":"SEK","deedsterCategory":"uncategorized","id":"id","code":"non-exsiting-code","merchantLabels":[],"co2e":0.0,"projection":0.0,"co2eCost":0.0},{"description":"description","amount":100,"date":"2019-12-30","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"265791ef-54f2-4db2-add6-7f505f72f666","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"2019-12-28","likelyhood":"high","deedsterCode":"expenses.food.groceries.groceriesOther","currency":"SEK","deedsterCategory":"food","id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","code":"4225","merchantLabels":[],"co2e":3.9079454592,"projection":0.0,"co2eCost":4.6895345510399995}]},"footprint":{"type":"object"},"projection":{"type":"object"},"recommendedDeeds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"co2impactAdjusted":{"type":"number","format":"double","description":"Adjusted CO2e KG saving estimate on completing the deed by taking user's transactions into account","title":"deedster-api.transactions/co2impactAdjusted"}},"required":["id","co2impactAdjusted"],"description":"Deed data taken transaction into account","title":"deedster-api.transactions/transaction-deed"}}},"required":["transactions","footprint","projection"]}},"application/edn":{"schema":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","title":"transaction/id"},"deedsterCategory":{"enum":["transport","food","shopping","income","uncategorized","wellness","transfer","home"],"type":"string"},"co2e":{"type":"number","format":"double","description":"kg CO2e emission","title":"deedster-api.transactions/co2e"},"co2eCost":{"type":"number","format":"double","description":"Social cost of CO2e emitted. Returned in same currency as transaction","title":"deedster-api.transactions/co2eCost"},"code":{"type":"string"},"date":{"type":"string"},"merchantLabels":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"]},"description":"Merchant labels","title":"deedster-api.transactions/merchantLabels"}},"required":["id","deedsterCategory","co2e","co2eCost","code","date"],"title":"deedster-api.transactions/transactionResponse"},"example":[{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.flights.airTravel","currency":"SEK","deedsterCategory":"transport","id":"5d45e43f-ba23-4f9c-b86c-aa48c8cdd3e3","code":"3082","merchantLabels":[],"co2e":12.0717936384,"projection":0.0,"co2eCost":14.48615236608},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.transportOther.rental","currency":"SEK","deedsterCategory":"transport","id":"14b6a14d-9de7-43e5-acb0-0a2cbb99d58d","code":"3353","merchantLabels":[],"co2e":4.7074488,"projection":0.0,"co2eCost":5.6489385599999995},{"description":"description","amount":100,"date":"2019-12-15","likelyhood":"high","deedsterCode":"expenses.transport.publicTransport","currency":"SEK","deedsterCategory":"transport","id":"14b6a1ab-9de7-43e5-acb0-0a2cbb99d58d","code":"8f30832aaa35480bbd88d683be480769","merchantLabels":[{"merchantLabel":"public_transport","sustainableChoice":true}],"co2e":3.8250727103999997,"projection":0.0,"co2eCost":4.590087252479999},{"description":"description","amount":100,"date":"2019-12-24","likelyhood":"high","deedsterCode":"expenses.food.restaurants","currency":"SEK","deedsterCategory":"food","id":"a1d8ed7d-15a8-48b2-adf3-4a4123f5011f","code":"c59a38ff206c4fe29a9e7b2bb1fcb3de","merchantLabels":[{"merchantLabel":"vegan_restaurant","sustainableChoice":true}],"co2e":1.8080983584,"projection":0.0,"co2eCost":2.16971803008},{"description":"description","amount":100,"date":"2020-01-01","likelyhood":"high","deedsterCode":"expenses.wellness.leisureOther.entertainmentFacility","currency":"SEK","deedsterCategory":"wellness","id":"998fa134-1229-4c59-be95-2bd9f3a4d810","code":"7993","co2e":1.7425265375999999,"projection":0.0,"co2eCost":2.09103184512},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"bf79e883-54dc-45ac-8d1d-fa3f85b1a2f9","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"1970-01-16","likelyhood":"high","deedsterCode":"uncategorized.fallbackUncategorized","currency":"SEK","deedsterCategory":"uncategorized","id":"id","code":"non-exsiting-code","merchantLabels":[],"co2e":0.0,"projection":0.0,"co2eCost":0.0},{"description":"description","amount":100,"date":"2019-12-30","likelyhood":"high","deedsterCode":"expenses.wellness.vacation.hotelResort","currency":"SEK","deedsterCategory":"wellness","id":"265791ef-54f2-4db2-add6-7f505f72f666","code":"3752","merchantLabels":[],"co2e":2.2376736576,"projection":0.0,"co2eCost":2.6852083891199996},{"description":"description","amount":100,"date":"2019-12-28","likelyhood":"high","deedsterCode":"expenses.food.groceries.groceriesOther","currency":"SEK","deedsterCategory":"food","id":"b3cfda42-d0df-4d32-99da-48e1ec64acf8","code":"4225","merchantLabels":[],"co2e":3.9079454592,"projection":0.0,"co2eCost":4.6895345510399995}]},"footprint":{"type":"object"},"projection":{"type":"object"},"recommendedDeeds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"co2impactAdjusted":{"type":"number","format":"double","description":"Adjusted CO2e KG saving estimate on completing the deed by taking user's transactions into account","title":"deedster-api.transactions/co2impactAdjusted"}},"required":["id","co2impactAdjusted"],"description":"Deed data taken transaction into account","title":"deedster-api.transactions/transaction-deed"}}},"required":["transactions","footprint","projection"]}}}}},"summary":"Enrich transactions","tags":["Transactions"],"description":"Accepts user's bank transactions.","security":[{"apiKey":[]}]}},"/api/v1/deeds":{"get":{"parameters":[{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"responses":{"200":{"description":"List of all deeds","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","title":"deedster-api.transactions/deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}},"description":"Recommended Deeds","example":[{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}],"title":"deedster-api.transactions/recommended-deeds"}},"application/transit+msgpack":{"schema":{"type":"array","items":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","title":"deedster-api.transactions/deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}},"description":"Recommended Deeds","example":[{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}],"title":"deedster-api.transactions/recommended-deeds"}},"application/transit+json":{"schema":{"type":"array","items":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","title":"deedster-api.transactions/deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}},"description":"Recommended Deeds","example":[{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}],"title":"deedster-api.transactions/recommended-deeds"}},"application/edn":{"schema":{"type":"array","items":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","title":"deedster-api.transactions/deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}},"description":"Recommended Deeds","example":[{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0}],"title":"deedster-api.transactions/recommended-deeds"}}}}},"summary":"Get all deeds","tags":["Deeds"]}},"/api/v1/deeds/{deed-id}":{"get":{"parameters":[{"in":"path","name":"deed-id","required":true,"schema":{"type":"string","description":"Unique deed ID"},"description":"Unique deed ID"},{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"responses":{"200":{"description":"Single deed","content":{"application/json":{"schema":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0},"title":"deedster-api.transactions/deed"}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0},"title":"deedster-api.transactions/deed"}},"application/transit+json":{"schema":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0},"title":"deedster-api.transactions/deed"}},"application/edn":{"schema":{"type":"object","properties":{"co2impact":{"type":"number","format":"double","description":"Default CO2e KG saving estimate on completing the deed","title":"deedster-api.transactions/co2impact"},"level":{"enum":["easy","advanced","regular"],"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"imageUrl":{"type":"string"}},"required":["co2impact","level","tag","description","title","id","imageUrl"],"description":"Deed","example":{"id":854,"category":"food","level":"regular","title":"Vegan host","description":"Take on the vegan challenge: challenge friends or family to host a vegan dinner. Rotate who hosts the event.","imageUrl":"/img/deeds/854.jpeg","co2impact":6000.0},"title":"deedster-api.transactions/deed"}}}}},"summary":"Get deed by deed-id","tags":["Deeds"]}},"/api/v1/merchantLabels":{"get":{"parameters":[{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"responses":{"200":{"description":"List of all merchant labels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"},"description":"Merchant labels","title":"deedster-api.transactions/endpoint-merchantLabels"}},"application/transit+msgpack":{"schema":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"},"description":"Merchant labels","title":"deedster-api.transactions/endpoint-merchantLabels"}},"application/transit+json":{"schema":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"},"description":"Merchant labels","title":"deedster-api.transactions/endpoint-merchantLabels"}},"application/edn":{"schema":{"type":"array","items":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"},"description":"Merchant labels","title":"deedster-api.transactions/endpoint-merchantLabels"}}}}},"summary":"Get all merchant labels","tags":["Merchant Labels"]}},"/api/v1/merchantLabels/{merchantLabel}":{"get":{"parameters":[{"in":"path","name":"merchantLabel","required":true,"schema":{"type":"string"}},{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"responses":{"200":{"description":"Single merchant label","content":{"application/json":{"schema":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"}},"application/transit+json":{"schema":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"}},"application/edn":{"schema":{"type":"object","properties":{"merchantLabel":{"type":"string"},"sustainableChoice":{"type":"boolean"}},"required":["merchantLabel","sustainableChoice"],"title":"deedster-api.transactions/single-merchantLabel"}}}}},"summary":"Get merchant label","tags":["Merchant Labels"]}},"/api/v1/translations/deeds":{"get":{"parameters":[{"in":"header","name":"customer","required":true,"schema":{"type":"string","description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},"description":"Customer identifier eg. company name. More then 3 letters, digits or special characters(@$!%*#?&) allowed"},{"in":"header","name":"partner","required":true,"schema":{"type":"string","description":"Partner identifier will be provided to you with api key"},"description":"Partner identifier will be provided to you with api key"}],"responses":{"200":{"description":"Translations for all deeds","content":{"application/json":{"schema":{"type":"object","properties":{"it":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/it"},"de":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/de"},"fr":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/fr"}},"required":["it","de","fr"],"description":"Translations map language code -> list of translations to deeds","title":"deedster-api.transactions/translations-map"}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"it":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/it"},"de":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/de"},"fr":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/fr"}},"required":["it","de","fr"],"description":"Translations map language code -> list of translations to deeds","title":"deedster-api.transactions/translations-map"}},"application/transit+json":{"schema":{"type":"object","properties":{"it":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/it"},"de":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/de"},"fr":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/fr"}},"required":["it","de","fr"],"description":"Translations map language code -> list of translations to deeds","title":"deedster-api.transactions/translations-map"}},"application/edn":{"schema":{"type":"object","properties":{"it":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/it"},"de":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/de"},"fr":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique deed ID","title":"deed/id"},"description":{"type":"string"},"title":{"type":"string"}},"required":["id","description","title"],"description":"Deed translation","title":"deedster-api.transactions/translation"},"description":"All deed translations for a language","title":"deedster-api.transactions/fr"}},"required":["it","de","fr"],"description":"Translations map language code -> list of translations to deeds","title":"deedster-api.transactions/translations-map"}}}}},"summary":"Get all translations for deeds","tags":["Translations"]}},"/api/v1/ping":{"get":{"responses":{"200":{"description":"The server is up and running"}},"summary":"Ping"}}}}