Estimate a payout
/api/v2/payouts/estimateCalculates what the recipient would receive for a payout, before you create it. Nothing is stored and no exchange rate is locked: the payout settles at the rate and the fees of the moment it is paid, so show the result as an estimate. Send counterpartyId to estimate for the counterparty's saved payment method, paymentMethod for a recipient who has not chosen one, or both to compare methods for one counterparty. A counterparty without a saved payment method needs paymentMethod, or the request fails with COUNTERPARTY_NOT_PAYABLE. The estimate is for a payout that is paid alone: payouts to one recipient that are paid or claimed together go out as one transfer and pay the transfer fee one time. An amount that the transfer fee uses up, or that is below the minimum of the rail, is 400 VALIDATION_FAILED on amount. Needs payouts:write.
application/json- body
amount*MoneyInputDecimal string with a . decimal point and up to two fraction digits. Minimum 0.10, maximum 1000000.00.
^\d+(?:\.\d{1,2})?$currency*stringCurrency of amount and of the invoices.
"USD""EUR""CHF""GBP"counterpartyId?|paymentMethod?||The payment method to estimate for. With counterpartyId, it replaces the saved one. Without counterpartyId, it is required: use it for a recipient who claims by link and has not chosen a method.
withInvoice?booleantrue: Talentir issues an invoice for the payout (VAT, e-invoice, Merchant of Record, DAC7). false: a plain payment without invoice, receipt or VAT. Default true.
What a payout would deliver to the recipient, at the exchange rate and the fees of this moment.
application/json- response
What a payout would deliver to the recipient, at the exchange rate and the fees of this moment.
object*"payout_estimate"Type of the object. Always payout_estimate.
"payout_estimate"amount*stringThe amount of the request, in currency.
currency*stringCurrency of amount and of the invoices. Open enum: treat an unknown value as a fallback case. Known values: USD, EUR, CHF, GBP.
vat*stringThe VAT that the invoice adds to amount, in currency. The recipient receives it with the payout. 0.00 when no VAT applies, with withInvoice: false, and without counterpartyId, because the VAT status of the recipient is then not known.
paymentMethod*|How the money is sent: the rail and the settlement currency. Account details are left out.
settlement*What the recipient would receive, after every deduction: amount plus vat, converted to the settlement currency or token at the current rate with Talentir's exchange margin, minus the transfer fee when the recipient pays it. The same object as settlement on a transaction.
curl -X POST 'https://www.talentir.com/api/v2/payouts/estimate' \ -H 'Content-Type: application/json' \ -d '{ "amount": "100.00", "currency": "USD"}'{ "object": "payout_estimate", "amount": "100.00", "currency": "USD", "vat": "100.00", "paymentMethod": { "type": "crypto", "asset": "string", "currency": "EUR" }, "settlement": { "amount": "86.890000", "currency": "string", "asset": "string" }}Pay counterparties in one request POST
Requests the transfer for up to 100 counterparty payouts. Every payout moves to `requested` in one transaction; settlement follows per payout as `payout.completed` or `payout.failed`. All or nothing: one failing item fails the request with that item's code and `error.index`, and nothing is applied. Needs `payouts:write`, plus `payouts:approve` when any payout is `failed`.
List counterparties GET
Newest first by `createdAt`, `id` as tie-breaker. A recipient-managed row that a team-managed row overrides (same email) is not listed. Needs `counterparties:read`.