PayPing (PayPing v0.1.2)

PayPing API client for the Elixir language

Link to this section Summary

Types

http_error()

pay_params()

verify_ok()

verify_params()

Functions

config()

Get configuration

pay(params)

Create a Payment code

verify(params)

Verify a Payment

Link to this section Types

http_error()

Specs

http_error() :: {:error, integer(), term()}

pay_params()

Specs

pay_params() :: %{
  :amount => integer(),
  optional(:payerIdentity) => String.t(),
  optional(:payerName) => String.t(),
  optional(:description) => String.t(),
  :returnUrl => String.t(),
  optional(:clientRefId) => String.t()
}

verify_ok()

Specs

verify_ok() :: {:ok, integer(), map()}

verify_params()

Specs

verify_params() :: %{refId: String.t(), amount: integer()}

Link to this section Functions

config()

(since 0.1.0)

Specs

config() :: %{base_url: String.t(), token: String.t()}

Get configuration

pay(params)

(since 0.1.0)

Specs

pay(params :: pay_params()) :: {:ok, integer(), map()} | http_error()

Create a Payment code

verify(params)

(since 0.1.0)

Specs

verify(params :: verify_params()) :: verify_ok() | http_error()

Verify a Payment