Gocardlex.Behaviour.Payout behaviour (gocardlex v1.1.0)

Defines the behaviour for Payouts, you cannot create or edit Payouts, only view them.

Summary

Callbacks

Gets an individual payout by ID

Lists all payouts

Callbacks

get_payout(t)

@callback get_payout(String.t()) :: tuple()

Gets an individual payout by ID

Examples

iex> Gocardlex.Client.get_payout("PO000099999999")
{:ok,
 %{"payouts" => %{"amount" => 9900, "arrival_date" => "2017-06-27",
     "created_at" => "2017-06-27T09:51:33.167Z", "currency" => "GBP",
     "deducted_fees" => 100, "id" => "PO000099999999",
     "links" => %{"creditor" => "CR000099999999",
       "creditor_bank_account" => "BA000099999999"},
     "payout_type" => "merchant", "reference" => "REF-REF",
     "status" => "paid"}}}

list_payouts(map)

@callback list_payouts(map()) :: tuple()

Lists all payouts

Examples

iex> Gocardlex.Client.list_payouts
{:ok,
 %{"meta" => %{"cursors" => %{"after" => nil, "before" => nil}, "limit" => 50},
   "payouts" => [%{"amount" => 9900, "arrival_date" => "2017-06-27",
      "created_at" => "2017-06-27T09:51:33.167Z", "currency" => "GBP",
      "deducted_fees" => 100, "id" => "PO000999999998",
      "links" => %{"creditor" => "CR000999999998",
        "creditor_bank_account" => "BA000999999998"},
      "payout_type" => "merchant", "reference" => "REF-REF",
      "status" => "paid"}]}}