PINXS.Recipients.Recipient (pinxs v3.2.0) 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

Specs

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

Link to this function

create(recipient, config)

View Source

Create a recipient

Link to this function

get(recipient_token, config)

View Source

Gets a recipient

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