omise v0.6.0 Omise.Token

Provides Token API interfaces.

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

NOTE: Full Credit Card data should never go through your server. Do not send the credit card data to Omise from your servers directly. You must send the card data from the client browser via Javascript (Omise-JS). The methods described on this page should only be used either with fake data in test mode (e.g.: quickly creating some fake data, testing our API from a terminal, etc.), or if you are PCI-DSS compliant. Sending card data from server requires a valid PCI-DSS certification. You can learn more about this in Security Best Practices

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a token

retrieve(id, opts \\ [])

Retrieve a token

Link to this section Types

t()

t() :: %Omise.Token{card: Omise.Card.t(), created: String.t(), id: String.t(), livemode: boolean(), location: String.t(), object: String.t(), used: boolean()}

Link to this section Functions

create(params, opts \\ [])

create(Keyword.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Create a token.

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

Request Parameters:

name - The cardholder name as printed on the card.
number - The card number. Note that the number you pass can contains spaces and dashes but will be stripped from the response.
expiration_month - The expiration month printed on the card in the format M or MM.
expiration_year - The expiration year printed on the card in the format YYYY.
security_code - The security code (CVV, CVC, etc) printed on the back of the card.
city - The postal code from the city where the card was issued.
postal_code - The city where the card was issued.

Examples

params = [
  card: [
    name: "John Doe",
    city: "Bangkok",
    postal_code: 10320,
    number: 4242424242424242,
    security_code: 123,
    expiration_month: 10,
    expiration_year: 2019
  ]
]

Omise.Token.create(params)

retrieve(id, opts \\ [])

retrieve(String.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Retrieve a token.

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

Examples

Omise.Token.retrieve("tokn_test_4xs9408a642a1htto8z")