Skip to main content
POST
Solicitar payout
Saques passam por aprovação com verificação humana na Korbit antes da execução PIX — não são instantâneos. Acompanhe por payout.updated.v1 e GET /v1/payout-requests/{id}.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required
Required string length: 1 - 255
x-korbit-dashboard-step-up
string
Pattern: ^[A-Za-z0-9_-]{43}$

Body

application/json
amount
integer
required
Required range: 1000 <= x <= 9007199254740991
beneficiaryId
string<uuid>
required

Id do beneficiário (chave PIX de destino).

Response

Default Response

amount
integer
required
Required range: 1000 <= x <= 9007199254740991
createdAt
string<date-time>
required
feeAmount
enum<integer>
required
Available options:
0,
149,
259
id
string<uuid>
required
payoutAmount
integer
required
Required range: 1 <= x <= 9007199254740991
rejectionCode
enum<string> | null
required
Available options:
PIX_KEY_TYPE_UNSUPPORTED,
PIX_KEY_TAX_ID_MISMATCH,
MERCHANT_IDENTITY_REQUIRED
status
enum<string>
required
Available options:
RISK_REVIEW,
APPROVED,
REJECTED,
PROCESSING,
SENT_MANUAL,
SUCCEEDED,
FAILED