View Source StarkInfra.IssuingBin (starkinfra v0.1.0)

Groups IssuingBin related functions

Link to this section Summary

Functions

The IssuingBin object displays information of BINs registered to your Workspace. They represent a group of cards that begin with the same numbers (BIN) and offer the same product to end customers.

Same as page(), but it will unwrap the error tuple and raise in case of errors.

Receive a list of up to 100 IssuingBin structs previously registered in the Stark Infra API and the cursor to the next page.

Same as query(), but it will unwrap the error tuple and raise in case of errors.

Receive a stream of IssuingBin structs previously registered in the Stark Infra API

Link to this section Types

@type t() :: %StarkInfra.IssuingBin{
  category: term(),
  client: term(),
  created: term(),
  id: term(),
  network: term(),
  settlement: term(),
  updated: term()
}

Link to this section Functions

Link to this function

%StarkInfra.IssuingBin{}

View Source (struct)

The IssuingBin object displays information of BINs registered to your Workspace. They represent a group of cards that begin with the same numbers (BIN) and offer the same product to end customers.

attributes-return-only

Attributes (return-only):

  • :id [string]: unique BIN number registered within the card network. ex: "53810200"
  • :network [string]: card network flag. ex: "mastercard"
  • :settlement [string]: settlement type. ex: "credit"
  • :category [string]: purchase category. ex: "prepaid"
  • :client [string]: client type. ex: "business"
  • :updated [DateTime]: latest update DateTime for the IssuingBin. ex: ~U[2020-3-10 10:30:0:0]
  • :created [DateTime]: creation datetime for the IssuingBin. ex: ~U[2020-03-10 10:30:0:0]
@spec page!(
  cursor: binary(),
  limit: integer(),
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

Same as page(), but it will unwrap the error tuple and raise in case of errors.

@spec page(
  cursor: binary(),
  limit: integer(),
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, {binary(), [t()]}} | {:error, [{:error, StarkInfra.Error.t()}]}

Receive a list of up to 100 IssuingBin structs previously registered in the Stark Infra API and the cursor to the next page.

options

Options:

  • :cursor [string, default nil]: cursor returned on the previous page function call
  • :limit [integer, default 100]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35
  • :user [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

  • list of IssuingBin structs with updated attributes
  • cursor to retrieve the next page of IssuingBin structs
@spec query!(
  limit: integer(),
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

Same as query(), but it will unwrap the error tuple and raise in case of errors.

@spec query(
  limit: integer(),
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, [t()]} | {:error, [{:error, StarkInfra.Error.t()}]}

Receive a stream of IssuingBin structs previously registered in the Stark Infra API

options

Options:

  • :limit [integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35
  • :user [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

  • stream of IssuingBin structs with updated attributes