TruelayerClient.Payouts (truelayer_client v1.0.0)

Copy Markdown View Source

TrueLayer Payouts API — move funds from a merchant account to an external bank account.

All calls are ES512 request-signed and idempotent.

Summary

Functions

Create a payout (POST /v3/payouts).

Get a payout by ID (GET /v3/payouts/{id}).

Functions

create_payout(client, params, opts)

@spec create_payout(TruelayerClient.t(), map(), keyword()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Create a payout (POST /v3/payouts).

Required option

  • :operation_id — stable ID for idempotency

get_payout(client, payout_id)

@spec get_payout(TruelayerClient.t(), String.t()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Get a payout by ID (GET /v3/payouts/{id}).