Pricing Templates
Log in Sign up
Integrations / Adyen Checkout / ...

POST /cancels

Cancels the authorisation on a payment that has not yet been captured, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a TECHNICAL_CANCEL webhook.

If you want to cancel a payment using the pspReference, use the /payments/{paymentPspReference}/cancels endpoint instead.

If you want to cancel a payment but are not sure whether it has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead.

For more information, refer to Cancel.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Idempotency-Key String No

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

Request body fields

Name Type Required Description
applicationInfo Object No

Information about your application. For more details, see Building Adyen solutions.
applicationInfo.merchantApplication Object No

Merchant developed software, such as cashier application, used to interact with the Adyen API.
applicationInfo.merchantApplication.name String No

Name of the field. For example, Name of External Platform.
applicationInfo.merchantApplication.version String No

Version of the field. For example, Version of External Platform.
applicationInfo.externalPlatform Object No

Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.
applicationInfo.externalPlatform.integrator String No

External platform integrator.
applicationInfo.externalPlatform.name String No

Name of the field. For example, Name of External Platform.
applicationInfo.externalPlatform.version String No

Version of the field. For example, Version of External Platform.
applicationInfo.merchantDevice Object No

Merchant device information.
applicationInfo.merchantDevice.osVersion String No

Version of the operating system on the merchant device.
applicationInfo.merchantDevice.os String No

Operating system running on the merchant device.
applicationInfo.merchantDevice.reference String No

Merchant device reference.
applicationInfo.adyenLibrary Object No

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

Name of the field. For example, Name of External Platform.
applicationInfo.adyenLibrary.version String No

Version of the field. For example, Version of External Platform.
applicationInfo.shopperInteractionDevice Object No

Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.
applicationInfo.shopperInteractionDevice.osVersion String No

Version of the operating system on the shopper interaction device.
applicationInfo.shopperInteractionDevice.locale String No

Locale on the shopper interaction device.
applicationInfo.shopperInteractionDevice.os String No

Operating system running on the shopper interaction device.
applicationInfo.adyenPaymentSource Object No

Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.
applicationInfo.adyenPaymentSource.name String No

Name of the field. For example, Name of External Platform.
applicationInfo.adyenPaymentSource.version String No

Version of the field. For example, Version of External Platform.
enhancedSchemeData Object No

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

Airline enhanced scheme data that may be required for processing the transaction and/or for interchange savings.
enhancedSchemeData.airline.travelAgency Object No
enhancedSchemeData.airline.travelAgency.name String No

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
enhancedSchemeData.airline.travelAgency.code String No

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
enhancedSchemeData.airline.legs[] Array No
enhancedSchemeData.airline.legs[].dateOfTravel String No

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
enhancedSchemeData.airline.legs[].departureAirportCode String No

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
enhancedSchemeData.airline.legs[].destinationAirportCode String No

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
enhancedSchemeData.airline.legs[].carrierCode String No

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
enhancedSchemeData.airline.legs[].departureTax Integer No

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
enhancedSchemeData.airline.legs[].fareBasisCode String No

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
enhancedSchemeData.airline.legs[].flightNumber String No

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
enhancedSchemeData.airline.legs[].classOfTravel String No

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
enhancedSchemeData.airline.legs[].stopOverCode String No

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
enhancedSchemeData.airline.computerizedReservationSystem String No

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
enhancedSchemeData.airline.customerReferenceNumber String No

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
enhancedSchemeData.airline.flightDate String No

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
enhancedSchemeData.airline.ticket Object No
enhancedSchemeData.airline.ticket.issueAddress String No

The address of the organization that issued the ticket.

  • minLength: 0 characters
  • maxLength: 16 characters
  • additionalData key: airline.ticket_issue_address
enhancedSchemeData.airline.ticket.number String No

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
enhancedSchemeData.airline.ticket.issueDate String No

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
enhancedSchemeData.airline.code String No

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
enhancedSchemeData.airline.boardingFee Integer No

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

  • Encoding: Numeric
  • minLength: 1 character
  • maxLength: 11 characters
  • additionalData key: airline.boarding_fee
enhancedSchemeData.airline.designatorCode String No

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
enhancedSchemeData.airline.passengers[] Array No
enhancedSchemeData.airline.passengers[].lastName String No

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
enhancedSchemeData.airline.passengers[].phoneNumber String No

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
enhancedSchemeData.airline.passengers[].firstName String No

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
enhancedSchemeData.airline.passengers[].travellerType String No

The IATA passenger type code (PTC).

  • Encoding: ASCII
  • minLength: 3 characters
  • maxLength: 6 characters
  • additionalData key: airline.passenger[N].traveller_type
enhancedSchemeData.airline.passengers[].dateOfBirth String No

The passenger's date of birth.

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

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
enhancedSchemeData.airline.agency Object No
enhancedSchemeData.airline.agency.planName String No

The two-letter agency plan identifier.

  • Encoding: ASCII
  • minLength: 2 characters
  • maxLength: 2 characters
  • additionalData key: airline.agency_plan_name
enhancedSchemeData.airline.agency.invoiceNumber String No

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

  • Encoding: ASCII
  • minLength: 1 character
  • maxLength: 6 characters
  • additionalData key: airline.agency_invoice_number
enhancedSchemeData.airline.passengerName String Yes

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
enhancedSchemeData.carRental Object No

Car rental enhanced scheme data that may be required for processing the transaction and/or for interchange savings.
enhancedSchemeData.carRental.rentalDays Integer No

The number of days the car is rented for.

  • Format: Numeric
  • Max value: 9999
  • additionalData key: carRental.daysRented
enhancedSchemeData.carRental.customerServicePhoneNumber String No

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
enhancedSchemeData.carRental.rateType String No

Indicates whether the rental rate is daily or weekly.

  • additionalData key: carRental.rateIndicator

Valid values:

  • "weekly"
  • "daily"
enhancedSchemeData.carRental.rentalAgreementNumber String No

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
enhancedSchemeData.carRental.rentalClassId String No

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
enhancedSchemeData.carRental.taxExempt Boolean No

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

  • additionalData key: carRental.taxExemptIndicator
enhancedSchemeData.carRental.pickupInfo Object No
enhancedSchemeData.carRental.pickupInfo.stateOrProvince String No

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
enhancedSchemeData.carRental.pickupInfo.countryCode String No

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

  • maxLength: 2 characters
  • additionalData key: carRental.locationCountry
enhancedSchemeData.carRental.pickupInfo.date String No

The pick-up date.

  • minLength: 10 characters
  • maxLength: 10 characters
  • Format ISO 8601: yyyy-MM-dd
  • additionalData key: carRental.checkOutDate
enhancedSchemeData.carRental.pickupInfo.city String No

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
enhancedSchemeData.carRental.noShow Boolean No

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

  • additionalData key: carRental.noShowIndicator
enhancedSchemeData.carRental.renterName String Yes

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
enhancedSchemeData.carRental.returnInfo Object No
enhancedSchemeData.carRental.returnInfo.locationId String No

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
enhancedSchemeData.carRental.returnInfo.stateOrProvince String No

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
enhancedSchemeData.carRental.returnInfo.countryCode String No

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

  • maxLength: 2 characters
  • additionalData key: carRental.returnCountry
enhancedSchemeData.carRental.returnInfo.date String No

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
enhancedSchemeData.carRental.returnInfo.city String No

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
enhancedSchemeData.carRental.rentalSurcharges Object No
enhancedSchemeData.carRental.rentalSurcharges.insurance Integer No

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
enhancedSchemeData.carRental.rentalSurcharges.fuel Integer No

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
enhancedSchemeData.carRental.rentalSurcharges.oneWayDropOff Integer No

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
enhancedSchemeData.carRental.rentalRate Integer No

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
enhancedSchemeData.levelTwoThree Object No

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

The date of the order.

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

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
enhancedSchemeData.levelTwoThree.dutyAmount Integer No

The duty tax amount, in minor units.

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

The destination address information.
enhancedSchemeData.levelTwoThree.destination.postalCode String No

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
enhancedSchemeData.levelTwoThree.destination.stateOrProvince String No

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
enhancedSchemeData.levelTwoThree.destination.countryCode String No

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
enhancedSchemeData.levelTwoThree.totalTaxAmount Integer No

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
enhancedSchemeData.levelTwoThree.customerReferenceNumber String No

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
enhancedSchemeData.levelTwoThree.itemDetailLines[] Array No

The list of item detail lines.
enhancedSchemeData.levelTwoThree.itemDetailLines[].description String No

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
enhancedSchemeData.levelTwoThree.itemDetailLines[].quantity Integer No

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

  • Encoding: Numeric
  • Max value: 9999
  • additionalData key: enhancedSchemeData.itemDetailLine[N].quantity
enhancedSchemeData.levelTwoThree.itemDetailLines[].totalAmount Integer No

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
enhancedSchemeData.levelTwoThree.itemDetailLines[].commodityCode String No

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
enhancedSchemeData.levelTwoThree.itemDetailLines[].discountAmount Integer No

The discount amount, in minor units.

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

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
enhancedSchemeData.levelTwoThree.itemDetailLines[].unitOfMeasure String No

The unit of measurement for an item.

  • Encoding: ASCII
  • Max length: 3 characters
  • additionalData key: enhancedSchemeData.itemDetailLine[N].unitOfMeasure
enhancedSchemeData.levelTwoThree.itemDetailLines[].unitPrice Integer No

The unit price, in minor units.

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

The shipping amount, in minor units.

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

Lodging enhanced scheme data that may be required for processing the transaction and/or for interchange savings.
enhancedSchemeData.lodging.customerServicePhoneNumber String No

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
enhancedSchemeData.lodging.propertyPhoneNumber String No

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
enhancedSchemeData.lodging.checkInDate String No

The check-in date.

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

The check-out date.

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

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

  • additionalData key: lodging.noShowIndicator
enhancedSchemeData.lodging.renterName String No

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
enhancedSchemeData.lodging.totalTax Integer No

The total tax amount, in minor units.

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

The folio information for the booking.
enhancedSchemeData.lodging.folio.number String No

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
enhancedSchemeData.lodging.folio.cashAdvances Integer No

The folio cash advances, in minor units.

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

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
enhancedSchemeData.lodging.foodBeverageCharges Integer No

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
enhancedSchemeData.lodging.fireSafetyCompliance Boolean No

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

  • additionalData key: lodging.fireSafetyActIndicator
enhancedSchemeData.lodging.totalRoomTax Integer No

The total room tax amount, in minor units.

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

The category of lodging charges for the payment.

  • additionalData key: lodging.specialProgramCode

Valid values:

  • "noShow"
  • "stay"
  • "advanceDeposit"
enhancedSchemeData.lodging.rooms[] Array No

The list of rooms booked.
enhancedSchemeData.lodging.rooms[].rate Integer No

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
enhancedSchemeData.lodging.rooms[].numberOfNights Integer No

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
enhancedSchemeData.temporaryServices Object No

Temporary services enhanced scheme data that may be required for processing the transaction and/or for interchange savings.
enhancedSchemeData.temporaryServices.jobDescription String No

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
enhancedSchemeData.temporaryServices.endDate String No

The billing period end date.

  • Format ISO 8601: yyyy-MM-dd
  • additionalData key: enhancedSchemeData.tempWeekEnding
enhancedSchemeData.temporaryServices.serviceRequestor String No

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
enhancedSchemeData.temporaryServices.hoursWorked Integer No

The number of hours worked during the billing period.

  • Format: Numeric
  • additionalData key: enhancedSchemeData.regularHoursWorked
enhancedSchemeData.temporaryServices.employeeName String No

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
enhancedSchemeData.temporaryServices.hourRate Integer No

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
enhancedSchemeData.temporaryServices.startDate String No

The billing period start date.

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

The reference of the payment that you want to cancel.
merchantAccount String Yes

The merchant account that is used to process the payment.
reference String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy