The ApmPayments API from Worldpay — 1 operation(s) for apmpayments.
openapi: 3.0.1
info:
title: 3DS 3DS actions ApmPayments API
description: "Protect your business and meet regulatory requirements by verifying your customer's identity.\n\n__Authentication header__\n ```\n Authorization: {your_credentials}\n ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our 3DS API.\n\n__Accept/Content-Type header__\n ```\n Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\n Accept: application/vnd.worldpay.verifications.customers-v3.hal+json\n ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API.\n\nWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.\n<br /><br />\n\n\n__DNS whitelisting__ \nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."
version: '3'
x-metadata:
category:
- 3DS
- SCA Exemptions
business:
- Enterprise
catalog-list: true
generated: false
servers:
- url: https://try.access.worldpay.com
description: Test (Try)
- url: https://access.worldpay.com
description: Live
security:
- BasicAuth: []
tags:
- name: ApmPayments
paths:
/apmPayments:
post:
description: Perform a sale.
operationId: payment
parameters:
- description: The content type of the request body.
in: header
name: Content-Type
required: true
schema:
type: string
enum:
- application/json
- description: The API version.
in: header
name: WP-Api-Version
required: true
schema:
type: string
enum:
- '2024-07-01'
requestBody:
content:
application/json:
examples:
ACH/eCheck:
$ref: '#/components/examples/payment-ach'
Alipay China:
$ref: '#/components/examples/payment-alipaycn'
Alipay Hong Kong:
$ref: '#/components/examples/payment-alipayhk'
Alipay Plus:
$ref: '#/components/examples/payment-alipayplus'
Bancomat Pay:
$ref: '#/components/examples/payment-bancomat'
Bancomat Pay request in TRY:
$ref: '#/components/examples/payment-bancomat-last-name-status'
Bancontact:
$ref: '#/components/examples/payment-bancontact'
Bizum:
$ref: '#/components/examples/payment-bizum'
BLIK:
$ref: '#/components/examples/payment-blik'
EFT:
$ref: '#/components/examples/payment-eft'
Euteller:
$ref: '#/components/examples/payment-euteller'
iDEAL one time:
$ref: '#/components/examples/payment-ideal-onetime'
iDEAL recurring:
$ref: '#/components/examples/payment-ideal-recurring'
Klarna guest:
$ref: '#/components/examples/payment-klarna-guest'
Klarna guest - retail:
$ref: '#/components/examples/payment-klarna-guest-retail'
Klarna guest - airline:
$ref: '#/components/examples/payment-klarna-guest-airline'
Klarna guest - hotel:
$ref: '#/components/examples/payment-klarna-guest-hotel'
Klarna guest - event:
$ref: '#/components/examples/payment-klarna-guest-event'
Klarna guest - train:
$ref: '#/components/examples/payment-klarna-guest-train'
Klarna recurring:
$ref: '#/components/examples/payment-klarna-recurring'
Klarna recurring token:
$ref: '#/components/examples/payment-klarna-recurring-token'
Konbini:
$ref: '#/components/examples/payment-konbini'
Multibanco:
$ref: '#/components/examples/payment-multibanco'
MyBank:
$ref: '#/components/examples/payment-mybank'
Open Banking:
$ref: '#/components/examples/payment-open-banking'
PayPal:
$ref: '#/components/examples/payment-paypal'
PaysafeCard:
$ref: '#/components/examples/payment-paysafecard'
Pix:
$ref: '#/components/examples/payment-pix'
Przelewy24:
$ref: '#/components/examples/payment-przelewy'
SafetyPay:
$ref: '#/components/examples/payment-safetypay'
Swish with phone number:
$ref: '#/components/examples/payment-swish-with-phone'
Swish without phone number:
$ref: '#/components/examples/payment-swish-without-phone'
SEPA DD guest checkout:
$ref: '#/components/examples/payment-sepa-onetime'
SEPA DD guest checkout for SEE countries:
$ref: '#/components/examples/payment-sepa-onetime-bic-field'
SEPA DD recurring:
$ref: '#/components/examples/payment-sepa-recurring'
SEPA DD recurring for SEE countries:
$ref: '#/components/examples/payment-sepa-recurring-bic-field'
SEPA DD token:
$ref: '#/components/examples/payment-sepa-token'
Trustly:
$ref: '#/components/examples/payment-trustly'
WeChat Pay:
$ref: '#/components/examples/payment-wechatpay'
ACH - using a session (Components SDK):
$ref: '#/components/examples/sessions-ach'
Alipay China - using a session (Components SDK):
$ref: '#/components/examples/sessions-alipaycn'
Alipay Hong Kong - using a session (Components SDK):
$ref: '#/components/examples/sessions-alipayhk'
Alipay Plus - using a session (Components SDK):
$ref: '#/components/examples/sessions-alipayplus'
Bancontact - using a session (Components SDK):
$ref: '#/components/examples/sessions-bancontact'
BLIK - using a session (Components SDK):
$ref: '#/components/examples/sessions-blik'
Euteller - using a session (Components SDK):
$ref: '#/components/examples/sessions-euteller'
iDeal - using a session (Components SDK):
$ref: '#/components/examples/sessions-ideal'
Klarna - using a session (Components SDK):
$ref: '#/components/examples/sessions-klarna'
Konbini - using a session (Components SDK):
$ref: '#/components/examples/sessions-konbini'
Multibanco - using a session (Components SDK):
$ref: '#/components/examples/sessions-multibanco'
MyBank - using a session (Components SDK):
$ref: '#/components/examples/sessions-mybank'
Open Banking - using a session (Components SDK):
$ref: '#/components/examples/sessions-open-banking'
PayPal - using a session (Components SDK):
$ref: '#/components/examples/sessions-paypal'
PaysafeCard - using a session (Components SDK):
$ref: '#/components/examples/sessions-paysafecard'
Pix - using a session (Components SDK):
$ref: '#/components/examples/sessions-pix'
Przelewy24 - using a session (Components SDK):
$ref: '#/components/examples/sessions-przelewy'
SafetyPay - using a session (Components SDK):
$ref: '#/components/examples/sessions-safetypay'
SEPA DD - using a session (Components SDK):
$ref: '#/components/examples/sessions-sepa'
Swish - using a session (Components SDK):
$ref: '#/components/examples/sessions-swish'
Trustly - using a session (Components SDK):
$ref: '#/components/examples/sessions-trustly'
WeChat Pay - using a session (Components SDK):
$ref: '#/components/examples/sessions-wechatpay'
schema:
$ref: '#/components/schemas/ApmPaymentRequestV2'
required: true
responses:
'201':
content:
application/json:
examples:
ACH/eCheck:
$ref: '#/components/examples/payment-ach-2'
Alipay China:
$ref: '#/components/examples/payment-alipaycn-2'
Alipay Hong Kong:
$ref: '#/components/examples/payment-alipayhk-2'
AliPay Plus:
$ref: '#/components/examples/payment-alipayplus-2'
Bancomat Pay:
$ref: '#/components/examples/payment-bancomat-2'
Bancomat Pay request in TRY:
$ref: '#/components/examples/payment-bancomat-2'
Bancontact:
$ref: '#/components/examples/payment-bancontact-2'
Bizum:
$ref: '#/components/examples/payment-bizum-2'
BLIK:
$ref: '#/components/examples/payment-blik-2'
EFT:
$ref: '#/components/examples/payment-eft-2'
Euteller:
$ref: '#/components/examples/payment-euteller-2'
iDEAL recurring:
$ref: '#/components/examples/payment-ideal-recurring-2'
iDEAL successful:
$ref: '#/components/examples/payment-ideal'
Klarna guest:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna guest - retail:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna guest - airline:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna guest - hotel:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna guest - event:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna guest - train:
$ref: '#/components/examples/payment-klarna-guest-2'
Klarna recurring:
$ref: '#/components/examples/payment-klarna-recurring-2'
Klarna recurring token:
$ref: '#/components/examples/payment-klarna-recurring-token-2'
Konbini:
$ref: '#/components/examples/payment-konbini-2'
Multibanco:
$ref: '#/components/examples/payment-multibanco-2'
MyBank:
$ref: '#/components/examples/payment-mybank-2'
Open Banking:
$ref: '#/components/examples/payment-open-banking-2'
PayPal Smart Button:
$ref: '#/components/examples/payment-paypal-sdk-201'
PayPal redirect:
$ref: '#/components/examples/payment-201'
PaysafeCard:
$ref: '#/components/examples/payment-paysafecard-2'
Pix:
$ref: '#/components/examples/payment-pix-2'
Przelewy24:
$ref: '#/components/examples/payment-przelewy-2'
Safetypay:
$ref: '#/components/examples/payment-safetypay-2'
Swish with phone number:
$ref: '#/components/examples/payment-swish-with-phone-2'
Swish without phone number:
$ref: '#/components/examples/payment-swish-without-phone-2'
SEPA follow up:
$ref: '#/components/examples/payment-sepa-followup'
SEPA successful:
$ref: '#/components/examples/payment-sepa'
Trustly:
$ref: '#/components/examples/payment-trustly-2'
WeChatPay:
$ref: '#/components/examples/payment-wechatpay-2'
schema:
$ref: '#/components/schemas/ApmPaymentResourceWithRedirectV2'
description: Request successful.
'400':
content:
application/json:
examples:
bodyDoesNotMatchSchema:
$ref: '#/components/examples/response-400'
paymentNotFound:
$ref: '#/components/examples/response-payment-not-found-400'
orderNotReady:
$ref: '#/components/examples/response-order-not-ready-400'
transactionReferenceIsADuplicate:
$ref: '#/components/examples/response-duplicate-order-400'
tokenDoesNotExist:
$ref: '#/components/examples/response-token-not-found-400'
KlarnaBillingAddress-bodyDoesNotMatchSchema:
$ref: '#/components/examples/response-400-Klarna-billing'
Bizum-invalidTransactionReference:
$ref: '#/components/examples/payment-bizum-validation-error'
Swish-transactionReference:
$ref: '#/components/examples/payment-swish-transaction-ref'
Swish-payerNoEnrolled:
$ref: '#/components/examples/payment-swish-payerNotEnrolled'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Bad request.
'401':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-401'
schema:
$ref: '#/components/schemas/AccessApiErrorResponse'
description: Client is not authorized due to missing or invalid Authorization header.
'500':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-500'
schema:
$ref: '#/components/schemas/AccessApiErrorResponse'
description: A problem occurred processing the request on our side.
summary: Create an APM payment
tags:
- ApmPayments
components:
examples:
payment-przelewy:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: przelewy
value:
amount: 2500
currency: PLN
narrative:
line1: Mind Palace
paymentInstrument:
type: direct
country: PL
resultUrls:
success: https://worldpay.com/success
pending: https://worldpay.com/pending
cancel: https://worldpay.com/cancel
customer:
email: moriarty@example.com
payment-konbini:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: MindPalaceLtd
instruction:
method: konbini
value:
amount: 100
currency: JPY
narrative:
line1: MindPalace
paymentInstrument:
type: direct
country: JP
resultUrls:
pending: https://worldpay.com/pending
customer:
lastName: Smith
email: test@email.com
phone: '1234567890'
payment-klarna-guest-event:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: klarna_network
value:
amount: 39800
currency: GBP
narrative:
line1: MindPalace
passthroughData: '{"content_type":"vnd.klarna.interoperability-data.v3+json","content":{"operation":"payment_request","request":{"supplementary_purchase_data":{"event_reservations":[{"event_name":"Coldplay - Music of the Spheres World Tour","event_type":"CONCERT","event_date":"2026-07-18","event_time":"20:00","venue_name":"Olympiastadion Berlin","venue_address":{"street_address":"Olympischer Platz 3","postal_code":"14053","city":"Berlin","country":"DE"},"ticket_category":"Standing - Golden Circle","number_of_tickets":2,"attendees":[{"given_name":"James","family_name":"Moriarty","email":"moriarty@example.de","phone":"+491761234567"},{"given_name":"Joan","family_name":"Moriarty","email":"moriarty2@example.de","phone":"+491761234568"}]}],"line_items":[{"name":"Coldplay Concert - Golden Circle Standing","quantity":2,"total_amount":39800,"unit_price":19900,"total_tax_amount":6352,"reference":"ticket-golden-001"}]}}}}'
paymentInstrument:
type: direct
country: GB
billingAddress:
firstName: James
lastName: Moriarty
phone: '00000000000'
address1: Marylebone
address2: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
settlement:
auto: true
resultUrls:
cancel: https://worldpay.com/cancel
failure: https://worldpay.com/failure
pending: https://worldpay.com/pending
success: https://worldpay.com/success
shipping:
method: physicalToDoor
timeFrame: express
courier:
name: DHL
preference: leaveAtDoor
signature: true
tracked: true
identification: true
firstName: Mike
lastName: Shipping
phone: 0123456789
email: mike.shipping@email.com
address:
address1: Worldpay
address2: 270-289 The Science Park
postalCode: CB4 0WE
city: Cambridgeshire
state: Cambridgeshire
countryCode: GB
payment-alipayhk-2:
value:
paymentId: HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
lastEvent: pending
_links:
self:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
_actions: {}
redirect: https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3413879489&paymentMethod=ALIPAY_HK
paymentInstrument:
method: alipay_hk
type: direct
commandId: cmdEy5vwB0krLe9eMwAcE66c0
sessions-trustly:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: trustly
value:
amount: 2000
currency: EUR
narrative:
line1: Joe Plumbing Ltd
paymentInstrument:
type: checkout
country: IT
sessionHref: https://access.worldpay.com/sessions/eyJrIjoxLCJkIjoiTExFRUZaZWtFZXZkV09VZEcxUFk3Z1hWK3prdmtKRk5MRmlockc1K0MyY3ZvWVpvRldlZ1J0TmRLRVQwaTM3LyJ9
resultUrls:
pending: https://worldpay.com/pending
success: https://worldpay.com/success
cancel: https://worldpay.com/cancel
response-400-Klarna-billing:
value:
errorName: bodyDoesNotMatchSchema
message: The json body provided does not match the expected schema
validationErrors:
- errorName: fieldHasInvalidValue
message: Billing address object, firstName and lastName from customer object are all required if at least one is provided.
jsonPath: $.instruction
payment-klarna-guest-airline:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: klarna_network
value:
amount: 24900
currency: GBP
narrative:
line1: MindPalace
passthroughData: '{"content_type":"vnd.klarna.interoperability-data.v3+json","content":{"operation":"payment_request","request":{"supplementary_purchase_data":{"travel_reservations":[{"travel_type":"AIR","pnr":"ABC123","itinerary_legs":[{"departure_date":"2026-03-15","departure_time":"14:30","arrival_date":"2026-03-15","arrival_time":"17:45","carrier_code":"XX","carrier_name":"ExampleAir","flight_number":"XX1234","departure_city":"AMS","departure_airport":"Schiphol","arrival_city":"FRA","arrival_airport":"Frankfurt Airport","fare_class":"Y","booking_class":"ECONOMY"},{"departure_date":"2026-03-22","departure_time":"09:15","arrival_date":"2026-03-22","arrival_time":"10:30","carrier_code":"XX","carrier_name":"ExampleAir","flight_number":"XX4321","departure_city":"FRA","departure_airport":"Frankfurt Airport","arrival_city":"AMS","arrival_airport":"Schiphol","fare_class":"Y","booking_class":"ECONOMY"}],"passengers":[{"given_name":"James","family_name":"Moriarty","email":"moriarty@example.de","phone":"+491761234567","passenger_type":"ADULT"}]}],"line_items":[{"name":"Round-trip AMS-FRA Economy Class","quantity":1,"total_amount":24900,"unit_price":24900,"total_tax_amount":3975,"reference":"ticket-001"}]}}}}'
paymentInstrument:
type: direct
country: GB
billingAddress:
firstName: James
lastName: Moriarty
phone: '00000000000'
address1: Marylebone
address2: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
settlement:
auto: true
resultUrls:
cancel: https://worldpay.com/cancel
failure: https://worldpay.com/failure
pending: https://worldpay.com/pending
success: https://worldpay.com/success
shipping:
method: physicalToDoor
timeFrame: express
courier:
name: DHL
preference: leaveAtDoor
signature: true
tracked: true
identification: true
firstName: Mike
lastName: Shipping
phone: 0123456789
email: mike.shipping@email.com
address:
address1: Worldpay
address2: 270-289 The Science Park
postalCode: CB4 0WE
city: Cambridgeshire
state: Cambridgeshire
countryCode: GB
sessions-konbini:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: MindPalaceLtd
instruction:
method: konbini
value:
amount: 100
currency: JPY
narrative:
line1: MindPalace
paymentInstrument:
type: checkout
country: JP
sessionHref: https://access.worldpay.com/sessions/eyJrIjoxLCJkIjoiTExFRUZaZWtFZXZkV09VZEcxUFk3Z1hWK3prdmtKRk5MRmlockc1K0MyY3ZvWVpvRldlZ1J0TmRLRVQwaTM3LyJ9
resultUrls:
pending: https://worldpay.com/pending
payment-klarna-recurring-token:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: klarna
value:
amount: 2468
currency: GBP
narrative:
line1: MindPalace
paymentInstrument:
type: token
tokenId: 63b73a05-df8e-44c5-a699-96ccb638bb6a
country: GB
language: en
billingAddress:
address1: 221B Baker Street
address2: Marylebone
address3: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
customerAgreement:
type: recurring
resultUrls:
cancel: https://worldpay.com/cancel
failure: https://worldpay.com/failure
pending: https://worldpay.com/pending
success: https://worldpay.com/success
shipping:
method: registered box
timeFrame: normal
firstName: James
lastName: Moriarty
phone: '00000000000'
email: test@email.com
address:
address1: 221B Baker Street
address2: Marylebone
address3: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
customer:
firstName: James
lastName: Moriarty
email: moriarty@example.com
phone: '00000000000'
dateOfBirth: '1999-01-01'
order:
orderTotalTaxAmount: 0
termsUrl: https://example.com
items:
- type: physical
productCode: fff1223
name: Red Hat
quantity: 1
unitOfMeasure: per unit
unitCost: 1234
taxRate: 1
totalTaxAmount: 0
totalAmount: 1234
totalDiscountAmount: 0
productUrl: https://example.com
imageUrl: https://example.com
- type: physical
productCode: fff1256
name: Blue Hat
quantity: 1
unitOfMeasure: per unit
unitCost: 1234
taxRate: 1
totalTaxAmount: 0
totalAmount: 1234
totalDiscountAmount: 0
productUrl: https://example.com
imageUrl: https://example.com
payment-trustly:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: trustly
value:
amount: 2000
currency: EUR
narrative:
line1: Joe Plumbing Ltd
paymentInstrument:
type: direct
country: IT
resultUrls:
pending: https://worldpay.com/pending
success: https://worldpay.com/success
cancel: https://worldpay.com/cancel
customer:
email: shopper@worldpay.com
payment-eft:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: eft
narrative:
line1: MindPalace
value:
amount: 750
currency: USD
paymentInstrument:
type: direct
accountType: checking
accountNumber: 01234567890123456
routingNumber: 012345678
checkNumber: 012345678901234
companyName: Worldpay
billingAddress:
address1: 8500 Govenors Hill Drive
address2: Symmes Township
postalCode: '45249'
city: Ohio
state: US-OH
countryCode: US
customer:
firstName: John
lastName: Johnson
customerId: '43424'
email: john@example.com
payment-swish-with-phone:
value:
transactionReference: apm-order-12345686564
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: swish
value:
amount: 250
currency: SEK
narrative:
line1: Mind Palace
paymentInstrument:
type: direct
country: SE
customer:
phone: '46761985401'
payment-wechatpay:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: wechatpay
expiryIn: 10
value:
amount: 250
currency: CNY
narrative:
line1: MindPalace
paymentInstrument:
type: direct
payment-alipayplus-2:
value:
paymentId: HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
lastEvent: pending
_links:
self:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
_actions: {}
redirect: https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3413879489&paymentMethod=ALIPAY_UNI
paymentInstrument:
method: alipay_uni
type: direct
commandId: cmdEy5vwB0krLe9eMwAcE66c0
sessions-alipaycn:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: alipay_cn
value:
amount: 1000
currency: CNY
narrative:
line1: MindPalace
paymentInstrument:
type: checkout
language: zh
sessionHref: https://access.worldpay.com/sessions/eyJrIjoxLCJkIjoiTExFRUZaZWtFZXZkV09VZEcxUFk3Z1hWK3prdmtKRk5MRmlockc1K0MyY3ZvWVpvRldlZ1J0TmRLRVQwaTM3LyJ9
resultUrls:
pending: https://worldpay.com/pending
failure: https://worldpay.com/failure
success: https://worldpay.com/success
cancel: https://worldpay.com/cancel
deviceData:
device: desktop
operatingSystem: windows
payment-bizum-2:
value:
redirect: ''
_actions: {}
_links:
self:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
paymentId: HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c
lastEvent: pending
paymentInstrument:
method: bizum
type: direct
commandId: cmdjW0w-zEw4uQUp57KArz4t0
payment-multibanco:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: multibanco
value:
amount: 1600
currency: EUR
narrative:
line1: Joe Plumbing Ltd
paymentInstrument:
type: direct
country: PT
resultUrls:
pending: https://worldpay.com/pending
success: https://worldpay.com/success
cancel: https://worldpay.com/cancel
customer:
email: shopper@worldpay.com
payment-klarna-guest-train:
value:
transactionReference: Memory265-13/08/1876
orderReference: apm-order-12345
merchant:
entity: default
instruction:
method: klarna_network
value:
amount: 12900
currency: GBP
narrative:
line1: MindPalace
passthroughData: '{"content_type":"vnd.klarna.interoperability-data.v3+json","content":{"operation":"paym
# --- truncated at 32 KB (365 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldpay/refs/heads/main/openapi/worldpay-apmpayments-api-openapi.yml