Cancel a Payout
customer:payouts:createAPI referansındaki uç nokta açıklamaları İngilizcedir.Cancels a Payout nothing has been reserved for yet: one awaiting_approval, or accepted and still waiting for funds. A funded Payout runs its course. The Payout's cancellable says whether this would succeed now. Any of the Customer's people or API keys holding the permission may cancel any of its Payouts.
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.
id*stringThe Payout's id.
uuidApex-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.
uuidOK
application/json- response
beneficiary*cancellable*booleancancellable says whether POST /v1/payouts/{id}/cancel would succeed now.
created_at*stringdate-timedelivered_to*stringdelivered_to is where the Payout ends: balance (the receiving Customer's platform balance) or bank_account.
"balance""bank_account"failure?fees*array<>id*stringinitiated_by*initiated_by_you?booleaninitiated_by_you says whether the caller started the Payout, in person or through a key the caller created (or, for a key, the person who created it). Every /v1 answer sets it; a webhook, which has no caller, leaves it out.
legs*array<>rates*array<>receive*send*state*string"awaiting_approval""accepted""funded""processing""completed""failed""refunded""cancelled"updated_at*stringdate-timecurl -X POST 'http://localhost:3480/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'{ "beneficiary": { "country": "DE", "id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a", "name": "Berlin Supplies GmbH", "party_type": "business" }, "cancellable": false, "created_at": "2026-11-12T09:30:02Z", "delivered_to": "bank_account", "failure": null, "fees": [ { "amount": { "amount": "1", "asset": "USDC" }, "component": "provider", "provider": "bvnk" }, { "amount": { "amount": "0.5", "asset": "EUR" }, "component": "provider", "provider": "bvnk" } ], "id": "5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f", "initiated_by": { "actor": "customer", "id": "6e5d4c3b-2a1f-4e0d-8c9b-7a6f5e4d3c2b", "kind": "api_key" }, "initiated_by_you": true, "legs": [ { "from": "USDC", "index": 0, "provider": "bvnk", "settled_at": "2026-11-12T09:30:41Z", "state": "completed", "to": "EUR" }, { "from": "EUR", "index": 1, "provider": "bvnk", "settled_at": "2026-11-12T09:31:05Z", "state": "completed", "to": "EUR" } ], "rates": [ { "provider": "bvnk", "rate": "0.92" } ], "receive": { "amount": "918.58", "asset": "EUR" }, "send": { "amount": "1000", "asset": "USDC" }, "state": "completed", "updated_at": "2026-11-12T09:31:05Z"}Get a Payout GET
One of the Customer's Payouts with its Legs (one per Provider step of its Route), fees, rates and timeline: every state it passed through, when, and who moved it (`customer` for the Customer's own people and API keys, `operations` for the operations team, `system` for the platform itself).
Get the Receiving Code and account GET
The Receiving Code the Customer hands to other Customers of the platform so they can pay it, and its Receiving Account, the verified own account those Payouts are paid into.