omise

v0.6.0

omise v0.6.0 Omise.Charge

Provides Charge API interfaces.

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

Link to this section Summary

Types

t()

Functions

capture(id, opts \\ [])

Capture a charge

create(params, opts \\ [])

Create a charge

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

List all charges

list_refunds(id, params \\ [], opts \\ [])

List all refunds

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

List all charge schedules

refund(id, params, opts \\ [])

Create a refund

retrieve(id, opts \\ [])

Retrieve a charge

retrieve_refund(id, refund_id, opts \\ [])

Retrieve a refund

reverse(id, opts \\ [])

Reverse an uncaptured charge

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

Search all the charges

update(id, params, opts \\ [])

Update a charge

Link to this section Types

Link to this type t() 
t() :: %Omise.Charge{amount: String.t(), authorize_uri: String.t(), authorized: boolean(), capture: boolean(), captured: boolean(), card: Omise.Card.t(), created: Stringt.t(), currency: String.t(), customer: Stringt.t(), description: String.t(), dispute: Omise.Dispute.t(), failure_code: String.t(), failure_message: String.t(), id: String.t(), installment_terms: integer(), ip: Stringt.t(), livemode: boolean(), location: String.t(), metadata: map(), object: String.t(), offline: map(), offsite: String.t(), paid: boolean(), reference: String.t(), refunded: String.t(), refunds: Omise.List.t(), return_uri: String.t(), reversed: boolean(), source_of_fund: String.t(), status: String.t(), transaction: String.t()}

Link to this section Functions

Link to this function capture(id, opts \\ []) 
capture(String.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Capture a charge.

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

NOTE: If you have created a charge and passed capture=false you’ll have an authorized only charge that you can capture at a later time. You can hold it for as long as permitted by the issuing bank. This delay may vary between cards from 1 to 30 days.

Examples 

Omise.Charge.capture("chrg_test_4xso2s8ivdej29pqnhz")
Link to this function create(params, opts \\ []) 
create(Keyword.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Create a charge.

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

Request Parameters:

  • customer - (required or optional) A valid CUSTOMER_ID that has at least one card already associated. By default the default card of the customer will be used. This parameter is required unless passing a TOKEN_ID in the card parameter.
  • card - (required or optional) A valid unused TOKEN_ID or CARD_ID. In the case of the CARD_ID the customer parameter must be present and be the owner of the card. For the TOKEN_ID, the customer must not be passed.
  • amount - (required, minimum: 2000, maximum: 100000000) The amount in the smallest subunits of the currency used. For thb (Thai Baht) you’ll need to pass the amount in satangs.
  • currency - (required) The currency in which you want the charge to be done. The default and only valid value is thb.
  • description - (optional) A custom description for the charge. This value can be searched for in your dashboard.
  • capture - (optional) Whether or not you want the charge to be captured right away, when not specified it is set to true.
  • return_uri - (optional) The url where we will return the customer after the charge has been authorized with 3-D Secure.

Examples 

# Charge a card using a token.
Omise.Charge.create(
  amount: 1000_00,
  currency: "thb",
  card: "tokn_test_51w6fvilnsxalda4cih"
)

# Charge a card using a customer.
Omise.Charge.create(
  amount: 1000_00,
  currency: "thb",
  customer: "cust_test_51vtchzn51al0jaa92q"
)

# Charge a card using a customer and a card.
Omise.Charge.create(
  amount: 1000_00,
  currency: "thb",
  customer: "cust_test_51vtchzn51al0jaa92q",
  card: "card_test_51w6jblhhpzmc2g8bcm"
)
Link to this function list(params \\ [], opts \\ []) 
list(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} |
  {:error, Omise.Error.t()}

List all charges.

Returns {:ok, charges} 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.Charge.list

Omise.Charge.list(limit: 10)
Link to this function list_refunds(id, params \\ [], opts \\ []) 
list_refunds(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 

Omise.Charge.list_refunds("chrg_test_52oo08bwpgnwb95rye8")
Link to this function list_schedules(params \\ [], opts \\ []) 
list_schedules(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} |
  {:error, Omise.Error.t()}

List all charge schedules.

Returns {:ok, schedules} 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.Charge.list_schedules
Link to this function refund(id, params, opts \\ []) 
refund(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.Charge.refund("chrg_test_520jim7x8u6t4si58va", amount: 100_00)
Link to this function retrieve(id, opts \\ []) 
retrieve(String.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Retrieve a charge.

Examples 

Omise.Charge.retrieve("chrg_test_4xso2s8ivdej29pqnhz")
Link to this function retrieve_refund(id, refund_id, opts \\ []) 
retrieve_refund(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.Charge.retrieve_refund("chrg_test_520jim7x8u6t4si58va", "rfnd_test_4zgf1d7jcw5kr123puq")
Link to this function reverse(id, opts \\ []) 
reverse(String.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Reverse an uncaptured charge.

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

NOTE: If you have created a charge and passed capture=false, you’ll have an authorized only charge that can be reversed, release hold money, at a later time.

Examples 

Omise.Charge.reverse("chrg_test_4xso2s8ivdej29pqnhz")
Link to this function search(params \\ [], opts \\ []) 
search(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.Search.t()} |
  {:error, Omise.Error.t()}

Search all the charges.

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

Query Parameters: 

<https://www.omise.co/search-query-and-filters>

Examples 

Omise.Charge.search(filters: [paid: true])

Omise.Charge.search(query: "omise")
Link to this function update(id, params, opts \\ []) 
update(String.t(), Keyword.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Update a charge.

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

Request Parameters:

  • description - (optional) A custom description for the charge. This value can be searched for in your dashboard.

Examples 

Omise.Charge.update("chrg_test_4xso2s8ivdej29pqnhz",
  description: "The funny thing is that when I am okay, oh it makes me wish for rain")