> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://ixopay.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ixopay.ferndocs.com/_mcp/server.

# Process a debit

POST https://gateway.ixopay.com/api/v3/transaction/{apiKey}/debit
Content-Type: application/json

Reference: https://ixopay.ferndocs.com/developer-hub/api-reference/transaction-api/transaction/process-debit

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Path parameters

- `apiKey` (string, required) — API Key of Connector

### Body (application/json)

This endpoint expects a Debit.

- `merchantTransactionId` (string, required) — Your own unique identifier for this transaction. Must be unique per merchant.
- `amount` (string, required)
- `currency` (enum, required) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `additionalId1` (string, optional) — Optional free-form identifier for your own reconciliation (e.g. order or invoice number).
- `additionalId2` (string, optional) — A second optional free-form identifier for your own reconciliation.
- `extraData` (map from string to string, optional)
- `pspPassthroughData` (map from string to string, optional)
- `merchantMetaData` (string, optional) — Opaque metadata echoed back unchanged in callbacks and the transaction status response.
- `referenceUuid` (string, optional) — UUID of a previous Register or Debit-with-register transaction whose stored payment instrument should be charged.
- `surchargeAmount` (string, optional) — Additional surcharge amount charged on top of `amount` (e.g. a card-processing fee), in the same currency.
- `successUrl` (string, optional) — URL the customer's browser is redirected to after a successful redirect-based payment flow.
- `cancelUrl` (string, optional) — URL the customer's browser is redirected to if they cancel a redirect-based payment flow.
- `errorUrl` (string, optional) — URL the customer's browser is redirected to if a redirect-based payment flow fails.
- `callbackUrl` (string, optional) — Server-to-server URL IXOPAY calls with the final transaction result; overrides the connector's configured default callback URL.
- `transactionToken` (string, optional) — Token identifying a previously tokenized/stored payment instrument to charge, instead of raw card data.
- `description` (string, optional) — Free-text description of the transaction, shown to the customer or PSP where supported.
- `items` (list of ItemsItems, optional)
- `splits` (list of SplitsItems, optional)
- `withRegister` (boolean, optional) — When true, also registers (tokenizes) the payment instrument used for this transaction for future reuse.
- `transactionIndicator` (enum, optional) — Classifies the transaction for card-scheme compliance (e.g. recurring, card-on-file, MOTO) — required by some acquirers/schemes for off-session charges.
  - Allowed values: `SINGLE`, `INITIAL`, `RECURRING`, `FIRST-CARDONFILE`, `CARDONFILE`, `CARDONFILE-MERCHANT-INITIATED`, `MOTO`
- `customer` (Customer, optional)
- `schedule` (Schedule, optional)
- `customerProfileData` (CustomerProfileData, optional)
- `threeDSecureData` (ThreeDSecureData, optional)
- `payByLink` (PayByLink, optional)
- `language` (string, optional) — Two-letter language code (ISO 639-1) used to localize the hosted payment page shown to the customer.
- `requestDcc` (boolean, optional) — When true, requests Dynamic Currency Conversion so the customer can pay in their own currency.
- `dccData` (DccData, optional)
- `l2l3Data` (L2L3Data, optional)
- `referenceSchemeTransactionIdentifier` (string, optional) — 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).
- `includeTracing` (boolean, optional) — When true, includes additional adapter/PSP tracing details in the response for debugging.
- `requestPartialAuthorization` (boolean, optional) — 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

### 200

Transaction response

- `success` (boolean, optional) — Whether the transaction was processed successfully.
- `uuid` (string, optional) — IXOPAY's unique identifier for this transaction. Use this to reference the transaction in later calls (e.g. capture, void, refund).
- `purchaseId` (string, optional) — IXOPAY's human-readable purchase identifier for this transaction.
- `returnType` (enum, optional) — How to continue the transaction — a final result (FINISHED/ERROR), or that further customer interaction is required (REDIRECT/HTML/PENDING/PENDING_DCC).
  - Allowed values: `FINISHED`, `REDIRECT`, `HTML`, `PENDING`, `ERROR`, `PENDING_DCC`
- `redirectType` (enum, optional) — When returnType is REDIRECT, how the customer should be sent to redirectUrl (full-page redirect, iframe, or a 3-D Secure challenge).
  - Allowed values: `iframe`, `fullpage`, `3ds`
- `redirectUrl` (string, optional) — URL to send the customer to when further interaction is required.
- `redirectQRCode` (string, optional) — DataUrl
- `htmlContent` (string, optional) — Raw HTML to render to the customer when returnType is HTML.
- `paymentDescriptor` (string, optional) — Short descriptor shown on the customer's statement for this transaction, where supported by the acquirer.
- `paymentMethod` (string, optional) — Payment method used for this transaction (e.g. Creditcard, PayPal).
- `adapterMerchantTransactionId` (string, optional) — Adapter/PSP-side merchant transaction identifier recorded for transaction matching and reconciliation. Omitted when unavailable.
- `returnData` (ReturnData, optional)
- `scheduleData` (ScheduleData, optional)
- `customerProfileData` (CustomerProfileData, optional)
- `riskCheckData` (TransactionResponseRiskCheckData, optional)
- `errors` (list of TransactionResponseErrorsItems, optional)
- `adapterMessage` (string, optional) — Raw error message returned by the underlying PSP/adapter for this transaction, where available.
- `adapterCode` (string, optional) — Raw error code returned by the underlying PSP/adapter for this transaction, where available.
- `extraData` (map from string to string, optional)
- `dccData` (TransactionResponseDccData, optional)

## Types

### ItemsItems

- `identification` (string, optional)
- `name` (string, optional)
- `description` (string, optional)
- `quantity` (ItemsItemsQuantity, optional)
- `price` (ItemsItemsPrice, optional)
- `currency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `l2l3Data` (ItemsItemsL2L3Data, optional)
- `extraData` (map from string to string, optional)

### SplitsItems

- `identification` (string, optional)
- `amount` (string, optional)
- `currency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `sellerMerchantGuid` (string, optional)
- `sellerMerchantExternalId` (string, optional)
- `commissionFee` (SplitsItemsCommissionFee, optional)

### Customer

- `identification` (string, optional) — Your own identifier for this customer, used to link transactions/profiles to the same person.
- `firstName` (string, optional) — Customer's first name.
- `lastName` (string, optional) — Customer's last name.
- `birthDate` (string, optional)
- `gender` (enum, optional) — Customer's gender, where known.
  - Allowed values: `M`, `F`
- `billingAddress1` (string, optional) — First line of the customer's billing address.
- `billingAddress2` (string, optional) — Second line of the customer's billing address.
- `billingCity` (string, optional) — City of the customer's billing address.
- `billingPostcode` (string, optional) — Postal code of the customer's billing address.
- `billingState` (string, optional) — State or region of the customer's billing address.
- `billingCountry` (string, optional)
- `billingPhone` (string, optional) — Customer's billing phone number.
- `shippingFirstName` (string, optional) — First name on the shipping address.
- `shippingLastName` (string, optional) — Last name on the shipping address.
- `shippingCompany` (string, optional) — Company name on the shipping address, if shipping to a business.
- `shippingAddress1` (string, optional) — First line of the shipping address.
- `shippingAddress2` (string, optional) — Second line of the shipping address.
- `shippingCity` (string, optional) — City of the shipping address.
- `shippingPostcode` (string, optional) — Postal code of the shipping address.
- `shippingState` (string, optional) — State or region of the shipping address.
- `shippingCountry` (string, optional)
- `shippingPhone` (string, optional) — Phone number on the shipping address.
- `company` (string, optional) — Customer's company name, for business/B2B transactions.
- `email` (string, optional) — Customer's email address.
- `emailVerified` (boolean, optional) — Whether the merchant has already verified this customer's email address.
- `ipAddress` (string, optional) — Customer's IP address at the time of the transaction, used for fraud/risk screening.
- `nationalId` (string, optional) — Customer's national ID or tax identification number, where required by the acquirer or local regulation.
- `extraData` (map from string to string, optional)
- `paymentData` (PaymentData, optional)

### Schedule

- `amount` (string, required)
- `currency` (enum, required) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `periodLength` (integer, required)
- `periodUnit` (enum, required)
  - Allowed values: `DAY`, `WEEK`, `MONTH`, `YEAR`
- `startDateTime` (string, optional)
- `merchantMetaData` (string, optional)
- `callbackUrl` (string, optional)

### CustomerProfileData

- `profileGuid` (string, optional)
- `customerIdentification` (string, optional)
- `paymentToken` (string, optional)
- `markAsPreferred` (boolean, optional)

### ThreeDSecureData

- `3dsecure` (enum, optional)
  - Allowed values: `OFF`, `OPTIONAL`, `MANDATORY`
- `schemeId` (enum, optional)
  - Allowed values: `CB`, `Eftpos`
- `channel` (enum, optional)
  - Allowed values: `01`, `02`, `03`
- `authenticationIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`
- `cardholderAuthenticationMethod` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`
- `cardholderAuthenticationDateTime` (string, optional)
- `cardHolderAuthenticationData` (string, optional)
- `challengeIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`, `08`, `09`
- `priorReference` (string, optional)
- `priorAuthenticationMethod` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`
- `priorAuthenticationDateTime` (string, optional)
- `priorAuthenticationData` (string, optional)
- `cardholderAccountType` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`
- `cardholderAccountAgeIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`
- `cardholderAccountDate` (string, optional)
- `cardholderAccountChangeIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`
- `cardholderAccountLastChange` (string, optional)
- `cardholderAccountPasswordChangeIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`
- `cardholderAccountLastPasswordChange` (string, optional)
- `shippingAddressUsageIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`
- `shippingAddressFirstUsage` (string, optional)
- `transactionActivityDay` (double, optional)
- `transactionActivityYear` (double, optional)
- `addCardAttemptsDay` (double, optional)
- `purchaseCountSixMonths` (double, optional)
- `suspiciousAccountActivityIndicator` (enum, optional)
  - Allowed values: `01`, `02`
- `shippingNameEqualIndicator` (enum, optional)
  - Allowed values: `01`, `02`
- `paymentAccountAgeIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`
- `paymentAccountAgeDate` (string, optional)
- `billingAddressLine3` (string, optional)
- `shippingAddressLine3` (string, optional)
- `billingShippingAddressMatch` (enum, optional)
  - Allowed values: `Y`, `N`
- `homePhoneCountryPrefix` (string, optional)
- `homePhoneNumber` (string, optional)
- `mobilePhoneCountryPrefix` (string, optional)
- `mobilePhoneNumber` (string, optional)
- `workPhoneCountryPrefix` (string, optional)
- `workPhoneNumber` (string, optional)
- `purchaseInstalData` (double, optional)
- `shipIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`
- `deliveryTimeframe` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`
- `deliveryEmailAddress` (string, optional)
- `reorderItemsIndicator` (enum, optional)
  - Allowed values: `01`, `02`
- `preOrderPurchaseIndicator` (enum, optional)
  - Allowed values: `01`, `02`
- `preOrderDate` (string, optional)
- `giftCardAmount` (double, optional)
- `giftCardCurrency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `giftCardCount` (double, optional)
- `purchaseDate` (string, optional)
- `recurringExpiry` (string, optional)
- `recurringFrequency` (double, optional)
- `transType` (enum, optional)
  - Allowed values: `01`, `03`, `10`, `11`, `28`
- `exemptionIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`
- `threeRIIndicator` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `12`
- `browserChallengeWindowSize` (enum, optional)
  - Allowed values: `01`, `02`, `03`, `04`, `05`
- `browserAcceptHeader` (string, optional)
- `browserIpAddress` (string, optional)
- `browserJavaEnabled` (boolean, optional)
- `browserLanguage` (string, optional)
- `browserColorDepth` (ThreeDSecureDataBrowserColorDepth, optional)
- `browserScreenHeight` (ThreeDSecureDataBrowserScreenHeight, optional)
- `browserScreenWidth` (ThreeDSecureDataBrowserScreenWidth, optional)
- `browserTimezone` (ThreeDSecureDataBrowserTimezone, optional)
- `browserUserAgent` (string, optional)
- `browserPlatform` (string, optional)
- `sdkInterface` (enum, optional)
  - Allowed values: `01`, `02`, `03`
- `sdkUiType` (string, optional)
- `sdkAppID` (string, optional)
- `sdkEncData` (string, optional)
- `sdkEphemPubKey` (string, optional)
- `sdkMaxTimeout` (double, optional)
- `sdkReferenceNumber` (string, optional)
- `sdkTransID` (string, optional)

### PayByLink

- `sendByEmail` (boolean, optional)
- `expirationInMinute` (integer, optional)

### DccData

- `remoteIdentifier` (string, optional)
- `originalAmount` (string, optional)
- `originalCurrency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `convertedAmount` (string, optional)
- `convertedCurrency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `conversionRate` (double, optional)
- `selectedCurrency` (string, optional)
- `markUp` (double, optional)

### L2L3Data

- `taxAmount` (string, optional)
- `vatRegistrationNumber` (string, optional)
- `nationalTaxIncluded` (string, optional)
- `discountAmount` (string, optional)
- `commodityCode` (string, optional)
- `freightAmount` (string, optional)
- `freightTaxAmount` (string, optional)
- `dutyAmount` (string, optional)
- `taxDetails` (list of TaxDetailsItems, optional)

### ReturnData

### ScheduleData

- `scheduleId` (string, optional)
- `scheduleStatus` (enum, optional)
  - Allowed values: `ACTIVE`, `PAUSED`, `CANCELLED`, `ERROR`, `CREATE-PENDING`
- `scheduledAt` (string, optional)
- `merchantMetaData` (string, optional)

### TransactionResponseRiskCheckData

- `riskCheckResult` (enum, optional) — Outcome of any configured fraud/risk check.
  - Allowed values: `APPROVED`, `DECLINED`, `REVIEW`
- `riskScore` (double, optional) — Numeric risk score returned by the risk-check provider, where available.
- `threeDSecureRequired` (boolean, optional) — Whether 3-D Secure authentication is required to complete this transaction.

### TransactionResponseErrorsItems

- `errorMessage` (string, optional) — Human-readable error description.
- `errorCode` (integer, optional) — IXOPAY's internal error code.
- `adapterMessage` (string, optional) — Raw error message returned by the underlying PSP/adapter, where available.
- `adapterCode` (string, optional) — Raw error code returned by the underlying PSP/adapter, where available.

### TransactionResponseDccData

- `uuid` (string, optional) — Identifier for the DCC offer applied to this transaction.
- `originalAmount` (string, optional) — Original amount before Dynamic Currency Conversion.
- `originalCurrency` (enum, optional) — Original currency before Dynamic Currency Conversion.
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `convertedAmount` (string, optional) — Amount the customer was actually charged after Dynamic Currency Conversion.
- `convertedCurrency` (enum, optional) — Currency the customer was actually charged in after Dynamic Currency Conversion.
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`
- `conversionRate` (double, optional)
- `disclaimer` (string, optional)

### ItemsItemsQuantity

### ItemsItemsPrice

### ItemsItemsL2L3Data

- `type` (string, optional)
- `unit` (string, optional)
- `unitPrice` (string, optional)
- `discount` (string, optional)
- `discountRate` (string, optional)
- `shippingAmount` (string, optional)
- `taxAmount` (string, optional)
- `taxRate` (string, optional)
- `commodityCode` (string, optional)
- `taxDetails` (list of TaxDetailsItems, optional)

### SplitsItemsCommissionFee

- `amount` (string, optional)
- `currency` (enum, optional) — ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).
  - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VES`, `VND`, `VUV`, `WST`, `XAD`, `XAF`, `XCD`, `XCG`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWG`

### PaymentData

### ThreeDSecureDataBrowserColorDepth

### ThreeDSecureDataBrowserScreenHeight

### ThreeDSecureDataBrowserScreenWidth

### ThreeDSecureDataBrowserTimezone

### TaxDetailsItems

- `type` (string, optional)
- `amount` (string, optional)
- `rate` (string, optional)
- `code` (string, optional)
- `taxId` (string, optional)
- `applied` (string, optional)
- `exemptionCode` (string, optional)

### ReturnCardData

- `_TYPE` (string, optional)
- `type` (string, optional)
- `firstName` (string, optional)
- `lastName` (string, optional)
- `country` (string, optional)
- `cardHolder` (string, optional)
- `expiryMonth` (string, optional)
- `expiryYear` (string, optional)
- `binDigits` (string, optional)
- `firstSixDigits` (string, optional)
- `lastFourDigits` (string, optional)
- `fingerprint` (string, optional)
- `binBrand` (string, optional)
- `binBank` (string, optional)
- `binType` (string, optional)
- `binLevel` (string, optional)
- `binCountry` (string, optional)
- `binSegment` (enum, optional)
  - Allowed values: `Consumer`, `Business`, `Commercial`, `Government`, `Unknown`
- `binRawData` (ReturnCardDataBinRawData, optional)
- `threeDSecure` (string, optional)
- `eci` (string, optional)
- `merchantAdviceCode` (string, optional)
- `parsedMerchantAdviceCode` (string, optional)
- `schemeTransactionIdentifier` (string, optional)
- `schemeLifecycleIdentifier` (string, optional)
- `referenceSchemeLifecycleIdentifier` (string, optional)
- `cardUpdateStatus` (enum, optional) — Account updater transaction status
  - Allowed values: `updated`, `contact`, `new-expiry`, `closed`
- `cardUpdatedAt` (date, optional) — Last run of the batch
- `cardUpdatePausedUntil` (date, optional) — Updates paused until this date

### ReturnPhoneData

- `_TYPE` (string, optional)
- `phoneNumber` (string, optional)
- `country` (string, optional)
- `operator` (string, optional)

### ReturnIbanData

- `_TYPE` (string, optional)
- `accountOwner` (string, optional)
- `iban` (string, optional)
- `bic` (string, optional)
- `mandateId` (string, optional)
- `mandateDate` (string, optional)
- `bankName` (string, optional)
- `bankBranchName` (string, optional)
- `country` (string, optional)

### ReturnWalletData

- `_TYPE` (string, optional)
- `walletReferenceId` (string, optional)
- `walletOwner` (string, optional)
- `walletType` (string, optional)

### IbanData

- `ibanData` (IbanDataIbanData, optional)

### WalletData

- `walletData` (WalletDataWalletData, optional)

### ReturnCardDataBinRawData

- `type` (string, optional)
- `data` (map from string to any, optional)

### IbanDataIbanData

- `iban` (string, optional)
- `bic` (string, optional)
- `mandateId` (string, optional)
- `mandateDate` (string, optional)

### WalletDataWalletData

- `walletReferenceId` (string, optional)
- `walletOwner` (string, optional)
- `walletType` (string, optional)

## Examples

### finished

**Response**

```json
{
  "success": true,
  "uuid": "abcde12345abcde12345",
  "purchaseId": "20190927-abcde12345abcde12345",
  "returnType": "FINISHED",
  "paymentMethod": "Creditcard"
}
```

**SDK Code**

```python finished
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

response = requests.post(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript finished
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {method: 'POST', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go finished
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	req, _ := http.NewRequest("POST", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby finished
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java finished
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php finished
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp finished
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

IRestResponse response = client.Execute(request);
```

```swift finished
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### redirect

**Response**

```json
{
  "success": true,
  "uuid": "abcde12345abcde12345",
  "purchaseId": "20190927-abcde12345abcde12345",
  "returnType": "REDIRECT",
  "redirectUrl": "http://redirectComesUrlHere.com",
  "redirectQRCode": "data:image/png;base64,ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  "paymentMethod": "Creditcard"
}
```

**SDK Code**

```python redirect
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

response = requests.post(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript redirect
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {method: 'POST', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go redirect
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	req, _ := http.NewRequest("POST", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby redirect
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java redirect
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php redirect
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp redirect
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

IRestResponse response = client.Execute(request);
```

```swift redirect
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### processing error

**Response**

```json
{
  "success": false,
  "uuid": "abcde12345abcde12345",
  "purchaseId": "20200924-abcde12345abcde12345",
  "returnType": "ERROR",
  "paymentMethod": "Dummy",
  "errors": [
    {
      "errorMessage": "Dummy error",
      "errorCode": 1003,
      "adapterMessage": "Dummy adapter error"
    }
  ]
}
```

**SDK Code**

```python processing error
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

response = requests.post(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript processing error
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {method: 'POST', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go processing error
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	req, _ := http.NewRequest("POST", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby processing error
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java processing error
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php processing error
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp processing error
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

IRestResponse response = client.Execute(request);
```

```swift processing error
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### general error, e.g. duplicate

**Response**

```json
{
  "success": false
}
```

**SDK Code**

```python general error, e.g. duplicate
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

response = requests.post(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript general error, e.g. duplicate
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {method: 'POST', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go general error, e.g. duplicate
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	req, _ := http.NewRequest("POST", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby general error, e.g. duplicate
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java general error, e.g. duplicate
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php general error, e.g. duplicate
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp general error, e.g. duplicate
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

IRestResponse response = client.Execute(request);
```

```swift general error, e.g. duplicate
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### general error, e.g. validation

**Response**

```json
{
  "success": false
}
```

**SDK Code**

```python general error, e.g. validation
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

response = requests.post(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript general error, e.g. validation
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {method: 'POST', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go general error, e.g. validation
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	req, _ := http.NewRequest("POST", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby general error, e.g. validation
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java general error, e.g. validation
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php general error, e.g. validation
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp general error, e.g. validation
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

IRestResponse response = client.Execute(request);
```

```swift general error, e.g. validation
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### transaction_processDebit_example

**Request**

```json
{
  "merchantTransactionId": "2019-09-02-0001",
  "amount": "9.99",
  "currency": "EUR",
  "additionalId1": "x0001",
  "additionalId2": "y0001",
  "extraData": {
    "otherKey": "otherValue",
    "someKey": "someValue"
  },
  "merchantMetaData": "merchantRelevantData",
  "surchargeAmount": "0.99",
  "successUrl": "http://example.com/success",
  "cancelUrl": "http://example.com/cancel",
  "errorUrl": "http://example.com/error",
  "callbackUrl": "http://example.com/callback",
  "transactionToken": "ix::tRaNsAcT1OnToK3N",
  "description": "Example Product",
  "customer": {
    "identification": "c0001",
    "firstName": "John",
    "lastName": "Doe"
  },
  "threeDSecureData": {
    "3dsecure": "MANDATORY"
  },
  "language": "en",
  "referenceSchemeTransactionIdentifier": "IXHKDJRR462950"
}
```

**Response**

```json
{
  "success": true,
  "uuid": "abcde12345abcde12345",
  "purchaseId": "20190927-abcde12345abcde12345",
  "returnType": "FINISHED",
  "paymentMethod": "Creditcard"
}
```

**SDK Code**

```python transaction_processDebit_example
import requests

url = "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

payload = {
    "merchantTransactionId": "2019-09-02-0001",
    "amount": "9.99",
    "currency": "EUR",
    "additionalId1": "x0001",
    "additionalId2": "y0001",
    "extraData": {
        "otherKey": "otherValue",
        "someKey": "someValue"
    },
    "merchantMetaData": "merchantRelevantData",
    "surchargeAmount": "0.99",
    "successUrl": "http://example.com/success",
    "cancelUrl": "http://example.com/cancel",
    "errorUrl": "http://example.com/error",
    "callbackUrl": "http://example.com/callback",
    "transactionToken": "ix::tRaNsAcT1OnToK3N",
    "description": "Example Product",
    "customer": {
        "identification": "c0001",
        "firstName": "John",
        "lastName": "Doe"
    },
    "threeDSecureData": { "3dsecure": "MANDATORY" },
    "language": "en",
    "referenceSchemeTransactionIdentifier": "IXHKDJRR462950"
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript transaction_processDebit_example
const url = 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"merchantTransactionId":"2019-09-02-0001","amount":"9.99","currency":"EUR","additionalId1":"x0001","additionalId2":"y0001","extraData":{"otherKey":"otherValue","someKey":"someValue"},"merchantMetaData":"merchantRelevantData","surchargeAmount":"0.99","successUrl":"http://example.com/success","cancelUrl":"http://example.com/cancel","errorUrl":"http://example.com/error","callbackUrl":"http://example.com/callback","transactionToken":"ix::tRaNsAcT1OnToK3N","description":"Example Product","customer":{"identification":"c0001","firstName":"John","lastName":"Doe"},"threeDSecureData":{"3dsecure":"MANDATORY"},"language":"en","referenceSchemeTransactionIdentifier":"IXHKDJRR462950"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go transaction_processDebit_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit"

	payload := strings.NewReader("{\n  \"merchantTransactionId\": \"2019-09-02-0001\",\n  \"amount\": \"9.99\",\n  \"currency\": \"EUR\",\n  \"additionalId1\": \"x0001\",\n  \"additionalId2\": \"y0001\",\n  \"extraData\": {\n    \"otherKey\": \"otherValue\",\n    \"someKey\": \"someValue\"\n  },\n  \"merchantMetaData\": \"merchantRelevantData\",\n  \"surchargeAmount\": \"0.99\",\n  \"successUrl\": \"http://example.com/success\",\n  \"cancelUrl\": \"http://example.com/cancel\",\n  \"errorUrl\": \"http://example.com/error\",\n  \"callbackUrl\": \"http://example.com/callback\",\n  \"transactionToken\": \"ix::tRaNsAcT1OnToK3N\",\n  \"description\": \"Example Product\",\n  \"customer\": {\n    \"identification\": \"c0001\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  },\n  \"threeDSecureData\": {\n    \"3dsecure\": \"MANDATORY\"\n  },\n  \"language\": \"en\",\n  \"referenceSchemeTransactionIdentifier\": \"IXHKDJRR462950\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<username>", "<password>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby transaction_processDebit_example
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantTransactionId\": \"2019-09-02-0001\",\n  \"amount\": \"9.99\",\n  \"currency\": \"EUR\",\n  \"additionalId1\": \"x0001\",\n  \"additionalId2\": \"y0001\",\n  \"extraData\": {\n    \"otherKey\": \"otherValue\",\n    \"someKey\": \"someValue\"\n  },\n  \"merchantMetaData\": \"merchantRelevantData\",\n  \"surchargeAmount\": \"0.99\",\n  \"successUrl\": \"http://example.com/success\",\n  \"cancelUrl\": \"http://example.com/cancel\",\n  \"errorUrl\": \"http://example.com/error\",\n  \"callbackUrl\": \"http://example.com/callback\",\n  \"transactionToken\": \"ix::tRaNsAcT1OnToK3N\",\n  \"description\": \"Example Product\",\n  \"customer\": {\n    \"identification\": \"c0001\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  },\n  \"threeDSecureData\": {\n    \"3dsecure\": \"MANDATORY\"\n  },\n  \"language\": \"en\",\n  \"referenceSchemeTransactionIdentifier\": \"IXHKDJRR462950\"\n}"

response = http.request(request)
puts response.read_body
```

```java transaction_processDebit_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantTransactionId\": \"2019-09-02-0001\",\n  \"amount\": \"9.99\",\n  \"currency\": \"EUR\",\n  \"additionalId1\": \"x0001\",\n  \"additionalId2\": \"y0001\",\n  \"extraData\": {\n    \"otherKey\": \"otherValue\",\n    \"someKey\": \"someValue\"\n  },\n  \"merchantMetaData\": \"merchantRelevantData\",\n  \"surchargeAmount\": \"0.99\",\n  \"successUrl\": \"http://example.com/success\",\n  \"cancelUrl\": \"http://example.com/cancel\",\n  \"errorUrl\": \"http://example.com/error\",\n  \"callbackUrl\": \"http://example.com/callback\",\n  \"transactionToken\": \"ix::tRaNsAcT1OnToK3N\",\n  \"description\": \"Example Product\",\n  \"customer\": {\n    \"identification\": \"c0001\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  },\n  \"threeDSecureData\": {\n    \"3dsecure\": \"MANDATORY\"\n  },\n  \"language\": \"en\",\n  \"referenceSchemeTransactionIdentifier\": \"IXHKDJRR462950\"\n}")
  .asString();
```

```php transaction_processDebit_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/transaction/apiKey/debit', [
  'body' => '{
  "merchantTransactionId": "2019-09-02-0001",
  "amount": "9.99",
  "currency": "EUR",
  "additionalId1": "x0001",
  "additionalId2": "y0001",
  "extraData": {
    "otherKey": "otherValue",
    "someKey": "someValue"
  },
  "merchantMetaData": "merchantRelevantData",
  "surchargeAmount": "0.99",
  "successUrl": "http://example.com/success",
  "cancelUrl": "http://example.com/cancel",
  "errorUrl": "http://example.com/error",
  "callbackUrl": "http://example.com/callback",
  "transactionToken": "ix::tRaNsAcT1OnToK3N",
  "description": "Example Product",
  "customer": {
    "identification": "c0001",
    "firstName": "John",
    "lastName": "Doe"
  },
  "threeDSecureData": {
    "3dsecure": "MANDATORY"
  },
  "language": "en",
  "referenceSchemeTransactionIdentifier": "IXHKDJRR462950"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp transaction_processDebit_example
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://gateway.ixopay.com/api/v3/transaction/apiKey/debit");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"merchantTransactionId\": \"2019-09-02-0001\",\n  \"amount\": \"9.99\",\n  \"currency\": \"EUR\",\n  \"additionalId1\": \"x0001\",\n  \"additionalId2\": \"y0001\",\n  \"extraData\": {\n    \"otherKey\": \"otherValue\",\n    \"someKey\": \"someValue\"\n  },\n  \"merchantMetaData\": \"merchantRelevantData\",\n  \"surchargeAmount\": \"0.99\",\n  \"successUrl\": \"http://example.com/success\",\n  \"cancelUrl\": \"http://example.com/cancel\",\n  \"errorUrl\": \"http://example.com/error\",\n  \"callbackUrl\": \"http://example.com/callback\",\n  \"transactionToken\": \"ix::tRaNsAcT1OnToK3N\",\n  \"description\": \"Example Product\",\n  \"customer\": {\n    \"identification\": \"c0001\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  },\n  \"threeDSecureData\": {\n    \"3dsecure\": \"MANDATORY\"\n  },\n  \"language\": \"en\",\n  \"referenceSchemeTransactionIdentifier\": \"IXHKDJRR462950\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift transaction_processDebit_example
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "merchantTransactionId": "2019-09-02-0001",
  "amount": "9.99",
  "currency": "EUR",
  "additionalId1": "x0001",
  "additionalId2": "y0001",
  "extraData": [
    "otherKey": "otherValue",
    "someKey": "someValue"
  ],
  "merchantMetaData": "merchantRelevantData",
  "surchargeAmount": "0.99",
  "successUrl": "http://example.com/success",
  "cancelUrl": "http://example.com/cancel",
  "errorUrl": "http://example.com/error",
  "callbackUrl": "http://example.com/callback",
  "transactionToken": "ix::tRaNsAcT1OnToK3N",
  "description": "Example Product",
  "customer": [
    "identification": "c0001",
    "firstName": "John",
    "lastName": "Doe"
  ],
  "threeDSecureData": ["3dsecure": "MANDATORY"],
  "language": "en",
  "referenceSchemeTransactionIdentifier": "IXHKDJRR462950"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/transaction/apiKey/debit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```