View Source ExOAPI.Stripe.SDK.Issuing (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Authorization</code> object.</p>

description: <p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Cardholder</code> object.</p>

description: <p>Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Card</code> object.</p>

description: <p>Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Dispute</code> object.</p>

description: <p>Returns a list of Issuing <code>Settlement</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Settlement</code> object.</p>

description: <p>Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

description: <p>Retrieves an Issuing <code>Transaction</code> object.</p>

description: <p>Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

description: <p>Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real-time authorization</a> flow.</p>

description: <p>Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real time authorization</a> flow.</p>

description: <p>Creates a new Issuing <code>Cardholder</code> object that can be issued cards.</p>

description: <p>Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

description: <p>Creates an Issuing <code>Card</code> object.</p>

description: <p>Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

description: <p>Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a> for more details about evidence requirements.</p>

description: <p>Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string.</p>

description: <p>Submits an Issuing <code>Dispute</code> to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a>.</p>

description: <p>Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

description: <p>Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this section Types

Link to this type

get_issuing_authorizations_authorization_opts()

View Source
@type get_issuing_authorizations_authorization_opts() :: {:expand, String.t()}
Link to this type

get_issuing_authorizations_opts()

View Source
@type get_issuing_authorizations_opts() ::
  {:status, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:cardholder, String.t()}
  | {:card, String.t()}
Link to this type

get_issuing_cardholders_cardholder_opts()

View Source
@type get_issuing_cardholders_cardholder_opts() :: {:expand, String.t()}
Link to this type

get_issuing_cardholders_opts()

View Source
@type get_issuing_cardholders_opts() ::
  {:type, String.t()}
  | {:status, String.t()}
  | {:starting_after, String.t()}
  | {:phone_number, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:email, String.t()}
  | {:created, String.t()}
Link to this type

get_issuing_cards_card_opts()

View Source
@type get_issuing_cards_card_opts() :: {:expand, String.t()}
Link to this type

get_issuing_cards_opts()

View Source
@type get_issuing_cards_opts() ::
  {:type, String.t()}
  | {:status, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:last4, String.t()}
  | {:expand, String.t()}
  | {:exp_year, String.t()}
  | {:exp_month, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:cardholder, String.t()}
Link to this type

get_issuing_disputes_dispute_opts()

View Source
@type get_issuing_disputes_dispute_opts() :: {:expand, String.t()}
Link to this type

get_issuing_disputes_opts()

View Source
@type get_issuing_disputes_opts() ::
  {:transaction, String.t()}
  | {:status, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
Link to this type

get_issuing_settlements_opts()

View Source
@type get_issuing_settlements_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
Link to this type

get_issuing_settlements_settlement_opts()

View Source
@type get_issuing_settlements_settlement_opts() :: {:expand, String.t()}
Link to this type

get_issuing_transactions_opts()

View Source
@type get_issuing_transactions_opts() ::
  {:type, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:cardholder, String.t()}
  | {:card, String.t()}
Link to this type

get_issuing_transactions_transaction_opts()

View Source
@type get_issuing_transactions_transaction_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_issuing_authorizations(client, opts \\ [])

View Source
@spec get_issuing_authorizations(client :: ExOAPI.Client.t(), [
  get_issuing_authorizations_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_authorizations_authorization(client, authorization, opts \\ [])

View Source
@spec get_issuing_authorizations_authorization(
  client :: ExOAPI.Client.t(),
  authorization :: String.t(),
  [get_issuing_authorizations_authorization_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Authorization</code> object.</p>

Link to this function

get_issuing_cardholders(client, opts \\ [])

View Source
@spec get_issuing_cardholders(client :: ExOAPI.Client.t(), [
  get_issuing_cardholders_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_cardholders_cardholder(client, cardholder, opts \\ [])

View Source
@spec get_issuing_cardholders_cardholder(
  client :: ExOAPI.Client.t(),
  cardholder :: String.t(),
  [get_issuing_cardholders_cardholder_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Cardholder</code> object.</p>

Link to this function

get_issuing_cards(client, opts \\ [])

View Source
@spec get_issuing_cards(client :: ExOAPI.Client.t(), [get_issuing_cards_opts()]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_cards_card(client, card, opts \\ [])

View Source
@spec get_issuing_cards_card(
  client :: ExOAPI.Client.t(),
  card :: String.t(),
  [get_issuing_cards_card_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Card</code> object.</p>

Link to this function

get_issuing_disputes(client, opts \\ [])

View Source
@spec get_issuing_disputes(client :: ExOAPI.Client.t(), [get_issuing_disputes_opts()]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_disputes_dispute(client, dispute, opts \\ [])

View Source
@spec get_issuing_disputes_dispute(
  client :: ExOAPI.Client.t(),
  dispute :: String.t(),
  [get_issuing_disputes_dispute_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Dispute</code> object.</p>

Link to this function

get_issuing_settlements(client, opts \\ [])

View Source
@spec get_issuing_settlements(client :: ExOAPI.Client.t(), [
  get_issuing_settlements_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Settlement</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_settlements_settlement(client, settlement, opts \\ [])

View Source
@spec get_issuing_settlements_settlement(
  client :: ExOAPI.Client.t(),
  settlement :: String.t(),
  [get_issuing_settlements_settlement_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Settlement</code> object.</p>

Link to this function

get_issuing_transactions(client, opts \\ [])

View Source
@spec get_issuing_transactions(client :: ExOAPI.Client.t(), [
  get_issuing_transactions_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_issuing_transactions_transaction(client, transaction, opts \\ [])

View Source
@spec get_issuing_transactions_transaction(
  client :: ExOAPI.Client.t(),
  transaction :: String.t(),
  [get_issuing_transactions_transaction_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves an Issuing <code>Transaction</code> object.</p>

Link to this function

post_issuing_authorizations_authorization(client, body, authorization)

View Source
@spec post_issuing_authorizations_authorization(
  client :: ExOAPI.Client.t(),
  body :: map(),
  authorization :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this function

post_issuing_authorizations_authorization_approve(client, body, authorization)

View Source
@spec post_issuing_authorizations_authorization_approve(
  client :: ExOAPI.Client.t(),
  body :: map(),
  authorization :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real-time authorization</a> flow.</p>

Link to this function

post_issuing_authorizations_authorization_decline(client, body, authorization)

View Source
@spec post_issuing_authorizations_authorization_decline(
  client :: ExOAPI.Client.t(),
  body :: map(),
  authorization :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real time authorization</a> flow.</p>

Link to this function

post_issuing_cardholders(client, body)

View Source
@spec post_issuing_cardholders(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a new Issuing <code>Cardholder</code> object that can be issued cards.</p>

Link to this function

post_issuing_cardholders_cardholder(client, body, cardholder)

View Source
@spec post_issuing_cardholders_cardholder(
  client :: ExOAPI.Client.t(),
  body :: map(),
  cardholder :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this function

post_issuing_cards(client, body)

View Source
@spec post_issuing_cards(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates an Issuing <code>Card</code> object.</p>

Link to this function

post_issuing_cards_card(client, body, card)

View Source
@spec post_issuing_cards_card(
  client :: ExOAPI.Client.t(),
  body :: map(),
  card :: String.t()
) ::
  {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this function

post_issuing_disputes(client, body)

View Source
@spec post_issuing_disputes(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a> for more details about evidence requirements.</p>

Link to this function

post_issuing_disputes_dispute(client, body, dispute)

View Source
@spec post_issuing_disputes_dispute(
  client :: ExOAPI.Client.t(),
  body :: map(),
  dispute :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string.</p>

Link to this function

post_issuing_disputes_dispute_submit(client, body, dispute)

View Source
@spec post_issuing_disputes_dispute_submit(
  client :: ExOAPI.Client.t(),
  body :: map(),
  dispute :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Submits an Issuing <code>Dispute</code> to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a>.</p>

Link to this function

post_issuing_settlements_settlement(client, body, settlement)

View Source
@spec post_issuing_settlements_settlement(
  client :: ExOAPI.Client.t(),
  body :: map(),
  settlement :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this function

post_issuing_transactions_transaction(client, body, transaction)

View Source
@spec post_issuing_transactions_transaction(
  client :: ExOAPI.Client.t(),
  body :: map(),
  transaction :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>