omise v0.6.0 Omise.Refund

Provides Refunds API interfaces.

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

Link to this section Summary

Types

t()

Functions

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

List all refunds

Link to this section 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()}

Link to this section Functions

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

list(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

Omise.Refund.list