Worldpay.Verifications (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay Verifications API — card and bank account verification.

Card verification

{:ok, result} = Worldpay.Verifications.verify_card(%{
  "transactionReference" => "verify-001",
  "merchant" => %{"entity" => "default"},
  "instruction" => %{
    "narrative" => %{"line1" => "Active Card Check"},
    "paymentInstrument" => %{"type" => "card/plain", ...}
  }
}, config)

result["outcome"]  # => "verified" | "notVerified" | "verificationFailed"

Beneficiary Account Verification

{:ok, result} = Worldpay.Verifications.verify_account(%{
  "merchant" => %{"entity" => "default"},
  "payoutInstrument" => %{
    "type" => "bankAccount",
    "accountNumber" => "12345678",
    "routingNumber" => "021000021"
  }
}, config)

Summary

Functions

Beneficiary Account Verification — verify bank account before payout.

Intelligent card-on-file verification.

Dynamic card-on-file verification (with storedCredentials.reason).

Functions

verify_account(body, config)

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

Beneficiary Account Verification — verify bank account before payout.

verify_card(body, config)

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

Intelligent card-on-file verification.

verify_card_dynamic(body, config)

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

Dynamic card-on-file verification (with storedCredentials.reason).