POST /payments/{paymentPspReference}/cancels

The pspReference of the payment that you want to cancel.

Default value: "application/json"

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Information about your application. For more details, see Building Adyen solutions.

Merchant developed software, such as cashier application, used to interact with the Adyen API.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.

External platform integrator.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Merchant device information.

Version of the operating system on the merchant device.

Operating system running on the merchant device.

Merchant device reference.

Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.

Version of the operating system on the shopper interaction device.

Locale on the shopper interaction device.

Operating system running on the shopper interaction device.

Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Enhanced scheme data that may be required for processing the payment. For example, airline information.

Airline enhanced scheme data that may be required for processing the transaction and/or for interchange savings.

The name of the travel agency.

• Encoding: ASCII
• minLength: 1 character
• maxLength: 25 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.travel_agency_name

The unique identifier from IATA or ARC for the travel agency that issues the ticket.

• Encoding: ASCII
• minLength: 1 character
• maxLength: 8 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.travel_agency_code

Date and time of travel in format yyyy-MM-ddTHH:mm.

• Use local time of departure airport.
• minLength: 16 characters
• maxLength: 16 characters
• additionalData key: airline.leg[N].date_of_travel

The IATA three-letter airport code of the departure airport. This field is required if the airline data includes leg details.

• Encoding: ASCII
• Example: Amsterdam = AMS
• minLength: 3 characters
• maxLength: 3 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.leg[N].depart_airport

The IATA 3-letter airport code of the destination airport. This field is required if the airline data includes leg details.

• Example: Amsterdam = AMS
• Encoding: ASCII
• minLength: 3 characters
• maxLength: 3 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.leg[N].destination_code

The IATA 2-letter accounting code (PAX) that identifies the carrier. This field is required if the airline data includes leg details.

• Example: KLM = KL
• minLength: 2 characters
• maxLength: 2 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.leg[N].carrier_code

The amount of departure tax charged, in minor units.

• Encoding: Numeric
• minLength: 1
• maxLength: 11
• Must not be all zeros.
• additionalData key: airline.leg[N].depart_tax

The fare basis code, alphanumeric.

• minLength: 1 character
• maxLength: 15 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.leg[N].fare_base_code

The flight identifier.

• minLength: 1 character
• maxLength: 5 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.leg[N].flight_number

A one-letter travel class identifier. The following are common:

• F: first class

• J: business class

• Y: economy class

• W: premium economy

• Encoding: ASCII

• minLength: 1 character

• maxLength: 1 character

• Must not start with a space or be all spaces.

• Must not be all zeros.

• additionalData key: airline.leg[N].class_of_travel

A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.

• Encoding: ASCII
• minLength: 1 character
• maxLength: 1 character
• additionalData key: airline.leg[N].stop_over_code

The CRS used to make the reservation and purchase the ticket.

• Encoding: ASCII
• minLength: 4 characters
• maxLength: 4 characters
• additionalData key: airline.computerized_reservation_system

The alphanumeric customer reference number.

• Encoding: ASCII
• maxLength: 20 characters
• If you send more than 20 characters, the customer reference number is truncated
• Must not start with a space or be all spaces.
• additionalData key: airline.customer_reference_number

The flight departure date. Time is optional.

• Format for date only: yyyy-MM-dd
• Format for date and time: yyyy-MM-ddTHH:mm
• Use local time of departure airport.
• minLength: 10 characters
• maxLength: 16 characters
• additionalData key: airline.flight_date

The address of the organization that issued the ticket.

• minLength: 0 characters
• maxLength: 16 characters
• additionalData key: airline.ticket_issue_address

The ticket's unique identifier.

• minLength: 1 character
• maxLength: 15 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.ticket_number

The date that the ticket was issued to the passenger.

• minLength: 10 characters
• maxLength: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: airline.issue_date

The IATA 3-digit accounting code (PAX) that identifies the carrier.

• Format: IATA 3-digit accounting code (PAX)
• Example: KLM = 074
• minLength: 3 characters
• maxLength: 3 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.airline_code

The amount charged for boarding the plane, in minor units.

• Encoding: Numeric
• minLength: 1 character
• maxLength: 11 characters
• additionalData key: airline.boarding_fee

The IATA 2-letter accounting code (PAX) that identifies the carrier.

• Encoding: ASCII
• Example: KLM = KL
• minLength: 2 characters
• maxLength: 2 characters
• Must not start with a space or be all spaces.
• additionalData key: airline.airline_designator_code

The passenger's last name.

This field is required if the airline data includes passenger details or leg details.

• Encoding: ASCII
• additionalData key: airline.passenger[N].last_name

The passenger's phone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs.

• Encoding: ASCII
• minLength: 3 characters
• maxLength: 30 characters
• additionalData key: airline.passenger[N].phone_number

The passenger's first name.

This field is required if the airline data includes passenger details or leg details.

• Encoding: ASCII
• additionalData key: airline.passenger[N].first_name

The IATA passenger type code (PTC).

• Encoding: ASCII
• minLength: 3 characters
• maxLength: 6 characters
• additionalData key: airline.passenger[N].traveller_type

The passenger's date of birth.

• Format yyyy-MM-dd
• minLength: 10
• maxLength: 10
• additionalData key: airline.passenger[N].date_of_birth

A code that identifies the type of item bought. The description of the code can appear on credit card statements.

• Encoding: ASCII
• Example: Passenger ticket = 01
• minLength: 2 characters
• maxLength: 2 characters
• additionalData key: airline.document_type

The two-letter agency plan identifier.

• Encoding: ASCII
• minLength: 2 characters
• maxLength: 2 characters
• additionalData key: airline.agency_plan_name

The reference number for the invoice, issued by the agency.

• Encoding: ASCII
• minLength: 1 character
• maxLength: 6 characters
• additionalData key: airline.agency_invoice_number

The passenger's name, initials, and title.

• Format: last name + first name or initials + title
• Example: FLYER / MARY MS
• minLength: 1 character
• maxLength: 20 characters
• If you send more than 20 characters, the name is truncated
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: airline.passenger_name

Car rental enhanced scheme data that may be required for processing the transaction and/or for interchange savings.

The number of days the car is rented for.

• Format: Numeric
• Max value: 9999
• additionalData key: carRental.daysRented

The customer service phone number of the car rental company.

• Format: Alphanumeric
• maxLength: 17
• For US and CA numbers must be 10 characters in length
• Must not contain any special characters such as + or -
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.customerServiceTollFreeNumber

Indicates whether the rental rate is daily or weekly.

• additionalData key: carRental.rateIndicator

Valid values:

• "weekly"
• "daily"

The rental agreement number for the car rental.

• Format: ASCII
• maxLength: 9 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.rentalAgreementNumber

The classification of the rental car.

• Format: Alphanumeric
• maxLength: 4 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.rentalClassId

Indicates if the goods or services were tax-exempt, or if tax was not collected.

• additionalData key: carRental.taxExemptIndicator

The state or province where the car is rented.

• maxLength: 3 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.locationStateProvince

The country where the car is rented, in ISO 3166-1 alpha-2 format.

• maxLength: 2 characters
• additionalData key: carRental.locationCountry

The pick-up date.

• minLength: 10 characters
• maxLength: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: carRental.checkOutDate

The city where the car is rented.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.locationCity

Indicates if the customer didn't pick up their rental car.

• additionalData key: carRental.noShowIndicator

The name of the person renting the car.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.renterName

The agency code, phone number, or address abbreviation.

• Format: ASCII
• maxLength: 10 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.returnLocationId

The state or province where the car must be returned.

• Format: ASCII
• maxLength: 3 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.returnStateProvince

The country where the car must be returned, in ISO 3166-1 alpha-2 format.

• maxLength: 2 characters
• additionalData key: carRental.returnCountry

The date by which the car must be returned.

• minLength: 10 characters
• maxLength: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: carRental.returnDate

The city where the car must be returned.

• Format: ASCII
• maxLength: 18 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: carRental.returnCity

Any insurance charges associated with the rental, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: carRental.insuranceCharges

The fuel charges associated with the rental, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: carRental.fuelCharges

The charge for not returning a car to the original rental location, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: carRental.oneWayDropOffCharges

Rental rate, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• Frequency of the rental rate is specified in the rateType field.
• additionalData key: carRental.rate

Level 2 and Level 3 enhanced scheme data that may be required for processing the transaction and/or for interchange savings.

The date of the order.

• Min Length: 10 characters
• Max Length: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: enhancedSchemeData.orderDate

The postal code of the address where the item is shipped from.

• Encoding: ASCII
• Max length: 10 characters
• For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000.
• For Canada, it must be in 6 digits format. For example, M4B 1G5.
• additionalData key: enhancedSchemeData.shipFromPostalCode

The duty tax amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: enhancedSchemeData.dutyAmount

The destination address information.

The postal code of the destination address.

• Encoding: ASCII
• Max length: 10 characters
• Must not start with a space.
• For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000.
• For Canada, it must be in 6 digits format. For example, M4B 1G5.
• additionalData key: enhancedSchemeData.destinationPostalCode

The state or province code of the destination address.

• Encoding: ASCII
• Max length: 3 characters
• Must not start with a space.
• additionalData key: enhancedSchemeData.destinationStateProvinceCode

The two-letter ISO 3166-1 alpha-2 or three-letter ISO 3166-1 alpha-3 country code for the destination address.

• Encoding: ASCII
• Min length: 2 characters
• Max length: 3 characters
• additionalData key: enhancedSchemeData.destinationCountryCode

The amount of state or provincial tax included in the total transaction amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• For L2 data: must not be all zeroes.
• For L3 data: can be zero.
• additionalData key: enhancedSchemeData.totalTaxAmount

The reference number to identify the customer and their order.

• Format: ASCII
• Max length: 25 characters
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: enhancedSchemeData.customerReference

The list of item detail lines.

A description of the item, that provides details about the purchase.

For Visa transactions with level 3 ESD, the description must not be the same or very similar to your merchant name, or, consist only of common words like "product", or "service".

• Encoding: ASCII
• Max length: 26 characters
• Must not be a single character.
• Must not be blank.
• Must not be all special characters.
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: enhancedSchemeData.itemDetailLine[N].description

The number of items. Must be an integer greater than zero.

• Encoding: Numeric
• Max value: 9999
• additionalData key: enhancedSchemeData.itemDetailLine[N].quantity

The total amount for the line item, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000

See Amount requirements for level 2/3 ESD to learn more about how to calculate the line item total.

• additionalData key: enhancedSchemeData.itemDetailLine[N].totalAmount

The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes:

• UNSPSC commodity codes

• HS commodity codes

• NAICS commodity codes

• NAPCS commodity codes

• Encoding: ASCII

• Max length: 12 characters

• Must not start with a space or be all spaces.

• Must not be all zeros.

• additionalData key: enhancedSchemeData.itemDetailLine[N].commodityCode

The discount amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: enhancedSchemeData.itemDetailLine[N].discountAmount

The product code. Must be a unique product code associated with the item or service. This can be your unique code for the item, or the manufacturer's product code.

• Encoding: ASCII.
• Max length: 12 characters
• additionalData key: enhancedSchemeData.itemDetailLine[N].productCode

The unit of measurement for an item.

• Encoding: ASCII
• Max length: 3 characters
• additionalData key: enhancedSchemeData.itemDetailLine[N].unitOfMeasure

The unit price, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: enhancedSchemeData.itemDetailLine[N].unitPrice

The shipping amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: enhancedSchemeData.freightAmount

Lodging enhanced scheme data that may be required for processing the transaction and/or for interchange savings.

The toll-free phone number for the lodging customer service.

• Format: Alphanumeric
• For US and CA numbers must be 10 characters in length
• Must not start with a space
• Must not contain any special characters such as + or -
• Must not be all zeros.
• additionalData key: lodging.customerServiceTollFreeNumber

The lodging property location's phone number.

• Format: Alphanumeric
• Min length: 10 characters
• For US and CA numbers must be 10 characters in length
• Must not start with a space
• Must not contain any special characters such as + or -
• Must not be all zeros.
• additionalData key: lodging.propertyPhoneNumber

The check-in date.

• Min Length: 10 characters
• Max Length: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: lodging.checkInDate

The check-out date.

• Min Length: 10 characters
• Max Length: 10 characters
• Format ISO 8601: yyyy-MM-dd
• additionalData key: lodging.checkOutDate

Indicates if the customer didn't check in for their booking.

• additionalData key: lodging.noShowIndicator

The name of the person renting the room.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: lodging.renterName

The total tax amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.totalTax

The folio information for the booking.

The card acceptor's internal invoice or billing ID reference number.

• Format: Alphanumeric
• Must not start with a space
• Must not contain any special characters
• Must not be all zeros.
• additionalData key: lodging.folioNumber

The folio cash advances, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.folioCashAdvances

The prepaid expenses for the booking, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.prepaidExpenses

Any charges for food and beverages associated with the booking, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.foodBeverageCharges

Indicates that the facility complies with the Hotel and Motel Fire Safety Act of 1990.

• additionalData key: lodging.fireSafetyActIndicator

The total room tax amount, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.totalRoomTax

The category of lodging charges for the payment.

• additionalData key: lodging.specialProgramCode

Valid values:

• "noShow"
• "stay"
• "advanceDeposit"

The list of rooms booked.

Room rate per night, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: lodging.room[N].rate

The total number of nights the room is booked for.

• Format: Numeric
• Must be a number between 1 and 99
• additionalData key: lodging.room[N].numberOfNights

Temporary services enhanced scheme data that may be required for processing the transaction and/or for interchange savings.

The job description of the person working in a temporary capacity.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: enhancedSchemeData.jobDescription

The billing period end date.

• Format ISO 8601: yyyy-MM-dd
• additionalData key: enhancedSchemeData.tempWeekEnding

The name of the person requesting the temporary services.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: enhancedSchemeData.requestName

The number of hours worked during the billing period.

• Format: Numeric
• additionalData key: enhancedSchemeData.regularHoursWorked

The name or ID of the person working in a temporary capacity.

• Format: ASCII
• Must not start with a space or be all spaces.
• Must not be all zeros.
• additionalData key: enhancedSchemeData.employeeName

The hourly rate for the temporary services, in minor units.

• For example, 2000 means USD 20.00.
• Encoding: Numeric
• Max value: 10000000000
• additionalData key: enhancedSchemeData.regularHoursRate

The billing period start date.

• Format ISO 8601: yyyy-MM-dd
• additionalData key: enhancedSchemeData.tempStartDate

The merchant account that is used to process the payment.

Your reference for the cancel request. Maximum length: 80 characters.