Increase.CardPushTransfers (Increase v1.0.0)

Copy Markdown View Source

Card Push Transfers send funds to a recipient's payment card in real-time.

See https://increase.com/documentation/api/card-push-transfers for the full API reference for this resource.

Summary

Functions

Approves a Card Push Transfer in a pending_approval state.

Cancels a Card Push Transfer in a pending_approval state.

Create a Card Push Transfer

List Card Push Transfers

Functions

approve(client, card_push_transfer_id, opts \\ [])

Approves a Card Push Transfer in a pending_approval state.

POST /card_push_transfers/{card_push_transfer_id}/approve

cancel(client, card_push_transfer_id, opts \\ [])

Cancels a Card Push Transfer in a pending_approval state.

POST /card_push_transfers/{card_push_transfer_id}/cancel

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.CardPushTransfers.CardPushTransfer.t()}
  | {:error, Increase.Error.t()}

Create a Card Push Transfer

POST /card_push_transfers

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Card Push Transfers

Returns a %Increase.Page{} whose data is a list of %__MODULE__. CardPushTransfer{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /card_push_transfers

retrieve(client, card_push_transfer_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardPushTransfers.CardPushTransfer.t()}
  | {:error, Increase.Error.t()}

Retrieve a Card Push Transfer

GET /card_push_transfers/{card_push_transfer_id}