Quote a payment to a Beneficiary
customer:payouts:createAPI referansındaki uç nokta açıklamaları İngilizcedir.Prices sending amount of source_asset from the Customer's balance to one of its Beneficiaries, in the Beneficiary's country and asset. The answer holds one Quote per eligible Route: what the Beneficiary receives, every fee line and rate passed through, the Providers in order, the estimated arrival and expires_at. The Quote that delivers most is labelled cheapest and the one that settles soonest fastest (one Quote may carry both); preference only decides which comes first. Accept one with POST /v1/payouts and its quote_id before it expires, counting the time left from server_time rather than your own clock.
When no Route is eligible the answer is still 201, with no Quotes and an unavailable_reason:
beneficiary_not_verified: the Beneficiary waits for verification or is blocked, or is another Customer that cannot be paid now;onboarding_required: a Provider on the Route has not approved the Customer yet;funds_at_other_provider: the Customer holds the amount, but at another Provider than the Routes start at;deposit_atnames the Providers to deposit the asset at instead (seeGET /v1/deposit-instructions);temporarily_unavailable: a Route exists but cannot be used for now; try again later;amount_out_of_range: the amount is outside what the Routes take, or does not cover their fees;no_route: nothing serves this asset and destination for this Customer.
Worked example: 1000 USDC to a Beneficiary in Germany paid in EUR by SEPA Instant is a 1 USDC conversion fee, the rate 0.92 and a 0.5 EUR payout fee: 918.58 EUR arrive.
Requires the customer:payouts:create permission. A Platform may call it for one of its End Customers with Apex-End-Customer.
ApiKeyYetkilendirmeBearer <API key>A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.
Apex-End-Customer?stringA Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.
uuidWhat to send, to whom and why.
application/json- body
amount*stringamount is how much of the source asset to send, a decimal string.
length <= 40beneficiary_id*stringpreference?stringpreference only orders the answer; every eligible Quote is answered.
"cheapest""fastest"purpose*stringpurpose is why the Customer pays; Providers require it.
"services""payroll""supplier""goods""digital_goods"source_asset*stringsource_asset is the asset sent from the Customer's balance.
length <= 10Created
application/json- response
deposit_at?array<string>deposit_at names, with funds_at_other_provider, the Providers the Customer may deposit the send asset at to be offered a Route, sorted, as /v1/deposit-instructions names them.
quote_set_id?stringquotes*array<>server_time*stringserver_time is when the answer was made, in UTC: a client counts a Quote's time left from it rather than from its own clock, which may be minutes off either way.
date-timeunavailable_reason?stringunavailable_reason says, when there is no Quote, why.
"beneficiary_not_verified""onboarding_required""funds_at_other_provider""temporarily_unavailable""amount_out_of_range""no_route"curl -X POST 'http://localhost:3480/v1/quotes' \ -H 'Content-Type: application/json' \ -d '{ "amount": "1000", "beneficiary_id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a", "purpose": "supplier", "source_asset": "USDC"}'{ "deposit_at": [ "bvnk" ], "quote_set_id": "4f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "quotes": [ { "estimated_arrival": "2026-11-12T09:31:00Z", "expires_at": "2026-11-12T09:30:30Z", "fees": [ { "amount": { "amount": "1", "asset": "USDC" }, "component": "provider", "provider": "bvnk" }, { "amount": { "amount": "0.5", "asset": "EUR" }, "component": "provider", "provider": "bvnk" } ], "labels": [ "cheapest", "fastest" ], "providers": [ "bvnk" ], "quote_id": "qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD", "rates": [ { "provider": "bvnk", "rate": "0.92" } ], "receive": { "amount": "918.58", "asset": "EUR" }, "send": { "amount": "1000", "asset": "USDC" }, "settlement_seconds": 90 } ], "server_time": "2026-11-12T09:29:30Z", "unavailable_reason": "beneficiary_not_verified"}