Skip to content

schneems/gringotts

 
 

Repository files navigation

Gringotts Logo

Gringotts is a payment processing library in Elixir integrating various payment gateways, this draws motivation for shopify's activemerchant gem.

Build Status Coverage Status Docs coverage

A simple and unified API to access dozens of different payment gateways with very different internal APIs is what Gringotts has to offer you.

Installation

From hex.pm

Make the following changes to the mix.exs file.

Add gringotts to the list of dependencies.

def deps do
  [
    {:gringotts, "~> 1.0"}
  ]
end

Add gringotts to the list of applications to be started.

def application do
  [
    extra_applications: [:gringotts]
  ]
end

Usage

This simple example demonstrates how a purchase can be made using a person's credit card details.

Add configs in config/config.exs file.

config :gringotts, Gringotts.Gateways.Stripe,
  adapter: Gringotts.Gateways.Stripe,
  secret_key: "YOUR_KEY",
  default_currency: "USD"

Copy and paste this code in your module

alias Gringotts.Gateways.Stripe
alias Gringotts.{CreditCard, Address, Worker, Gateways}

card = %CreditCard{
  first_name: "John",
  last_name: "Smith",
  number: "4242424242424242",
  year: "2017",
  month: "12",
  verification_code: "123"
}

address = %Address{
  street1: "123 Main",
  city: "New York",
  region: "NY",
  country: "US",
  postal_code: "11111"
}

opts = [address: address, currency: "eur"]

case Gringotts.purchase(Stripe, 10, card, opts) do
  {:ok,    %{authorization: authorization}} ->
    IO.puts("Payment authorized #{authorization}")

  {:error, %{code: :declined, reason: reason}} ->
    IO.puts("Payment declined #{reason}")

  {:error, %{code: error}} ->
    IO.puts("Payment error #{error}")
end

Supported Gateways

  • Authorize.Net - AD, AT, AU, BE, BG, CA, CH, CY, CZ, DE, DK, ES, FI, FR, GB, GB, GI, GR, HU, IE, IT, LI, LU, MC, MT, NL, NO, PL, PT, RO, SE, SI, SK, SM, TR, US, VA
  • CAMS: Central Account Management System - AU, US
  • MONEI - AD, AT, BE, BG, CA, CH, CY, CZ, DE, DK, EE, ES, FI, FO, FR, GB, GI, GR, HU, IE, IL, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK, TR, US, VA
  • PAYMILL - AD, AT, BE, BG, CH, CY, CZ, DE, DK, EE, ES, FI, FO, FR, GB, GI, GR, HU, IE, IL, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK, TR, VA
  • Stripe - AT, AU, BE, CA, CH, DE, DK, ES, FI, FR, GB, IE, IN, IT, LU, NL, NO, SE, SG, US
  • TREXLE - AD, AE, AT, AU, BD, BE, BG, BN, CA, CH, CY, CZ, DE, DK, EE, EG, ES, FI, FR, GB, GI, GR, HK, HU, ID, IE, IL, IM, IN, IS, IT, JO, KW, LB, LI, LK, LT, LU, LV, MC, MT, MU, MV, MX, MY, NL, NO, NZ, OM, PH, PL, PT, QA, RO, SA, SE, SG, SI, SK, SM, TR, TT, UM, US, VA, VN, ZA
  • Wirecard - AD, CY, GI, IM, MT, RO, CH, AT, DK, GR, IT, MC, SM, TR, BE, EE, HU, LV, NL, SK, GB, BG, FI, IS, LI, NO, SI, VA, FR, IL, LT, PL, ES, CZ, DE, IE, LU, PT, SE

Road Map

  • Support more gateways on an on-going basis.
  • Each gateway request is hosted in a worker process and supervised.

License

MIT

About

A complete payment library for Elixir and Phoenix Framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Elixir 100.0%