API Reference

Transaction Batch Upload API

post
https://api.connect.earth/transaction/bulk/upload

Upload transaction batches with a limit of 500 transactions per request. These transactions are processed asynchronously and can be retrieved by calling fetch and insights endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Object with transaction array needed to provide CO2e estimates. Note that geo, userId, and userType can be defined at the root level (applying to all transactions in the request) or on individual transactions. If they are defined at the transaction level then this will take precedence over the root level. Every transaction must have a userId and a geo from one of the two levels. Setting userId per transaction allows transactions belonging to multiple users to be batched into a single request (up to the 500 transaction limit).

string
enum
Defaults to BE

Indicates the specific country that should be used for the CO2 emissions factors (see all countries supported).

string
Defaults to user-123

Unique ID of the user that all transactions in the request belong to. Optional if every transaction in the transactions array carries its own userId, which allows a single request to contain transactions from multiple users. A transaction-level userId takes precedence over this value.

string
enum

Indicates whether the API should use emissions factors for people or businesses. Either: "PERSONAL"(default), "BUSINESS")

Allowed:
transactions
array
required
Defaults to [object Object]

Array of transactions

transactions*
string

Unique ID of the user this transaction belongs to. Overrides the root-level userId. Every transaction must have a userId either here or at the root level.

string
required
Defaults to mcc

Category type used to estimate the emissions.

string
required
Defaults to 5411

Category value used to estimate the emissions.

string
enum
required

ISO Currency Code of Purchase (see all currencies supported). You can input the string of stringified number code (ex: "USD" or "840").

float
required
Defaults to 20.22

Price of purchase

string
required
Defaults to 12356_id

Unique ID of the transaction

date
required
Defaults to 2022-03-02

Date of the transaction

string
enum

Indicates whether the API should use emissions factors for people or businesses. Either: "PERSONAL"(default), "BUSINESS")

Allowed:
string
enum
Defaults to BE

Indicates the specific country that should be used for the CO2 emissions factors (see all countries supported).

string

Name of the merchant.

string

Description of the transaction.

string
deprecated

Merchant Category Code of Merchant.

Headers
string
required
Responses

Updated over 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?