Process a debit

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 debit

merchantTransactionIdstringRequired1-50 characters

Your own unique identifier for this transaction. Must be unique per merchant.

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

currencyenumRequired

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

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.

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.

referenceUuidstringOptional1-50 characters

UUID of a previous Register or Debit-with-register transaction whose stored payment instrument should be charged.

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

Additional surcharge amount charged on top of amount (e.g. a card-processing fee), in the same currency.

successUrlstringOptional<=65535 characters

URL the customer's browser is redirected to after a successful redirect-based payment flow.

cancelUrlstringOptional<=65535 characters

URL the customer's browser is redirected to if they cancel a redirect-based payment flow.

errorUrlstringOptional<=65535 characters

URL the customer's browser is redirected to if a redirect-based payment flow fails.

callbackUrlstringOptional<=65535 characters

Server-to-server URL IXOPAY calls with the final transaction result; overrides the connector's configured default callback URL.

transactionTokenstringOptional

Token identifying a previously tokenized/stored payment instrument to charge, instead of raw card data.

descriptionstringOptional<=255 characters

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

itemslist of objectsOptional

splitslist of objectsOptional

withRegisterbooleanOptional

When true, also registers (tokenizes) the payment instrument used for this transaction for future reuse.

transactionIndicatorenumOptional

Classifies the transaction for card-scheme compliance (e.g. recurring, card-on-file, MOTO) — required by some acquirers/schemes for off-session charges.

customerobjectOptional

scheduleobjectOptional

customerProfileDataobjectOptional

threeDSecureDataobjectOptional

payByLinkobjectOptional

languagestringOptional=2 characters

Two-letter language code (ISO 639-1) used to localize the hosted payment page shown to the customer.

requestDccbooleanOptional

When true, requests Dynamic Currency Conversion so the customer can pay in their own currency.

dccDataobjectOptional

l2l3DataobjectOptional

referenceSchemeTransactionIdentifierstringOptional<=50 characters

Card-scheme transaction identifier from a prior transaction, used to chain this one to it (e.g. for scheme-mandated recurring/merchant-initiated transaction linking).

includeTracingbooleanOptional

When true, includes additional adapter/PSP tracing details in the response for debugging.

requestPartialAuthorizationbooleanOptional

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

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