QITech v0.2.6

QITech.API.Debt (QITech v0.2.6) View Source

Provides debt API interfaces.

You can:

  • Create a debt
  • Retrieve a debt or a list of debts
  • Cancel a debt

QI Tech API reference

Link to this section Summary

Functions

cancel(operation_key, body \\ %{})

Cancel a debt.

create(body)

Create a debt.

create_signed(body)

Create a signed debt.

get(query_params \\ [])

Retrieve a debt or a list of debts

get_signed(query_params \\ [])

Retrieve a signed debt or a list of signed debts.

simulation(body)

Simulation a debt.

Link to this section Functions

Link to this function

cancel(operation_key, body \\ %{})

View Source

Cancel a debt.

Examples 

iex> QITech.API.Debt.cancel("8c3c7f72-cd87-4067-9b40-4b3483014d0f")
Link to this function

create(body)

View Source

Create a debt.

Examples 

iex> QITech.API.Debt.create(%{})
Link to this function

create_signed(body)

View Source

Create a signed debt.

Examples 

iex> QITech.API.Debt.create(%{})
Link to this function

get(query_params \\ [])

View Source

Retrieve a debt or a list of debts

Examples 

iex> QITech.API.Debt.get()

iex> QITech.API.Debt.get(
  [status: "opened", issuer_document_number: "31658725833", issuer_name: "Name Example", profile_document_number: "31658725833", page: 1, page_size: 100]
)
Link to this function

get_signed(query_params \\ [])

View Source

Retrieve a signed debt or a list of signed debts.

Examples 

iex> QITech.API.Debt.get_signed()


iex> QITech.API.Debt.get_signed(
  [status: "opened", issuer_document_number: "31658725833", issuer_name: "Name Example", profile_document_number: "31658725833", page: 1, page_size: 100]
)
Link to this function

simulation(body)

View Source

Simulation a debt.

Examples 

iex> QITech.API.Debt.simulation(%{})