22. Payout API

The Payout API allows you to request a payout from one of your balances to the balance's configured bank account. The payout will be executed on the next scheduled business day. If no amount is specified, the full available balance minus any configured balance reserve is paid out.

Create a payout

PayoutRequest request = new() {
    BalanceId = "bal_gVMhHKqSSRYJyPsuoPNFH",
    Amount = new Amount(Currency.EUR, "10.00"), // Optional — omit to pay out full balance
    Description = "My payout description"       // Optional
};
using var payoutClient = new PayoutClient("{yourApiKey}");
PayoutResponse response = await payoutClient.CreatePayoutAsync(request);

List payouts

using var payoutClient = new PayoutClient("{yourApiKey}");

// List all payouts
ListResponse<PayoutResponse> response = await payoutClient.GetPayoutListAsync();

// Filter by balance ID
ListResponse<PayoutResponse> response = await payoutClient.GetPayoutListAsync(
    balanceId: "bal_gVMhHKqSSRYJyPsuoPNFH");

// Paginate with from/limit and sort direction
ListResponse<PayoutResponse> response = await payoutClient.GetPayoutListAsync(
    from: "{payoutId}",
    limit: 50,
    sort: SortDirection.Desc);

Get a payout by ID

using var payoutClient = new PayoutClient("{yourApiKey}");
PayoutResponse response = await payoutClient.GetPayoutAsync("{yourPayoutId}");

Cancel a payout

using var payoutClient = new PayoutClient("{yourApiKey}");
PayoutResponse response = await payoutClient.CancelPayoutAsync("{yourPayoutId}");

Payout statuses

The PayoutStatus class contains constants for all possible payout statuses:

Constant	Value	Description
PayoutStatus.Requested	requested	The payout has been requested and will be executed on the next scheduled date.
PayoutStatus.Initiated	initiated	The payout is being executed. Funds are reserved on the balance.
PayoutStatus.ProcessingAtBank	processing-at-bank	The payout has been submitted to the bank and is being processed.
PayoutStatus.Completed	completed	The payout has been successfully sent to the destination bank account.
PayoutStatus.Failed	failed	The payout failed. Refer to the statusReason field for more details.
PayoutStatus.Canceled	canceled	The payout was canceled before it could be executed.