pinxs v2.0.3 PINXS.Recipients.Recipient View Source

Provides functions for working with payment recipients

Required fields

All recipients require the following fields

  • email

And one of the following

  • bank_account
  • bank_account_token

Link to this section Summary

Functions

Create a recipient

Gets a recipient

Gets a paginated list of recipients

Get a specific page of recipients

Link to this section Types

Link to this type t() View Source
t() :: %PINXS.Recipients.Recipient{
  bank_account: nil | map(),
  bank_account_token: nil | String.t(),
  created_at: nil | String.t(),
  email: String.t(),
  name: nil | String.t(),
  token: nil | String.t()
}

Link to this section Functions

Create a recipient

Link to this function get(recipient_token, config) View Source
get(String.t(), PINXS.t()) ::
  {:ok, PINXS.Recipients.Recipient.t()} | {:error, PINXS.Error.t()}

Gets a recipient

Link to this function get_all(config) View Source
get_all(PINXS.t()) ::
  {:ok, [PINXS.Recipients.Recipient.t()]} | {:error, PINXS.Error.t()}

Gets a paginated list of recipients

Get a specific page of recipients

Link to this function update_recipient(recipient, params, config) View Source

Update recipient details