message | string | Human-readable result of the call. |
success | boolean | true when at least part of the basket went through; false (HTTP 400) when the payment was not processed at all. |
data.error_code | string | Empty when every line went through; partial when any line did not — data.purchase_failed then says which and why. On a refused call one of: invalid_request, nothing_to_purchase (the invoices carried no quantity to buy, so both arrays are empty), 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. A line that was paid but not delivered is part of it; a line that was never charged (payment_failed, on_average_price_wallet, insufficient_qty) is not. |
data.purchase_successful[] | object | Lines paid and delivered — fields below, status is paid. |
data.purchase_failed[] | object | Lines that did not go through — the same fields; status says why, and what the line reports follows the rule above. |
data.purchase_successful[].asset_name | string | Asset the credits were purchased from, under its current name. |
data.purchase_successful[].asset_id | string | Identifier of that asset — 32 uppercase hexadecimal characters. 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. Known from the plan, so it is reported whatever became of the payment; null only on insufficient_qty, where the line never matched a pool record. Get Available Assets answers it for the previewed line and Get Carbon Transactions for the transaction afterwards. |
data.purchase_successful[].viewer | string | Address of the asset's Parameters Viewer — the page holding the parameters of that asset. Known from the plan like asset_id, so it is reported whatever became of the payment. null when there is no such page: only a Carbon Credit asset has one, and an insufficient_qty line has no asset at all. |
data.purchase_successful[].instrument_type | string | Instrument Type of that asset. Known from the plan like asset_id, so it is reported whatever became of the payment; null only on insufficient_qty, and when the asset carries none. An asset may carry several; they come back in one string, comma-separated — for example Engineered, Nature-based. |
data.purchase_successful[].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.purchase_successful[].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.purchase_successful[].payment_intent_id | string | Identifier of the payment at the provider. Each line is paid by itself, so this value belongs to that line alone; null when paid from the balance or when the line was never charged. |
data.purchase_successful[].employee_id | integer | Employee who pays the line, as in Get Employees — employee_id; null on an Individual Consumption line. |
data.purchase_successful[].client_employee_id | string | Client-facing Employee ID (the employee_number of Get Employees); null on an Individual Consumption line. |
data.purchase_successful[].employee_name | string | Name of the employee who pays the line. The payer is known from the invoice, so it is reported whatever became of the payment; unlike employee_id it is filled on an Individual Consumption line as well, where it repeats the name inside individual_consumption. |
data.purchase_successful[].individual_consumption | object | Individual Consumption billed — individual_consumption_id (as in Get Individual Consumptions), name, email; null on other lines and on clients that are not Business accounts. |
data.purchase_successful[].credit_card | boolean | Whether the payer of the line has a credit card on file. It describes the payer, not this payment, so it is reported whatever the line was paid with; the card that was actually charged is credit_card_last4. |
data.purchase_successful[].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.purchase_successful[].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.purchase_successful[].carbon_type | string | Expense Type. One of: AI Compute, Air Travel, Vehicle, Lodging or Food. |
data.purchase_successful[].co2 | number | Quantity the line was priced for, tons. |
data.purchase_successful[].pool_px | object | Price per ton the line was quoted at — currency and decimal string. Reported even when the line was never charged; null only on insufficient_qty. |
data.purchase_successful[].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.purchase_successful[].created_at | string | When the purchase happened, ISO 8601 in UTC; null on a line that was never charged. |
data.purchase_successful[].invoice_id / invoice_number | integer / string | The invoice of the line, as in Get Invoices. |
data.purchase_successful[].transaction_type | string | Transaction Type of the expense lines this line covers, when there is exactly one — the category the purchased CO2 is attributed to. One of business_travel, employee_commuting, purchased_goods_and_services, as in Get Invoices — expense_lines[].transaction_type. null when those lines carry different types (see transaction_types) or carry no Transaction Type. Get Carbon Transactions answers the same value for the transaction this line became. |
data.purchase_successful[].transaction_types | array | Every Transaction Type of the expense lines the line covers, each once. [] when they carry none. Get Carbon Transactions answers the same list for the transaction this line became. |
data.purchase_successful[].delivered_co2 | number | Quantity actually retired; lower than co2 when the pool record had less left, and 0 when the line was not delivered. Paid from the balance, the difference is returned automatically and appears in the journal as a refund. |
data.purchase_successful[].average_price_wallet | boolean | Whether the line sits on the Average Price Wallet. |
data.purchase_successful[].status | string | Outcome of the line — see Status values below. |
data.purchase_successful[].comment | string | The same outcome in words, and the one place that says what happened to the money and to the tokens. paid: 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. A line that was never charged says so and names why: payment_failed — The payment was not processed - check the payment method and try again. No payment was taken and no tokens were burned., or, when the same invoices are submitted twice within 10 seconds, The same purchase was submitted less than 10 seconds ago. No payment was taken and no tokens were burned.; on_average_price_wallet — Purchase QTY is on Average Price Wallet, please contact Triangle Admin. No payment was taken and no tokens were burned.; insufficient_qty — The pool does not have enough quantity to cover this line. No payment was taken and no tokens were burned. For a charged line the same text is answered by Get Carbon Transactions afterwards. |
operations_count | integer | Always 1. |