message | string | Human-readable result of the call. |
success | boolean | Whether the call succeeded; a refused call answers HTTP 400. |
data.error_code | string | Empty when everything was sold; partial when part of the basket was not. On a refused call one of: invalid_request, pool_changed, no_card, amount_too_small, insufficient_balance, balance_error, card_declined, duplicate_operation (the Idempotency-Key was already used by a processed purchase), duplicate_purchase (the same purchase — same pools, payer and payment source — was submitted again less than 10 seconds ago), below_minimum (the purchase is under the minimum for paying from the balance with autofill_balance off). |
data.notional | object | Amount actually charged — currency and decimal string. 0.00 when nothing was charged. |
data.pools[].record_id | integer | The requested record, as passed in the body. |
data.pools[].status | string | Outcome of the line — see Status values below. What the line fills follows the rule at the top of this page. |
data.pools[].comment | string | The same outcome in words, and the one place that says what happened to the money and to the tokens. ok: Paid and burned. not_delivered: Paid, but the token burn was not completed: "<reason>". The money was returned to the balance. — the reason is quoted as the network worded it (left out when it gave none), and paid by card the last sentence is The money was not returned - please contact Triangle Admin. average_price_wallet: Purchase QTY is on Average Price Wallet, please contact Triangle Admin. No payment was taken and no tokens were burned. null when status is null: the purchase was refused before any line had an outcome, and the reason is in message and data.error_code. The same text is answered by Get Carbon Transactions for the line afterwards. |
data.pools[].asset_name | string | Asset the credits were purchased from, under its current name; filled whatever the outcome of the line. |
data.pools[].asset_id | string | Identifier of that asset — 32 uppercase hexadecimal characters — resolved from the pool record, so it is filled whatever the outcome of the line: a line that was never charged still says which asset it was about. It is the stable half of the pair: asset_name is the asset's CURRENT name and changes when the asset is renamed, while this value does not. Get Pool List answers it for the record before the purchase, and Get Carbon Transactions after it. |
data.pools[].viewer | string | Address of the asset's Parameters Viewer — the page holding the parameters of that asset. Resolved from the pool record like asset_id, so it is filled whatever the outcome of the line. null when the asset has no such page: only a Carbon Credit asset has one. |
data.pools[].instrument_type | string | Instrument Type of that asset, resolved from the pool record like asset_id, so it is filled whatever the outcome of the line. An asset may carry several; they come back in one string, comma-separated — for example Engineered, Nature-based. null when the asset carries none. |
data.pools[].transaction_id | uuid | Identifier of the transaction the line became. Read it back with Get Carbon Transactions — transaction_id. null on a line that was never charged: there is no transaction to read back. |
data.pools[].retirement_id | string | Hash of the Ethereum transaction that retired the purchased quantity. null when the quantity was not retired on Ethereum, and on any line that was not delivered. |
data.pools[].payment_intent_id | string | Identifier of the payment at the provider; one payment covers the whole purchase, so every charged line of the answer carries the same value. null when paid from the balance or when the line was never charged. |
data.pools[].company_id | uuid | Carbon Pool company the purchase was made for (Business), as in Get Companies — company_id; null otherwise. |
data.pools[].client_company_id | string | Company ID entered by the client; null when the purchase is not for a company. |
data.pools[].company_name | string | Name of that Carbon Pool company, as in Get Companies — company_name. null when the purchase is not for a company, when the company was created without a name, and on a line that was never charged. |
data.pools[].employee_id | integer | Employee the purchase is billed to, as in Get Employees — employee_id; null on an Individual Consumption purchase. |
data.pools[].client_employee_id | string | Client-facing Employee ID (the employee_number of Get Employees); null on an Individual Consumption purchase. |
data.pools[].employee_name | string | Name of the employee the purchase is billed to. Unlike employee_id it is filled on an Individual Consumption purchase as well, where it repeats the name inside individual_consumption. null on a line that was never charged. |
data.pools[].individual_consumption | object | Individual Consumption billed — individual_consumption_id, name, email; null otherwise. |
data.pools[].credit_card | boolean | Whether the payer has a credit card on file. It describes the payer, not this payment, so it is reported whatever the purchase was paid with; the card that was actually charged is credit_card_last4. |
data.pools[].credit_card_last4 | string | Last 4 digits of the card that was charged; null when paid from the balance or when the line was never charged. |
data.pools[].payment_source | string | How the line was paid: balance — from the Spending Capacity balance, card — by credit card. null on a line that was never charged. |
data.pools[].carbon_type | string | The requested Expense Type. One of: AI Compute, Air Travel, Vehicle, Lodging or Food. |
data.pools[].co2 | number | Purchased quantity, tons of CO2e; echoes the requested qty on a line that was not sold. |
data.pools[].pool_px | object | Price per ton the line was quoted at — currency and decimal string. Reported even when the line was never charged. |
data.pools[].notional | object | Line total at that price — currency and decimal string. Same rule as pool_px, so it is not by itself proof that the money moved — see Adding up what was paid above. |
data.pools[].created_at | string | When the purchase happened, ISO 8601 in UTC; null on a line that was never charged. |
operations_count | integer | Always 1. |