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

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.

MONEI returns an ID string which can be used to:

• capture/3 an amount.
• void/2 a pre-authorization.

note

Note

• The :register option when set to true will store this card for future use, and you will recieve a registration token in the :token field of the Response struct.
• A stand-alone pre-authorization expires in 72hrs.

example

Example

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

iex> amount = Money.new(42, :USD)
iex> card = %Gringotts.CreditCard{first_name: "Harry", last_name: "Potter", number: "4200000000000000", year: 2099, month: 12, verification_code:  "123", brand: "VISA"}
iex> {:ok, auth_result} = Gringotts.authorize(Gringotts.Gateways.Monei, amount, card, opts)
iex> auth_result.id # This is the authorization ID
iex> auth_result.token # This is the registration ID/token

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

Captures a pre-authorized amount.

amount is transferred to the merchant account by MONEI when it is smaller or equal to the amount used in the pre-authorization referenced by payment_id.

note

Note

MONEI allows partial captures and unlike many other gateways, does not release the remaining amount back to the payment source. Thus, the same pre-authorisation ID can be used to perform multiple captures, till:

• all the pre-authorized amount is captured or,
• the remaining amount is explicitly "reversed" via void/2. [citation-needed]

example

Example

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

iex> amount = Money.new(35, :USD)
iex> {:ok, capture_result} = Gringotts.capture(Gringotts.Gateways.Monei, amount, auth_result.id, opts)

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

Transfers amount from the customer to the merchant.

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

note

Note

• The :register option when set to true will store this card for future use, and you will recieve a registration token in the :token field of the Response struct.

example

Example

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

iex> amount = Money.new(42, :USD)
iex> card = %Gringotts.CreditCard{first_name: "Harry", last_name: "Potter", number: "4200000000000000", year: 2099, month: 12, verification_code:  "123", brand: "VISA"}
iex> {:ok, purchase_result} = Gringotts.purchase(Gringotts.Gateways.Monei, amount, card, opts)
iex> purchase_result.token # This is the registration ID/token

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

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

MONEI processes a full or partial refund worth amount, referencing a previous purchase/3 or capture/3.

The end customer will always see two bookings/records on his statement. Refer MONEI's Backoffice Operations guide.

example

Example

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

iex> amount = Money.new(42, :USD)
iex> {:ok, refund_result} = Gringotts.refund(Gringotts.Gateways.Monei, purchase_result.id, amount)

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

Stores the payment-source data for later use.

MONEI can store the payment-source details, for example card or bank details which can be used to effectively process One-Click and Recurring payments, and return a registration token for reference.

The registration token is available in the Response.id field.

It is recommended to associate these details with a "Customer" by passing customer details in the opts.

note

Note

• One-Click and Recurring payments are currently not implemented.
• Payment details can be saved during a purchase/3 or capture/3.

example

Example

The following example shows how one would store a card (a payment-source) for future use.

iex> card = %Gringotts.CreditCard{first_name: "Harry", last_name: "Potter", number: "4200000000000000", year: 2099, month: 12, verification_code:  "123", brand: "VISA"}
iex> {:ok, store_result} = Gringotts.store(Gringotts.Gateways.Monei, card)
iex> store_result.id # This is the registration token

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

WIP

MONEI unstore does not seem to work. MONEI always returns a 403

Deletes previously stored payment-source data.

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.t()}

Voids the referenced payment.

This method attempts a reversal of the either a previous purchase/3, capture/3 or authorize/3 referenced by payment_id.

As a consequence, the customer will never see any booking on his statement. Refer MONEI's Backoffice Operations guide.

voiding-a-previous-authorization

Voiding a previous authorization

MONEI will reverse the authorization by sending a "reversal request" to the payment source (card issuer) to clear the funds held against the authorization. If some of the authorized amount was captured, only the remaining amount is cleared. [citation-needed]

voiding-a-previous-purchase

Voiding a previous purchase

MONEI will reverse the payment, by sending all the amount back to the customer. Note that this is not the same as refund/3.

example

Example

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

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