[](https://travis-ci.org/htdc/pinxs)
# PINXS
What could be a more Australian name for an Elixir library when using [Pin Payments](https://pinpayments.com/)?
Made with love at [HotDoc](https://www.hotdoc.com.au)
Documentation a (HexDocs)[https://hexdocs.pm/pinxs/]
## Installation
```elixir
def deps do
[
{:pinxs, "~> 1.0.0"}
]
end
```
Configure the endpoint you wish to use
```elixir
config :pinxs,
pin_url: "https://api.pinpayments.com" # or "https://test-api.pin.net.au/1" in dev/test environment
```
You will also need to use your API key for authenticating each type of request.
## Overview
All requests must provide your API key. The helper `PINXS.config("YOUR KEY")`. The reason this is done on a per
request basis, rather than a global configuration is to allow changes at runtime on a per request basis.
All responses are transformed to return `{:ok, item(s)}` or `{:error, PINXS.Error}`
This enables us to leverage pattern matching and the `with` construct very nicely.
### Example charge creation
```elixir
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: "127.0.0.1",
amount: 50000,
card: card
}
with {:ok, created_order} <- Repo.insert(order),
{:ok, created_charge} <- Charge.create(charge, PINXS.config("MY API KEY")),
{: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}
else
{: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)}")
end
```
## 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.
```shell
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
