[![Build Status](](

![Pin Payments](

What could be a more Australian name for an Elixir library when using [Pin Payments](

Made with love at [HotDoc](


## Installation

def deps do
    {:pinxs, "~> 0.1.0"}

You will also need to add your API key to your config.

config :pinxs,
  api_key: "${PIN_PAYMENTS_API_KEY}",
  pin_url: "" # or "" in test environment

## Overview

All responses are transformed to return `{:ok, item(s)}` or `{:error, PINX.Error}`

This enables us to leverage pattern matching and the `with` construct very nicely.

### Example charge creation

    order = Order.create(#...)

    card = %Card{
      number: "5520000000000000",
      expiry_month: "12",
      expiry_year: "20",
      name: "Rubius Hagrid",
      address_line1: "The Game Keepers Cottage",
      address_city: "Hogwarts",
      address_country: "England",
      cvc: "321"

    charge = %Charge{
      email: "hagrid@hogwarts.wiz",
      description: "Dragon eggs",
      ip_address: "",
      amount: 50000,
      card: card

    with {:ok, created_order} <- Repo.insert(order),
         {:ok, created_charge} <- Charge.create(charge),
         {:ok, paid_order} <- Order.mark_paid(created_order, created_charge),
         {:ok, _email} <- Mailer.send("receipt", created_charge),
         {:ok, _email} <- Mailer.send("notify_fulfullment_team", order)
    do {:ok, created_order}
      {:error, %Changeset{} = changeset} ->
        #response appropriately to changeset error
      {:error, %PinError{error_code: "insufficient_funds"}} ->
        Mailer.send("order_failed", charge)
      {:error, other} ->
        # handle some other error
      error -> 
        Logger.error("Some unknown error: #{IO.inspect(error)}")


## Testing

All of the HTTP request / responses have been stored using ExVCR, this makes it relatively easy to test.

If you need to make changes to the stored responses, then you'll need to set your Pin API key as an environment variable.

export PIN_API_KEY=mykey

And then you can run `mix vcr.delete` to remove all the stored response and work with your own set