Skip to content
APIs/APMs/
/
Confirm APM payment

Confirm APM payment

Request

Create a confirm payment request for smart button functionality.

Security
BasicAuth
Path
paymentIdstringrequired

The identifier of the payment resource.

Headers
WP-Api-Versionstringrequired

The API version.

Value:"2024-07-01"
curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.com/apmPayments/{paymentId}/confirmations' \
  -H 'WP-Api-Version: 2024-07-01'

Responses

Request successful

Bodyapplication/json
paymentIdstring

The identifier of the payment resource.

commandIdstring

An action ID generated by us, identifying a single merchant interaction.

Example:"cmdYNdIHBPJwbkjLiykzTx0"
outcomestring

The payment outcome.

Enum:"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"
_actionsobject
lastEventstringdeprecated

Deprecated in favor of outcome.

Enum:"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"
Response
{
  "paymentId": "uK9Oh5zz4yKhGuFofhhnC_h2WwCXUTVwK1Lx7OP-WOiwgLd0DJ5uYK8NLsKG-rFtM4xXFxk15W-f-R1c3u_fq6rRIVQO_lZhwklop_5RcXz35RD_4TJfbjKQAyEFQXOTgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxpba-zPVQ7PG1AztEwRCfVJ",
  "lastEvent": "authorized",
  "outcome": "authorized",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/apmPayments/uK9Oh5zz4yKhGuFofhhnC_h2WwCXUTVwK1Lx7OP-WOiwgLd0DJ5uYK8NLsKG-rFtM4xXFxk15W-f-R1c3u_fq6rRIVQO_lZhwklop_5RcXz35RD_4TJfbjKQAyEFQXOTgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxpba-zPVQ7PG1AztEwRCfVJ"
    }
  },
  "_actions": {}
}