transaction

Process a preauthorize: reserves the payment amount on the customer's payment instrument

post/transaction/{apiKey}/preauthorize

Request

Path parameters

apiKeystring required

API Key of Connector

Request body

merchantTransactionIdstring required
additionalId1string
additionalId2string
captureInMinutesinteger
extraDataExtraData
pspPassthroughDataPspPassthroughData
merchantMetaDatastring
referenceUuidstring
amountstring required
surchargeAmountstring
currencystring required
successUrlstring
cancelUrlstring
errorUrlstring
callbackUrlstring
transactionTokenstring
descriptionstring
withRegisterboolean
transactionIndicator'SINGLE' | 'INITIAL' | 'RECURRING' | 'FIRST-CARDONFILE' | 'CARDONFILE' | 'CARDONFILE-MERCHANT-INITIATED' | 'MOTO'
languagestring
requestDccboolean
publicDataPublicData (unresolved $ref)
referenceSchemeTransactionIdentifierstring
includeTracingboolean
requestPartialAuthorizationboolean

Request a partial authorization when the full amount cannot be authorized. The actual authorized amount may be less than the requested amount. Available on: CheckoutCom, StripeExtended, WorldLine

Response

Transaction response

successboolean
uuidstring
purchaseIdstring
returnType'FINISHED' | 'REDIRECT' | 'HTML' | 'PENDING' | 'ERROR' | 'PENDING_DCC'
redirectType'iframe' | 'fullpage' | '3ds'
redirectUrlstring
redirectQRCodestring

DataUrl

htmlContentstring
paymentDescriptorstring
paymentMethodstring
adapterMessagestring
adapterCodestring
extraDataExtraData

Changes

No recorded changes to this operation across all 1 revision of this API.