Worldpay.FX (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay FX API — Multi-Currency Processing.

Supports rate pairings, FX quotes, and forward rate locking.

Summary

Functions

Create an FX quote.

Retrieve a previously created FX quote.

Functions

create_quote(body, config)

@spec create_quote(map(), Worldpay.Config.t()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Create an FX quote.

Set intent: "PAYOUT LIVE RATE" for a real-time rate on live transactions.

get_quote(quote_id, config)

@spec get_quote(String.t(), Worldpay.Config.t()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Retrieve a previously created FX quote.

get_rate(source_currency, target_currency, config)

@spec get_rate(String.t(), String.t(), Worldpay.Config.t()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Get an FX rate pairing.