@spec authorize(Gringotts.Money.t(), Gringotts.CreditCard.t(), keyword()) ::
  {:ok | :error, Gringotts.Response}

Performs a (pre) Authorize operation.

The authorization validates the card details with the banking network, places a hold on the transaction amount in the customer’s issuing bank and also triggers risk management. Funds are not transferred.

GlobalCollect returns a payment id which can be further used to:

• capture/3 an amount.
• refund/3 an amount
• void/2 a pre_authorization

example

Example

The following example shows how one would (pre) authorize a payment of $100 on a sample card.

iex> card = %CreditCard{
    number: "4567350000427977",
    month: 12,
    year: 43,
    first_name: "John",
    last_name: "Doe",
    verification_code: "123",
    brand: "VISA"
}

iex> amount = Money.new(100, :USD)

iex> {:ok, auth_result} = Gringotts.authorize(Gringotts.Gateways.GlobalCollect, amount, card, opts)

@spec capture(String.t(), Gringotts.Money.t(), keyword()) ::
  {:ok | :error, Gringotts.Response}

Captures a pre-authorized amount.

amount used in the pre-authorization referenced by payment_id is transferred to the merchant account by GlobalCollect.

note

Note

Authorized payment with PENDING_APPROVAL status only allow a single capture whereas the one with PENDING_CAPTURE status is used for payments that allow multiple captures.

example

Example

The following example shows how one would (partially) capture a previously authorized a payment worth $100 by referencing the obtained authorization id.

iex> amount = Money.new(100, :USD)

iex> {:ok, capture_result} = Gringotts.capture(Gringotts.Gateways.GlobalCollect, auth_result.authorization, amount, opts)

@spec purchase(Gringotts.Money.t(), Gringotts.CreditCard.t(), keyword()) ::
  {:ok | :error, Gringotts.Response}

Transfers amount from the customer to the merchant.

GlobalCollect attempts to process a purchase on behalf of the customer, by debiting amount from the customer's account by charging the customer's card.

example

Example

The following example shows how one would process a payment in one-shot, without (pre) authorization.

iex> card = %CreditCard{
    number: "4567350000427977",
    month: 12,
    year: 43,
    first_name: "John",
    last_name: "Doe",
    verification_code: "123",
    brand: "VISA"
  }

iex> amount = Money.new(100, :USD)

iex> {:ok, purchase_result} = Gringotts.purchase(Gringotts.Gateways.GlobalCollect, amount, card, opts)

@spec refund(Gringotts.Money.t(), String.t(), keyword()) ::
  {:ok | :error, Gringotts.Response}

Refunds the amount to the customer's account with reference to a prior transfer.

You always have the option to refund just a portion of the payment amount. It is also possible to submit multiple refund requests on one payment as long as the total amount to be refunded does not exceed the total amount that was paid.

example

Example

The following example shows how one would refund a previous purchase (and similarily for captures).

iex> amount = Money.new(100, :USD)

iex> {:ok, refund_result} = Gringotts.refund(Gringotts.Gateways.GlobalCollect, auth_result.authorization, amount)

Catches gateway configuration errors.

Raises a run-time ArgumentError if any of the required_config values is not available or missing from the Application config.

@spec void(
  String.t(),
  keyword()
) :: {:ok | :error, Gringotts.Response}

Voids the referenced payment.

This makes it impossible to process the payment any further and will also try to reverse an authorization on a card. Reversing an authorization that you will not be utilizing will prevent you from having to pay a fee/penalty for unused authorization requests.

example

Example

The following example shows how one would void a previous (pre) authorization. Remember that our capture/3 example only did a complete capture.

iex> {:ok, void_result} = Gringotts.void(Gringotts.Gateways.GlobalCollect, auth_result.authorization, opts)