TItillpayments
transaction

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

Changed on
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
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
adapterMerchantTransactionIdstring

Adapter/PSP-side merchant transaction identifier recorded for transaction matching and reconciliation. Omitted when unavailable.

amountstring
surchargeAmountstring
gstAmountstring
totalAmountstring
adapterMessagestring
adapterCodestring
extraDataExtraData

Example response

{
  "returnData": {
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  }
}

Changes

  • 42c40d316a83Revision changes
    • warning

      changed the pattern of the request property // from ^[\-]?\d+$ to ^[\-\+]?\d{1,4}$

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new Eftpos enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5d765c6bfe90Revision changes
    • info

      added the new optional request property

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status