Worldpay.CNP.Builder (Worldpay v1.0.0)

Copy Markdown View Source

Builds cnpAPI XML request documents for US eCommerce processing.

Supports: Authorization, Sale, Credit, Void, Capture, Reversal, EcheckSale, EcheckVoid, EcheckCredit, Token registration, Dynamic Payout.

Summary

Functions

Build an authorization transaction.

Build a capture (settlement) transaction.

Build a credit (refund) transaction.

Build an eCheck credit (refund).

Build an eCheck sale.

Build an eCheck void.

Wrap inner XML in a cnpRequest envelope.

Build a Dynamic Payout funding instruction.

Build a token registration request.

Build a reversal transaction.

Build a sale transaction (auth + auto-capture).

Build a void transaction.

Functions

authorization(opts)

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

Build an authorization transaction.

capture(opts)

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

Build a capture (settlement) transaction.

credit(opts)

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

Build a credit (refund) transaction.

echeck_credit(opts)

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

Build an eCheck credit (refund).

echeck_sale(opts)

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

Build an eCheck sale.

echeck_void(opts)

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

Build an eCheck void.

envelope(inner, opts)

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

Wrap inner XML in a cnpRequest envelope.

funding_instruction(opts)

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

Build a Dynamic Payout funding instruction.

register_token(opts)

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

Build a token registration request.

reversal(opts)

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

Build a reversal transaction.

sale(opts)

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

Build a sale transaction (auth + auto-capture).

void(opts)

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

Build a void transaction.