https://github.com/omise/omise-elixir

Omise Client Library for Elixir
https://github.com/omise/omise-elixir

Last synced: 3 months ago
JSON representation

Omise Client Library for Elixir

• Host: GitHub
• URL: https://github.com/omise/omise-elixir
• Owner: omise
• License: mit
• Created: 2016-07-05T06:06:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T06:24:51.000Z (10 months ago)
• Last Synced: 2024-07-17T06:45:34.289Z (4 months ago)
• Language: Elixir
• Homepage: https://docs.opn.ooo
• Size: 506 KB
• Stars: 10
• Watchers: 23
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-elixir - omise - Omise client library for Elixir. (Third Party APIs)

README

        
# Omise Elixir Client

[![Build Status](https://github.com/omise/omise-elixir/actions/workflows/pipeline.yml/badge.svg)](https://github.com/omise/omise-elixir/actions/workflows/pipeline.yml)

[![Hex.pm](https://img.shields.io/hexpm/v/omise.svg?style=flat-square)](https://hex.pm/packages/omise)

[![Coverage Status](https://coveralls.io/repos/github/omise/omise-elixir/badge.svg?branch=master)](https://coveralls.io/github/omise/omise-elixir?branch=master)

**Opn Payments for Elixir**

## Installation

  First, add `omise` to your list of dependencies in `mix.exs`:

  ```elixir

  def deps do

    [{:omise, "~> 0.10.0"}]

  end

  ```

  Then update your dependencies with:

  ```shell

  $ mix deps.get

  ```

## Configuration

Set the following configuration variables in `config/config.exs`:

```elixir

config :omise,

  public_key: "pkey_test_xxx",

  secret_key: "skey_test_xxx"

```

Or manually configure at runtime:

```elixir

Omise.configure(public_key: "pkey_test_xxx", secret_key: "skey_test_xxx")

```

To configure the HTTP options, you could optionally add the `:http_options` key to the Opn Payments configuration. For a full list of the available options, please check [HTTPoison documentation](https://github.com/edgurgel/httpoison).

```elixir

config :omise,

  http_options: [timeout: 60_000, recv_timeout: 60_000]

```

## Example

```elixir

charge_params = [amount: 100_00, currency: "thb", card: "tokn_xxx"]

with {:ok, %Omise.Charge{paid: true}} <- Omise.Charge.create(charge_params) do

  # handle success

  IO.puts "Thank you :)"

else

  {:ok, %Omise.Charge{failure_code: failure_code}} ->

    # handle failure

  {:error, %Omise.Error{code: code, message: message}} ->

    # handle error

end

```

You can also set a per-request key and API version when making an API call:

```elixir

Omise.Charge.list([], key: "skey_test_xxx", api_version: "2015-11-17")

Omise.Charge.retrieve("chrg_test_4yq7duw15p9hdrjp8oq", key: "skey_test_xxx")

Omise.Charge.create([

  amount: 1000_00,

  currency: "thb",

  customer: "cust_test_xxx"

], key: "skey_test_xxx")

```

## Development

- Install all dependencies with `mix deps.get`

- Run tests with `mix test`

## Documentation

 * [https://hexdocs.pm/omise/api-reference.html](https://hexdocs.pm/omise/api-reference.html)