ClearBank.Accounts.BacsPaymentData (ClearBank v1.0.0)

Copy Markdown View Source

Bacs-specific payment data retrieval.

Covers Direct Debit collections and returns for both real and virtual accounts.

Summary

Functions

Returns collected Direct Debit payments for a mandate on a real account.

Returns returned Bacs payments for a mandate on a real account.

Functions

list_collections(client, account_id, mandate_id, opts \\ [])

@spec list_collections(ClearBank.Client.t(), String.t(), String.t(), keyword()) ::
  ClearBank.HTTP.result()

Returns collected Direct Debit payments for a mandate on a real account.

Options

  • :page_number, :page_size

Examples

{:ok, collections} = ClearBank.Accounts.BacsPaymentData.list_collections(
  client, "acct-uuid", "mandate-uuid"
)

list_returns(client, account_id, mandate_id, opts \\ [])

@spec list_returns(ClearBank.Client.t(), String.t(), String.t(), keyword()) ::
  ClearBank.HTTP.result()

Returns returned Bacs payments for a mandate on a real account.

Options

  • :page_number, :page_size

Examples

{:ok, returns} = ClearBank.Accounts.BacsPaymentData.list_returns(
  client, "acct-uuid", "mandate-uuid"
)