Increase.CardValidations (Increase v1.0.0)

Copy Markdown View Source

Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.

See https://increase.com/documentation/api/card-validations for the full API reference for this resource.

Summary

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.CardValidations.CardValidation.t()}
  | {:error, Increase.Error.t()}

Create a Card Validation

POST /card_validations

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Card Validations

Returns a %Increase.Page{} whose data is a list of %__MODULE__. CardValidation{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /card_validations

retrieve(client, card_validation_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardValidations.CardValidation.t()}
  | {:error, Increase.Error.t()}

Retrieve a Card Validation

GET /card_validations/{card_validation_id}