Brasilapi.Pix.API (BrasilAPI v0.1.5)

View Source

Client for BrasilAPI PIX endpoints.

Provides functions to fetch information about PIX (Brazilian instant payment system) participants.

Summary

Functions

get_participants()

Fetches information about all PIX participants for the current or previous day.

Functions

get_participants()

@spec get_participants() :: {:ok, [Brasilapi.Pix.Participant.t()]} | {:error, map()}

Fetches information about all PIX participants for the current or previous day.

Examples

iex> Brasilapi.Pix.API.get_participants()
{:ok, [%Brasilapi.Pix.Participant{ispb: "360305", nome: "CAIXA ECONOMICA FEDERAL", nome_reduzido: "CAIXA ECONOMICA FEDERAL"}]}

iex> Brasilapi.Pix.API.get_participants()
{:error, %{reason: :timeout}}