omise v0.2.0 Omise.Refunds

Provides Refunds API interfaces.

Summary

Create a refund

List all refunds

Retrieve a refund

create(charge_id, params)

create(String.t, Keyword.t) ::
  {:ok, Map.t} |
  {:error, Map.t}

Create a refund.

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

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.

{:ok, refund} = Omise.Refunds.create("chrg_test_520jim7x8u6t4si58va", amount: 100_00)

list(charge_id, params \\ [])

list(String.t, Keyword.t) ::
  {:ok, Map.t} |
  {:error, Map.t}

List all refunds.

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

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.

{:ok, refunds} = Omise.refunds.list("chrg_test_52oo08bwpgnwb95rye8")
{:ok, refunds} = Omise.refunds.list("chrg_test_52oo08bwpgnwb95rye8", limit: 2)

retrieve(charge_id, id)

retrieve(String.t, String.t) ::
  {:ok, Map.t} |
  {:error, Map.t}

Retrieve a refund.

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

{:ok, refund} = Omise.Refunds.retrieve("chrg_test_520jim7x8u6t4si58va", "dspt_test_51yfnnpsxajeybpytm4")