Get payout

API contract v1.0.0

On this page

getPayout

GET/v1/payouts/{payout_id}

Required scopesfinance:read

The Developer role can't grant finance:read by default. Use a key created by an Owner or Admin.

Retrieves the outgoing payout for one settlement. unknown means the bank's result can't be confirmed for now: the related settlement stays paying, the funds aren't released, and the platform runs a status query first and never pays out twice. returned means the bank returned the payout after it had succeeded; the original success record is kept. The open API can retrieve a payout only by ID: take the payout ID from the settlement's payout_id. There's no endpoint for listing payouts; view the payout list in the merchant portal.

Request headers

Request headers	Required	Format	Description
Authorization	Yes	Bearer <API_KEY>	Server-side key, to be used only on the merchant's server. The merchant and environment are derived from the key. A missing, invalid, revoked or expired key returns 401.

Request example

curl

curl -X GET 'https://api.fluxan.co/v1/payouts/<PAYOUT_ID>' \
  -H 'Authorization: Bearer <TEST_SERVER_API_KEY>'

Placeholders to replace

<PAYOUT_ID>: Replace with your actual value
<TEST_SERVER_API_KEY>: Test-environment server API key, created on the "API Key" page of the merchant portal

Note

Server API keys must only be used on your own server, so the docs site doesn't offer interactive API testing. Get a test key: API Key page in the merchant portal (opens the merchant portal in a new tab) (Test environment; Requires Owner, Admin or Developer)

Responses

The payout record.

Example

JSON

{
  "id": "po_demo_001",
  "settlement_id": "stl_demo_001",
  "amount": 96000,
  "currency": "USD",
  "status": "succeeded",
  "reference": "PAYOUT-REF-DEMO-001",
  "executed_at": "2026-09-24T03:00:00Z",
  "completed_at": "2026-09-24T05:00:00Z",
  "request_id": "req_demo_034"
}

Response fields

Returns an object. See the object section for field descriptions.

Name	Type	Required	Description
`id`	string	Required	Payout ID. Example: `po_demo_001`
`settlement_id`	string	Required	The corresponding settlement. Example: `stl_demo_001`
`amount`	integer(int64)	Required	Payout amount, in the smallest currency unit. Constraints: `≥ 1` Example: `8650`
`currency`	string	Required	Currency. Constraints: `Format ^[A-Z]{3}$` Example: `USD`
`status`	string	Required	Payout status: created, processing, unknown, succeeded, failed, canceled, returned. When unknown, the related settlement stays paying and the funds aren't released automatically. `created` `processing` `unknown` `succeeded` `failed` `canceled` `returned` More values may be added in the future. Don't treat a status you don't recognize as success. Example: `succeeded`
`reference`	string	Required	Unique payout reference assigned by the platform; it's never reused for a new transfer. Example: `PAYOUT-REF-DEMO-001`
`executed_at`	string(date-time)Nullable	Required	The time the payout was executed; null if it hasn't been executed yet. Example: `2026-09-22T03:00:00Z`
`completed_at`	string(date-time)Nullable	Required	The time the payout was confirmed, after review, as succeeded or failed; null if it hasn't been confirmed yet. Example: `2026-09-22T05:00:00Z`
`request_id`	string	Required	Unique identifier of this request, used for troubleshooting and support. Example: `req_demo_001`

Possible error codes

HTTP	Error code	When it occurs	How to handle
404	not_found	An incorrect ID; using a test key to look up a live object; looking up a platform exception refund (not returned by the open API)	Check the ID and the environment of the key you used; the platform doesn't reveal whether another merchant's object exists
401	unauthenticatedCommon	No `Authorization` header was sent; the key was copied incompletely; the old key expired after a rotation; the key was revoked	Check your credentials: on the API Key page in the merchant portal, verify the key's status and environment
403	forbiddenCommon	Creating a refund with a read-only key; calling `getEvent` without the read scope for the event's business area; if the request's source IP isn't on the key's allowlist, the more specific `ip_not_allowed` is returned	Use a key that has the required scope; don't work around the restriction
429	rate_limitedCommon	A rate limit per merchant and per key; switching keys doesn't get around the merchant's overall limit	Wait for `Retry-After` seconds, then retry with the original idempotency key
500	internal_errorCommon	—	Retry with the original idempotency key, or query by merchant order ID / refund ID; never charge again with a new key
502 / 503	upstream_unavailableCommon	A provider or platform dependency failed, and the platform can't confirm whether this request took effect	Same as above

Notes

The API can retrieve a payout only by ID. Take the payout ID from the settlement's payout_id. There's no endpoint for listing payouts. View the list in the merchant portal (Payouts (opens the merchant portal in a new tab) (Requires Owner, Admin or Finance)).
unknown means the bank's result can't be confirmed for now: the settlement stays paying, the funds aren't released, and the platform runs a status query first. It never pays out twice.
returned means the bank returned the payout after it had succeeded. The original success record is kept.

Related events: settlement.paid, settlement.failed, settlement.returned
Error codes and HTTP status

Was this page helpful?