pinxs v0.1.2 PINXS.Recipients.Recipient View Source
Provides functions for working with payment recipients
Required fields
All recipients require the following fields
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
Update recipient details
Link to this section Types
Link to this section Functions
Link to this function
create(recipient)
View Source
create(PINXS.Recipients.Recipient.t()) :: {:ok, PINXS.Recipients.Recipient.t()} | {:error, PINXS.Error.t()}
Create a recipient
Link to this function
get(recipient_token)
View Source
get(String.t()) :: {:ok, PINXS.Recipients.Recipient.t()} | {:error, PINXS.Error.t()}
Gets a recipient
Link to this function
get_all()
View Source
get_all() :: {:ok, [PINXS.Recipients.Recipient.t()]} | {:error, PINXS.Error.t()}
Gets a paginated list of recipients
Get a specific page of recipients
Update recipient details