Process a void

Cancels a previously authorized Preauthorize.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiKeystringRequired

API Key of Connector

Request

Data which is required to process a void

merchantTransactionIdstringRequired1-50 characters

Your own unique identifier for this void request.

referenceUuidstringRequired1-50 characters

UUID of the Preauthorize transaction to void.

additionalId1stringOptional1-50 characters

Optional free-form identifier for your own reconciliation (e.g. order or invoice number).

additionalId2stringOptional1-50 characters

A second optional free-form identifier for your own reconciliation.

amountstringOptionalformat: "^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$"

Amount to void. Omit to void the full originally authorized amount.

currencyenumOptional

ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).

extraDatamap from strings to stringsOptional

pspPassthroughDatamap from strings to stringsOptional

merchantMetaDatastringOptional<=255 characters

Opaque metadata echoed back unchanged in callbacks and the transaction status response.

descriptionstringOptional<=255 characters

Free-text description of the void, shown to the customer or PSP where supported.

Response

Transaction response

successbooleanOptional

Whether the transaction was processed successfully.

uuidstringOptional

IXOPAY's unique identifier for this transaction. Use this to reference the transaction in later calls (e.g. capture, void, refund).

purchaseIdstringOptional

IXOPAY's human-readable purchase identifier for this transaction.

returnTypeenumOptional

How to continue the transaction — a final result (FINISHED/ERROR), or that further customer interaction is required (REDIRECT/HTML/PENDING/PENDING_DCC).

redirectTypeenumOptional

When returnType is REDIRECT, how the customer should be sent to redirectUrl (full-page redirect, iframe, or a 3-D Secure challenge).

Allowed values:

redirectUrlstringOptional<=255 characters

URL to send the customer to when further interaction is required.

redirectQRCodestringOptional

DataUrl

htmlContentstringOptional

Raw HTML to render to the customer when returnType is HTML.

paymentDescriptorstringOptional

Short descriptor shown on the customer's statement for this transaction, where supported by the acquirer.

paymentMethodstringOptional

Payment method used for this transaction (e.g. Creditcard, PayPal).

adapterMerchantTransactionIdstringOptional1-64 characters

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

returnDataobjectOptional

scheduleDataobjectOptional

customerProfileDataobjectOptional

riskCheckDataobjectOptional

errorslist of objectsOptional

adapterMessagestringOptional

Raw error message returned by the underlying PSP/adapter for this transaction, where available.

adapterCodestringOptional

Raw error code returned by the underlying PSP/adapter for this transaction, where available.

extraDatamap from strings to stringsOptional

dccDataobjectOptional