https://github.com/neysofu/securion
Elixir client library for https://api.securionpay.com.
https://github.com/neysofu/securion
api-wrapper elixir payment-gateway payment-processing securionpay
Last synced: 9 months ago
JSON representation
Elixir client library for https://api.securionpay.com.
- Host: GitHub
- URL: https://github.com/neysofu/securion
- Owner: neysofu
- License: isc
- Created: 2020-01-24T00:24:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-06T16:07:36.000Z (over 5 years ago)
- Last Synced: 2024-10-12T14:06:31.957Z (about 1 year ago)
- Topics: api-wrapper, elixir, payment-gateway, payment-processing, securionpay
- Language: Elixir
- Homepage:
- Size: 21.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Securion
Elixir client library to the [SecurionPay](https://securionpay.com) payment
gateway REST APIs.
> Please refer to the [docs](https://securionpay.com/docs/api) of the original REST
> APIs when in doubt. This client library is a thin wrapper around it and
> most details are left unchanged.
> However, some API shortcuts (e.g. on-the-go card creation for new
> subscriptions, see the
> [https://securionpay.com/docs/api#subscription-create](docs))
> were removed in favor of simpler, composable APIs.
`securion` doesn't fully cover the original APIs yet, possibly ever. Only
core features are available. Most notably, subscriptions, plans, and events
are _not_ supported.
## Installation
Add `securion` as dependency in `mix.exs`:
```elixir
defp deps do
[
{:securion, "~> x.y.z"}
]
end
```
## Configuration
You must provide your SecurionPay API secret key. The public key is **not** required.
```elixir
# config/config.exs
config :securion,
secret_key: "sk_ ..."
```
You should also run your tests with test-only API keys, like so:
```elixir
# config/test.exs
config :securion,
secret_key: "sk_test_ ..."
```
## Overview
- `Securion.Customer` - Customers APIs.
- `Securion.Card` - Payment cards APIs.
- `Securion.Token` - One-time only tokens for safely handling payment
cards.
- `Securion.Charge` - Transactions APIs.