Funds

POST: /funds

The Funds endpoint lets you direct funds to one or more environmental projects. You can use it to either balance the footprint of a transaction or to enable customers to make additional contributions.

ℹ️

See the API reference for payload examples.

What it does

• Sends a contribution to a project portfolio configured under your product
• Accepts either a compensationValue (from the Impact Calculator) or a custom contribution amount
• Supports passing specific projectIds to split the contribution evenly across selected projects
• Returns a unique reference for reconciliation and reporting
• Service fee is treated as already being included in the amounts submitted

Key fields explained

• compensation → the amount required to balance a transaction (from the Impact Calculator)
• contribution → a custom amount if you want to let users choose how much to give
• projects[] → if provided, the contribution is split evenly across the listed projects
• calcReference → creates a link to the original footprint calculation to track conversion
• reference → unique ID for reconciliation and reporting. Also used for reversals.

Best practices

• Keep it simple: Use the compensationValue from the Impact Calculator when the goal is to balance a transaction. This already includes the service fee.
• Offer choice: Allow customers to pick specific projects when possible, but default to the configured portfolio for speed.
• Reconcile with confidence: Store the returned reference — it will appear in Impact Records and is key for financial reporting.