The Payment lifecycle API from Worldpay — 6 operation(s) for payment lifecycle.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/worldpay-payment-lifecycle-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: 3DS 3DS actions Payment lifecycle 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: Payment lifecycle
paths:
/apmPayments/{paymentId}:
get:
description: Lookup the state of a payment, including the available action that can be performed.
operationId: query
parameters:
- description: The identifier of the payment resource.
in: path
name: paymentId
required: true
schema:
type: string
- description: The API version.
in: header
name: WP-Api-Version
required: true
schema:
type: string
enum:
- '2024-07-01'
responses:
'200':
content:
application/json:
examples:
authorized:
$ref: '#/components/examples/query-202-authorized'
pending:
$ref: '#/components/examples/query-202-pending'
sentForRefund:
$ref: '#/components/examples/query-202-sentForRefund'
sentForSettlement:
$ref: '#/components/examples/query-202-sentForSettlement'
schema:
$ref: '#/components/schemas/ApmPaymentResourceQuery'
description: Request successful.
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Get the last event for an APM payment
tags:
- Payment lifecycle
/apmPayments/{paymentId}/confirmations:
post:
description: Create a confirm payment request for smart button functionality.
operationId: confirmPaymentV2
parameters:
- description: The identifier of the payment resource.
in: path
name: paymentId
required: true
schema:
type: string
- description: The API version.
in: header
name: WP-Api-Version
required: true
schema:
type: string
enum:
- '2024-07-01'
responses:
'201':
content:
application/json:
examples:
Full example:
$ref: '#/components/examples/confirm-payment-201'
schema:
$ref: '#/components/schemas/ApmPaymentResourceNoActions'
description: Request successful.
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Confirm payment
tags:
- Payment lifecycle
/apmPayments/{paymentId}/reversals:
post:
description: Perform a reversal on the funds taken from a sale.
operationId: reverse
parameters:
- description: The identifier of the payment resource.
in: path
name: paymentId
required: true
schema:
type: string
- 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: false
schema:
type: string
enum:
- '2024-07-01'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Reversal'
examples:
Reversal:
$ref: '#/components/examples/payment-reversal'
Pix reversal:
$ref: '#/components/examples/payment-reversal-pix'
Klarna reversal:
$ref: '#/components/examples/payment-reversal-klarna'
required: false
responses:
'202':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/reverse-202'
schema:
$ref: '#/components/schemas/ApmPaymentResourceNoActions'
description: OK
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Reverse an APM payment
tags:
- Payment lifecycle
/apmPayments/{paymentId}/partialReversals:
post:
description: Perform a partial reversal on the funds taken from a sale.
operationId: partialReverseV2
parameters:
- description: The identifier of the payment resource.
in: path
name: paymentId
required: true
schema:
type: string
- 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:
schema:
$ref: '#/components/schemas/PartialReversal'
examples:
Reversal:
$ref: '#/components/examples/payment-reversal'
Pix reversal:
$ref: '#/components/examples/payment-reversal-pix'
Klarna reversal:
$ref: '#/components/examples/payment-reversal-klarna'
required: true
responses:
'202':
content:
application/json:
examples:
Full example:
$ref: '#/components/examples/reverse-202'
schema:
$ref: '#/components/schemas/ApmPaymentResourceNoActions'
description: Request successful.
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Partial reverse an APM payment
tags:
- Payment lifecycle
/apmPayments/{paymentId}/settlements:
post:
operationId: settle
parameters:
- in: path
name: paymentId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SettlementPayload'
examples:
Settlement:
$ref: '#/components/examples/payment-settlement'
Klarna settlement:
$ref: '#/components/examples/payment-settlement-klarna'
required: false
responses:
'202':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/settlement-202'
schema:
$ref: '#/components/schemas/ApmPaymentResourceNoActionsSettlement'
description: OK
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Settle an APM payment
tags:
- Payment lifecycle
/apmPayments/{paymentId}/partialSettlements:
post:
description: Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment.
operationId: settleV2
parameters:
- description: The identifier of the payment resource.
in: path
name: paymentId
required: true
schema:
type: string
- 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:
schema:
$ref: '#/components/schemas/PartialSettlement'
examples:
Settlement:
$ref: '#/components/examples/payment-settlement'
Klarna settlement:
$ref: '#/components/examples/payment-settlement-klarna'
required: true
responses:
'202':
content:
application/json:
examples:
Full example:
$ref: '#/components/examples/settlement-202'
schema:
$ref: '#/components/schemas/ApmPaymentResourceNoActionsSettlement'
description: Request successful.
'400':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-400'
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.
'404':
content:
application/json:
examples:
Example:
$ref: '#/components/examples/response-404'
schema:
$ref: '#/components/schemas/AccessApiValidationErrorResponse'
description: Payment resource not found.
'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: Partial settle an APM payment
tags:
- Payment lifecycle
components:
examples:
payment-settlement-klarna:
value:
reference: string
value:
amount: 12
currency: AED
shipping:
courier:
- trackingId: BBB0000000
order:
items:
- name: Panaphonics DH12-HK & Accessories
quantity: 1
unitCost: 12000
totalTaxAmount: 12000
totalAmount: 2000
productUrl: http://www.merchanturl.com/products/f2ytrdmn
imageUrl: http://www.merchanturl.com/products/f2ytrdmn_small.jpg
query-202-sentForSettlement:
value:
paymentId: HZ75WBkfRwmD9YzLSZFnQ3ARjxkddPEGy1lc7iYKKMalDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C3hdIC81cD2YK2o8Arh-whkOhzH5eLvBJHPh6ir8ugqJiAywCh6RPZhv8QHDyzDZDE
lastEvent: sentForSettlement
_links:
self:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ3ARjxkddPEGy1lc7iYKKMalDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C3hdIC81cD2YK2o8Arh-whkOhzH5eLvBJHPh6ir8ugqJiAywCh6RPZhv8QHDyzDZDE
_actions:
reverse:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ3ARjxkddPEGy1lc7iYKKMalDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C3hdIC81cD2YK2o8Arh-whkOhzH5eLvBJHPh6ir8ugqJiAywCh6RPZhv8QHDyzDZDE/reversals
method: POST
partialReverse:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ3ARjxkddPEGy1lc7iYKKMalDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C3hdIC81cD2YK2o8Arh-whkOhzH5eLvBJHPh6ir8ugqJiAywCh6RPZhv8QHDyzDZDE/reversals
method: POST
query-202-authorized:
value:
paymentId: HZ75WBkfRwmD9YzLSZFnQ0aww_aMF9fAHidQrEC483OlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2pzlfJNMqKvq0mYDWxvR0iOhzH5eLvBJHPh6ir8ugqJmt5VJZ_vcfGLqPgLOBUAk4
lastEvent: authorized
_links:
self:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ0aww_aMF9fAHidQrEC483OlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2pzlfJNMqKvq0mYDWxvR0iOhzH5eLvBJHPh6ir8ugqJmt5VJZ_vcfGLqPgLOBUAk4
_actions:
reverse:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ0aww_aMF9fAHidQrEC483OlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2pzlfJNMqKvq0mYDWxvR0iOhzH5eLvBJHPh6ir8ugqJmt5VJZ_vcfGLqPgLOBUAk4/reversals
method: POST
partialReverse:
href: https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ0aww_aMF9fAHidQrEC483OlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2pzlfJNMqKvq0mYDWxvR0iOhzH5eLvBJHPh6ir8ugqJmt5VJZ_vcfGLqPgLOBUAk4/reversals
method: POST
settlement-202:
value:
paymentId: 3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
lastEvent: sentForSettlement
_links:
self:
href: https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
_actions: {}
commandId: cmdEy5vwB0krLe9eMwAcE66c0
reverse-202:
value:
paymentId: 3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
lastEvent: sentForRefund
_links:
self:
href: https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
_actions: {}
commandId: cmdfD7kJPxS4EiQhq3zCFcny0
payment-reversal-pix:
value:
reference: string
value:
amount: 12
currency: BRL
reasonCode: BE08
payment-reversal:
value:
reference: string
value:
amount: 12
currency: AED
response-401:
value:
errorName: unauthorized
message: Invalid authentication
response-500:
value:
errorName: internalErrorOccurred
message: An internal problem occurred with your request, please try again.
query-202-pending:
value:
paymentId: 3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
lastEvent: pending
_links:
self:
href: https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
_actions: {}
confirm-payment-201:
value:
paymentId: uK9Oh5zz4yKhGuFofhhnC_h2WwCXUTVwK1Lx7OP-WOiwgLd0DJ5uYK8NLsKG-rFtM4xXFxk15W-f-R1c3u_fq6rRIVQO_lZhwklop_5RcXz35RD_4TJfbjKQAyEFQXOTgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxpba-zPVQ7PG1AztEwRCfVJ
lastEvent: authorized
_links:
self:
href: https://try.access.worldpay.com/apmPayments/uK9Oh5zz4yKhGuFofhhnC_h2WwCXUTVwK1Lx7OP-WOiwgLd0DJ5uYK8NLsKG-rFtM4xXFxk15W-f-R1c3u_fq6rRIVQO_lZhwklop_5RcXz35RD_4TJfbjKQAyEFQXOTgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxpba-zPVQ7PG1AztEwRCfVJ
_actions: {}
query-202-sentForRefund:
value:
paymentId: 3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
lastEvent: sentForRefund
_links:
self:
href: https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f
_actions: {}
payment-reversal-klarna:
value:
reference: string
value:
amount: 12
currency: EUR
order:
items:
- productCode: fff1223
name: Red Hat
quantity: 1
unitCost: 1234
totalTaxAmount: 0
totalAmount: 1234
productUrl: https://example.com
imageUrl: https://example.com
- productCode: fff1226
name: Red Hat
quantity: 1
unitCost: 1234
totalTaxAmount: 0
totalAmount: 1234
productUrl: https://example.com
imageUrl: https://example.com
payment-settlement:
value:
reference: string
value:
amount: 12
currency: AED
response-404:
value:
errorName: paymentNotFound
message: Payment resource not found.
response-400:
value:
errorName: bodyDoesNotMatchSchema
message: The json body provided does not match the expected schema
validationErrors:
- errorName: fieldHasInvalidValue
message: Field is mandatory
jsonPath: $.instruction.value.amount
schemas:
PartialSettlement:
type: object
description: Partial settlement request
properties:
reference:
type: string
maxLength: 128
minLength: 1
pattern: ^[a-zA-Z0-9\\-]*$
value:
$ref: '#/components/schemas/Value'
shipping:
$ref: '#/components/schemas/ShippingSettlement'
order:
$ref: '#/components/schemas/KlarnaNetworkOrderSettlement'
required:
- value
ShippingSettlement:
type: object
properties:
courier:
type: array
items:
$ref: '#/components/schemas/CourierSettlement'
Value:
type: object
description: The value of the payment.
properties:
amount:
type: integer
format: int64
description: The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.
example: 12
minimum: 1
maximum: 2147483647
currency:
type: string
description: The supported [ISO 4217 currency codes](/products/reference/supported-countries-currencies#iso-currency-codes).
enum:
- AED
- AFN
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNH
- CNY
- COP
- CRC
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RWF
- SAR
- SBD
- SCR
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VES
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMW
required:
- amount
- currency
ApmPaymentResourceNoActionsSettlement:
type: object
description: A payment resource.
properties:
paymentId:
type: string
description: The identifier of the payment resource.
lastEvent:
type: string
enum:
- authorized
- cancelFailed
- cancelled
- cancelRequested
- sentForSettlement
- sentForAuthorization
- settlementFailed
- chargebackReversed
- chargedBack
- disputeExpired
- disputeFundsHeld
- disputeFundsReleased
- disputeReserveReleased
- error
- expired
- disputeInformationRequested
- disputInformationSupplied
- miscellaneous
- pending
- refunded
- refundExpired
- refundFailed
- refundReversed
- refused
- refusedByIssuer
- requestExpired
- sentForRefund
- settled
- settlementReversed
- cancelledByCustomer
- signedFormReceived
- unknown
- manuallyAmended
_links:
$ref: '#/components/schemas/Links'
_actions:
type: object
commandId:
type: string
AccessApiValidationError:
description: Validation error object.
AccessApiErrorResponse:
type: object
properties:
errorName:
type: string
message:
type: string
SelfLink:
type: object
description: The URL you can invoke to fetch the last event for the payment.
properties:
href:
type: string
AccessApiValidationErrorResponse:
type: object
properties:
errorName:
type: string
message:
type: string
validationErrors:
type: array
items:
$ref: '#/components/schemas/AccessApiValidationError'
SettlementPayload:
type: object
description: Settlement request
properties:
reference:
type: string
maxLength: 128
minLength: 1
pattern: ^[a-zA-Z0-9\\-]*$
value:
$ref: '#/components/schemas/Value'
shipping:
$ref: '#/components/schemas/ShippingSettlement'
order:
$ref: '#/components/schemas/KlarnaNetworkOrderSettlement'
required:
- value
ActionsQuery:
type: object
properties:
reverse:
$ref: '#/components/schemas/ActionLinkV2'
partialReverse:
$ref: '#/components/schemas/ActionLinkV2'
settle:
$ref: '#/components/schemas/ActionLinkV2'
partialSettle:
$ref: '#/components/schemas/ActionLinkV2'
KlarnaNetworkOrderSettlement:
type: object
description: Object that contains the complete list of lines relating to the transaction.
properties:
items:
type: array
items:
$ref: '#/components/schemas/KlarnaNetworkOrderItemSettlement'
PartialReversal:
type: object
description: Partial reversal request
properties:
reference:
type: string
maxLength: 128
minLength: 1
pattern: ^[a-zA-Z0-9\\-]*$
value:
$ref: '#/components/schemas/Value'
reasonCode:
type: string
description: Mandatory for Pix payment method, not relevant for other payment methods.
enum:
- BE08
- FR01
- MD06
- SL02
order:
$ref: '#/components/schemas/KlarnaNetworkOrderSettlement'
required:
- value
ActionLinkV2:
type: object
description: Link to resources to reverse operation.
properties:
href:
type: string
method:
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldpay/refs/heads/main/openapi/worldpay-payment-lifecycle-api-openapi.yml