Sign in
api
purchaseintents

Public Cancel a Purchase Intent

post/api/public/purchaseintents/{id}/cancel

Path parameters

idstring required

The ID of the purchase intent

Request body

secretstring required

The secret of the purchase intent

Response

OK

_idstring required
status'new' | 'complete' | 'canceled' required
approvalStatus'awaiting' | 'approved' | 'rejected' required
rejectionReasonstring
companystring
firstnamestring
lastnamestring
namestring
emailstring email
customerIdstring
sellerIdstring required
eventIdstring required
shopIdstring
strategyIdstring
vouchersstring[]
regularPricenumber float required
realPricenumber float required
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required
innerChargenumber float required
outerChargenumber float required
extraFieldsobject
expiresAtstring date-time
secretstring required
transactionIdstring
restrictedCompletionstring[] nullable

Specifies how the customer can complete their purchase intent

cancellationStrategy'notAllowed' | 'cancellationAllowed'
seatingReservationTokenstring
salesChannelIdstring
metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

createdAtstring date-time required
updatedAtstring date-time required
__vinteger

Changes

Changed in 2 of the 18 revisions of this API.111

  • 36be0dca14e711See the full diff
    • ▲

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

      response-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status

      response-property-one-of-removed

  • bafd26ef1fbe1See the full diff
    • ●

      added the new MWK enum value to the response property for the response status

      response-property-enum-value-added