GoCardless Payouts API.
Payouts are batched settlements from GoCardless to your creditor bank account. GoCardless aggregates collected payments and sends periodic payouts.
Payout states
pending → paid
Example
{:ok, %{items: payouts}} = GoCardlessClient.Resources.Payouts.list(client, %{
status: "paid",
currency: "GBP"
})Summary
Functions
@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, [map()]} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Eagerly collects all payouts into a list.
@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Retrieves a single payout by ID.
@spec list(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, %{items: [map()], meta: map()}} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Returns a page of payouts.
Filter by :creditor, :creditor_bank_account, :currency, :status,
:created_at[gte], :created_at[lte], :payout_type ("merchant" or "partner").
@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()
Returns a lazy Stream over all pages of payouts.
@spec update(GoCardlessClient.Client.t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Updates a payout's metadata. Only :metadata can be changed.