payjp v0.1.1 Payjp.Events

Main API for working with Events at Payjp. Through this API you can: -list events -retrieve event from id

https://pay.jp/docs/api/#event-イベント

Summary

Functions

Retrieves a given Event with the specified ID. Returns 404 if not found.

Example

Retrieves a given Event with the specified ID using that key(account). Returns 404 if not found.

Example

Returns a list of events

Returns a list of events using given payjp key

Functions

get(id)

Retrieves a given Event with the specified ID. Returns 404 if not found.

Example

Payjp.Events.get "event_id"
get(key, id)

Retrieves a given Event with the specified ID using that key(account). Returns 404 if not found.

Example

{:ok, event} = Payjp.Events.get  key, "event_id"
list(opts \\ [])

Returns a list of events

Example

{:ok, events} = Payjp.Events.list limit: 20
{:ok, events} = Payjp.Events.list type: "charge.updated"
{:ok, events} = Payjp.Events.list type: "charge.updated", limit: 20
{:ok, events} = Payjp.Events.list since: 1487473464
{:ok, events} = Payjp.Events.list until: 1487473464
{:ok, events} = Payjp.Events.list object: "customer"
list(key, opts)

Returns a list of events using given payjp key

Example

Example

{:ok, events} = Payjp.Events.list key, limit: 20
{:ok, events} = Payjp.Events.list key, type: "charge.updated"
{:ok, events} = Payjp.Events.list key, type: "charge.updated", limit: 20
{:ok, events} = Payjp.Events.list key, since: 1487473464
{:ok, events} = Payjp.Events.list key, until: 1487473464
{:ok, events} = Payjp.Events.list key, object: "customer"