Worldpay Payments API — orchestrated single-call flow.
Combines FraudSight, 3DS authentication, token creation, and card authorization in a single POST. Supports all payment instrument types: plain card, Checkout SDK session, stored token, network token, Apple Pay, Google Pay, and AI agent delegate tokens (ACP).
Example
{:ok, auth} =
Worldpay.Payments.authorize(
%{
"transactionReference" => "order-001",
"merchant" => %{"entity" => "default"},
"instruction" => %{
"narrative" => %{"line1" => "My Store"},
"value" => %{"amount" => 1999, "currency" => "GBP"},
"paymentInstrument" => %{
"type" => "card/plain",
"cardHolderName" => "Jane Doe",
"cardNumber" => "4444333322221111",
"cardExpiryDate" => %{"month" => 5, "year" => 2035},
"cvc" => "123"
}
}
},
config
)Summary
Functions
Authorize a payment.
Cancel / reverse an authorized payment.
Retrieve a payment by ID.
Partial refund.
Partial settlement.
Full refund.
Full settlement of an authorized payment.
Functions
@spec authorize(map(), Worldpay.Config.t(), keyword()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Authorize a payment.
The instruction map is submitted as the request body.
Options
:idempotency_key— string; auto-generated if not supplied
@spec cancel(String.t(), Worldpay.Config.t(), keyword()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Cancel / reverse an authorized payment.
@spec get(String.t(), Worldpay.Config.t()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Retrieve a payment by ID.
@spec partial_refund( String.t(), non_neg_integer(), String.t(), Worldpay.Config.t(), keyword() ) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Partial refund.
@spec partial_settle( String.t(), non_neg_integer(), String.t(), Worldpay.Config.t(), keyword() ) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Partial settlement.
@spec refund(String.t(), Worldpay.Config.t(), keyword()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Full refund.
@spec settle(String.t(), map(), Worldpay.Config.t(), keyword()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Full settlement of an authorized payment.