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

Performs a (pre) Authorize operation.

The authorization validates the card details for token 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.

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

example

Example

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

iex> amount = Money.new(4200, :EUR)
iex> card_token = "tok_XXXXXXXXXXXXXXXXXXXXXXXXXXXX"

iex> {:ok, auth_result} = Gringotts.authorize(Gringotts.Gateways.Paymill, amount, card_token, opts)
iex> auth_result.id # This is the preauth-id

@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 PAYMILL when it is smaller or equal to the amount used in the pre-authorization referenced by preauth_id.

note

Note

PAYMILL allows partial captures and unlike many other gateways, and releases any remaining amount back to the payment source.

Thus, the same pre-authorisation ID cannot be used to perform multiple captures.

example

Example

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

iex> amount = Money.new(4200, :EUR)
iex> preauth_id = auth_result.id
# preauth_id = "some_authorization_id"
iex> Gringotts.capture(Gringotts.Gateways.Paymill, preauth_id, amount, opts)

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

Transfers amount from the customer to the merchant.

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

example

Example

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

iex> amount = Money.new(4200, :EUR)
iex> token = "tok_XXXXXXXXXXXXXXXXXXXXXXXXXXXX"

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

@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.

PAYMILL processes a full or partial refund worth amount, where transaction_id references a previous purchase/3 or capture/3 result.

Multiple partial refunds are allowed on the same transaction_id till all the captured/purchased amount has been refunded.

example

Example

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

iex> transaction_id = purchase_result.id
iex> amount = Money.new(4200, :EUR)
iex> Gringotts.refund(Gringotts.Gateways.Paymill, amount, transaction_id)

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 authorization.

Attempts a reversal of the a previous authorize/3 referenced by preauth_id.

example

Example

The following example shows how one would void a previous authorization.

iex> preauth_id = auth_result.id
iex> Gringotts.void(Gringotts.Gateways.Paymill, preauth_id)