Cancel a Purchase Intent

Use the information in this section to cancel a purchase intent when a customer does not want to make a purchase.

Endpoints

Send a PUT request to one of these endpoints. The

{instructionID}

is the instruction ID from the create a purchase response.

Production:

PUT https://api.cybersource.com/acp/v1/instructions/{instructionID}
/cancel

Test:

PUT https://apitest.cybersource.com/acp/v1/instructions/{instructionID}
/cancel

Required Fields for Cancelling a Purchase Intent

assuranceData[].authenticatedIdentities.id
assuranceData[].verificationMethod
assuranceData[].verificationResults
assuranceData[].verificationTimestamp
clientCorrelationId
deviceInformation.applicationName
deviceInformation.deviceData.brand
deviceInformation.deviceData.type
deviceInformation.fingerprintSessionId
deviceInformation.ipAddress

Additional Information

For complete descriptions of the request fields, see the Cancel a purchase intent section in the Intelligent Commerce API Hub.

Optional Fields for Cancelling a Purchase Intent

assuranceData[].AuthenticationContext.action
assuranceData[].additionalData
assuranceData[].authenticatedIdentities.data
assuranceData[].authenticatedIdentities.provider
assuranceData[].verificationEntity
assuranceData[].verificationEvents
assuranceData[].verificationType
deviceInformation.clientDeviceId
deviceInformation.country
deviceInformation.deviceData.manufacturer
deviceInformation.deviceData.model
deviceInformation.userAgent

Example: Cancelling a Purchase Intent

Request

{
  "clientCorrelationId": "cancelIntentRequest",
  "deviceInformation": {
    "userAgent": "appInstance.userAgent",
    "applicationName": "appInstance.applicationName",
    "fingerprintSessionId": "assuranceData.methodResults.dfpSessionId",
    "country": "US",
    "deviceData": {
      "type": "appInstance.type",
      "manufacturer": "appInstance.manufacturer",
      "brand": "appInstance.brand",
      "model": "appInstance.model"
    },
    "ipAddress": "192.168.1.1",
    "clientDeviceId": "appInstance.clientDeviceId"
  },
  "assuranceData": [
    {
      "verificationType": "CARDHOLDER",
      "verificationEntity": "10",
      "verificationEvents": [
        "01"
      ],
      "verificationMethod": "02",
      "verificationResults": "02",
      "verificationTimestamp": "1753165632",
      "AuthenticationContext": {
        "action": "AUTHENTICATE, REGISTER"
      },
      "authenticatedIdentities": {
        "data": "fidoResponse.fidoBlob",
        "provider": "VISA_PAYMENT_PASSKEY",
        "id": "fidoResponse.identifier"
      },
      "additionalData": ""
    }
  ]
}

Response to a Successful Request

{
  "clientCorrelationId": "3e1b7943-6567-4965-a32b-5aa93d057d35",
  "instructionId": "1-5C8B7367EC00c229ec8a-c96c-a932-a1f3-1faa8f138b01"
}