Worldpay.CNP (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay cnpAPI — US eCommerce XML processing (Vantiv platform).

Submits requests to the cnpAPI online endpoint.

Configuration

config :worldpay,
  cnp_merchant_id: "your-merchant-id",
  cnp_user: "your-user",
  cnp_password: "your-password"

Summary

Functions

Submit an authorization.

Submit a capture.

Submit a credit (refund).

Submit an eCheck credit.

Submit an eCheck sale.

Submit an eCheck void.

Submit a Dynamic Payout funding instruction.

Register a token.

Submit a reversal.

Submit a sale transaction.

Submit a void.

Functions

authorization(opts, config)

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

Submit an authorization.

capture(opts, config)

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

Submit a capture.

credit(opts, config)

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

Submit a credit (refund).

echeck_credit(opts, config)

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

Submit an eCheck credit.

echeck_sale(opts, config)

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

Submit an eCheck sale.

echeck_void(opts, config)

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

Submit an eCheck void.

funding_instruction(opts, config)

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

Submit a Dynamic Payout funding instruction.

register_token(opts, config)

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

Register a token.

reversal(opts, config)

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

Submit a reversal.

sale(opts, config)

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

Submit a sale transaction.

void(opts, config)

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

Submit a void.