omise

v0.4.2

omise v0.4.2 Omise.Refund

Provides Refunds API interfaces.

https://www.omise.co/refunds-api

Summary

Types

t()

Functions

create(charge_id, params, opts \\ [])

Create a refund

list(refunds_owner, params \\ [], opts \\ [])

List all refunds

retrieve(charge_id, id, opts \\ [])

Retrieve a refund

Types

t() 
t() :: %Omise.Refund{amount: integer, charge: String.t, created: String.t, currency: String.t, id: String.t, location: String.t, object: String.t, transaction: String.t, voided: boolean}

Functions

create(charge_id, params, opts \\ []) 
create(String.t, Keyword.t, Keyword.t) ::
  {:ok, t} |
  {:error, Omise.Error.t}

Create a refund.

Returns {:ok, refund} if the request is successful, {:error, error} otherwise.

Request Parameters:

  • amount - The amount in the smallest subunits of the currency used. So for thb (Thai Baht) you’ll need to pass the amount in satangs.

Examples 

Omise.Refund.create("chrg_test_520jim7x8u6t4si58va", amount: 100_00)
list(refunds_owner, params \\ [], opts \\ []) 
list(String.t, Keyword.t, Keyword.t) ::
  {:ok, Omise.List.t} |
  {:error, Omise.Error.t}

List all refunds.

Returns {:ok, refunds} if the request is successful, {:error, error} otherwise.

Query Parameters:

  • offset - (optional, default: 0) The offset of the first record returned.
  • limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
  • from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
  • to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.

Examples 

# List all refunds that belong to current account.
Omise.Refund.list("account")

# List all refunds that belong to a particular charge.
Omise.Refund.list("chrg_test_52oo08bwpgnwb95rye8")
retrieve(charge_id, id, opts \\ []) 
retrieve(String.t, String.t, Keyword.t) ::
  {:ok, t} |
  {:error, Omise.Error.t}

Retrieve a refund.

Returns {:ok, refund} if the request is successful, {:error, error} otherwise.

Examples 

Omise.Refund.retrieve("chrg_test_520jim7x8u6t4si58va", "rfnd_test_4zgf1d7jcw5kr123puq")