Worldpay.WPG.Builder (Worldpay v1.0.0)

Builds WPG XML request documents.

All functions return XML strings that can be submitted via Worldpay.WPG.submit/2.

Summary

Functions

cancel(order_code)

Build a cancel modification.

capture(order_code, amount, currency, exponent \\ 2)

Build a capture (settlement) modification.

envelope(inner, opts \\ [])

Wrap inner XML in a WPG paymentService envelope.

hpp_order(opts)

Build a HPP order (hosted payment page redirect).

inquiry(order_code)

Build an inquiry request.

order(opts)

Build a card order submission (Direct integration).

refund(order_code, amount, currency, exponent \\ 2)

Build a refund modification.

split_funding(order_code, splits)

Build a split funding capture modification.

token_order(opts)

Build a token order submission.

Functions

cancel(order_code)

@spec cancel(String.t()) :: String.t()

Build a cancel modification.

capture(order_code, amount, currency, exponent \\ 2)

@spec capture(String.t(), non_neg_integer(), String.t(), non_neg_integer()) ::
  String.t()

Build a capture (settlement) modification.

envelope(inner, opts \\ [])

@spec envelope(
  String.t(),
  keyword()
) :: String.t()

Wrap inner XML in a WPG paymentService envelope.

hpp_order(opts)

@spec hpp_order(keyword()) :: String.t()

Build a HPP order (hosted payment page redirect).

inquiry(order_code)

@spec inquiry(String.t()) :: String.t()

Build an inquiry request.

order(opts)

@spec order(keyword()) :: String.t()

Build a card order submission (Direct integration).

refund(order_code, amount, currency, exponent \\ 2)

@spec refund(String.t(), non_neg_integer(), String.t(), non_neg_integer()) ::
  String.t()

Build a refund modification.

split_funding(order_code, splits)

@spec split_funding(String.t(), [map()]) :: String.t()

Build a split funding capture modification.

token_order(opts)

@spec token_order(keyword()) :: String.t()

Build a token order submission.