Moov.PaymentLinks (Moov v1.0.0)

Copy Markdown View Source

No-code, shareable links (and QR codes) for accepting or sending money via card, bank account, or wallet - shareable over email, SMS, or social.

See https://docs.moov.io/api/money-movement/payment-links/.

Summary

Functions

create(client, account_id, params)

Creates a payment link.

disable(client, account_id, payment_link_code)

Disables a payment link.

get(client, account_id, payment_link_code)

Retrieves a payment link by its code.

get_qr_code(client, account_id, payment_link_code)

Gets a QR code image encoding a payment link's URL.

list(client, account_id, opts \\ [])

Lists payment links for an account.

update(client, account_id, payment_link_code, params)

Updates a payment link.

Functions

create(client, account_id, params)

@spec create(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Creates a payment link.

params: :amount, :description, :payment_methods (which rails to accept), or for payout-style links, :destination details.

disable(client, account_id, payment_link_code)

@spec disable(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, Moov.Error.t()}

Disables a payment link.

get(client, account_id, payment_link_code)

@spec get(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a payment link by its code.

get_qr_code(client, account_id, payment_link_code)

@spec get_qr_code(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, Moov.Error.t()}

Gets a QR code image encoding a payment link's URL.

list(client, account_id, opts \\ [])

@spec list(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists payment links for an account.

update(client, account_id, payment_link_code, params)

@spec update(Moov.Client.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Updates a payment link.