Payouts
Create, retrieve, update, cancel, and list payouts to your bank account.
A payout moves funds from your VINR balance to your connected bank account. VINR calculates the available balance from captured payments minus fees, and you can trigger a payout manually or let VINR schedule them automatically.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The payout objectAsk
idstringUnique identifier for the payout, e.g. po_7Kx3mBqR.
amountintegerAmount to be transferred to your bank account, in the smallest currency unit (e.g. cents).
currencystringThree-letter ISO currency code, e.g. EUR.
statusenumOne of pending, paid, failed, or canceled.
arrival_datetimestampUnix timestamp for the estimated date the payout will arrive in the bank account.
bank_accountobjectSnapshot of the destination bank account.
createdtimestampUnix timestamp of when the payout was created.
Create a payoutAsk
Specify an amount and currency to initiate an immediate transfer from your VINR balance to your bank
account. The payout starts in pending and transitions to paid once the bank confirms receipt.
Retrieve a payoutAsk
Update a payoutAsk
Update mutable metadata on a payout. Only the metadata field can be changed after creation.
Cancel a payoutAsk
A payout can only be canceled while its status is pending. Once the bank has begun processing the
transfer, cancellation is no longer possible.
List payoutsAsk
Returns a list of payouts, optionally filtered by status. Results are sorted by creation date, newest first.
Related eventsAsk
payout.created, payout.paid, payout.failed, and payout.canceled. See Events.
