API Reference

Create funds allocation

post
https://api.ekko.earth/v3/funds/allocations

Allocate funds using a quote reference.

For checkout SDK sessions the quoteId arrives in the SDK's events.

You must send at least one of credits or contribution. Sending both is allowed.

Carbon credits and sustainability contributions are allocated differently because they represent different types of impact.

Sustainability contributions are made to an impact partner organisation, which then decides how best to allocate funds across its projects. As a result, contributions are allocated at the impact partner level, rather than to individual projects.

Body Params
uuid
required
uuid
required
credits
object | null
contribution
object | null
boolean | null
Defaults to false

If true, ekko sends a donation tax receipt to consumerEmail confirming the sustainability contribution and noting it may be tax deductible. Required for US charity compliance. consumerEmail must be provided when this is true.

string | null

Email address to send the donation tax receipt to. Required when issueTaxReceipt is true.

Headers
string
required
^\d{4}-\d{2}-\d{2}\.[a-z]+$
Defaults to 2026-10-06.pangolin

The API version the request was built against, as YYYY-MM-DD.animal. Required on every request. See Versioning.

string
length between 1 and 255

Optional but recommended on every POST. A retry that carries the same key returns the first attempt's outcome instead of performing the operation twice.

Reuse the key on every retry. A different request needs a different key. See Idempotency.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago

Did this page help you?