{ "openapi": "3.0.1", "info": { "title": "Axepta Online API", "description": "The Axepta Online API allows you to seamlessly process and manage payments, supporting 350+ payment methods worldwide. Built on REST principles, the API is designed to be predictable and developer-friendly, with resource-oriented URLs, JSON-encoded requests and responses, and standard HTTP status codes.\n\n**Security**\n\nThe Axepta Online API is designed with maximum security while remaining easy to implement. All communication occurs over HTTPS (TLS 1.2 or higher), ensuring end-to-end encryption at the transport level. This prevents packet sniffing, replay attacks, and other vulnerabilities without requiring additional encryption of the data itself.\n\n**Test Before You Go Live**\n\nUse our test environment to test your integration without affecting live data. The root URL determines whether the request is for test or live integration.", "version": "2.2.0" }, "servers": [ { "url": "https://test.paymentpage.axepta.bnpparibas/api/v2", "description": "Test server" }, { "url": "https://paymentpage.axepta.bnpparibas/api/v2", "description": "Production server" } ], "tags": [ { "name": "Guide", "description": "For functional documentation, please refer to the [Confluence Guide](https://docs.axepta.bnpparibas/display/DOCBNP/Axepta+BNP+Paribas+REST+API)" }, { "name": "Authentication", "description": "**Securely authenticate API requests using Basic Auth or OAuth 2.0**\n\nThe Axepta Online API supports two authentication methods to ensure secure access to payment processing and management endpoints. Choose the approach that aligns with your integration needs:\n\n**Basic Authentication**\n\nUse your Merchant ID as the username and API Key as the password. Combine them in the format `MerchantID:APIKey`, encode the string using Base64, and include it in the Authorization header with the `Basic` prefix for direct access to endpoints.\n\n**OAuth 2.0**\n\nGenerate a short-lived JSON Web token (JWT) by authenticating with your API key via the `authorization/oauth/token` endpoint." }, { "name": "Payments", "description": "\n**Create checkout session**\n\nThis endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.\n\n**Create payment**\n\nThis endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types:\n * HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment.\n * DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments.\n\n\nNote that not all payment methods support both HOSTED and DIRECT integration types. Some support only one of these options, while others support both. For detailed information about the supported integration types for each payment method, refer to the payment method-specific documentation in our product guide.\n\n**Confirm payment**\n\nThis endpoint is used for payment methods that require a multi-step payment flow. It allows you to confirm a previously created payment instance (initiated via the Create Payment endpoint) to complete the transaction. This step is essential for certain payment methods to finalize the payment process.\n\n**Incremental authorization**\n\nThis endpoint allows you to increase the authorized amount for an existing card transaction when the initial authorization is insufficient. The additional amount is appended to the original authorization, and the total authorized amount reflects both.\n\n**Reverse payment**\n\nThis endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization.\n\n**Capture payment**\n\nThis endpoint is used to capture an existing authorized payment.\n\n**Refund payment**\n\nThis endpoint is used to refund a captured payment.\n\n**Refund payment without reference**\n\nThis endpoint is used to refund a payment without reference.\n\n**Retrieve payment details by Payment ID**\n\nThis endpoint is used to retrieve payment details with the Payment ID (payId)\n\n**Retrieve payment details by Transaction ID**\n\nThis endpoint is used to retrieve payment details with the Transaction ID (transId)\n\n**Update payment details**\n\nThis endpoint is used to update payment details\n\n**Create payment link**\n\nThis endpoint allows you to generate a payment link that can be shared with customers via email, SMS, or other channels. When customers click the link, they are redirected to a hosted payment page where they can select their preferred payment method and complete the transaction." }, { "name": "Webhooks", "description": "**Receive payment result notifications via Webhooks**\n\nThe Axepta Online API enables asynchronous event notifications through Webhooks, allowing your system to automatically receive the final result of a payment for hosted integration types, without the need for continuous polling.\n\n**Basic Webhook**\n\nSends only the payId, allowing your system to fetch full payment details afterward.\n\n**Enhanced Webhook**\n\nSends the complete payment information directly within the webhook payload.\n\nFor information on securing webhook communication, see the *Security & verification* section in the [documentation](https://developer.computop.com/display/EN/REST+API+Webhooks)." }, { "name": "Customers", "description": "\n**Retrieve customers**\n\nThis endpoint is used to retrieve a list of customers.\n\n**Retrieve customer**\n\nThis endpoint is used to retrieve details of a specific customer.\n\n**Update customer data**\n\nThis endpoint is used to update customer data.\n\n**Delete customer**\n\nThis endpoint is used to delete a specific customer and associated payment methods.\n\n**Retrieve payment methods**\n\nThis endpoint is used to retrieve all payment methods for a specific customer.\n\n**Retrieve payment method**\n\nThis endpoint is used to retrieve details of a specific payment method.\n\n**Delete payment method**\n\nThis endpoint is used to delete a specific payment method." }, { "name": "Change log", "description": "2.2.0\n - Fix 400 error code response body specs\n - Return order.invoiceId and order.merchantReference in Response if sent in request\n - Add order.description property to provide overall description for the order\n\n2.1.0\n - Changed the name of the VIPPS payment method to `VIPPSMOBILEPAY` and add recurring payment support\n - Enhanced the get payment details response for the `WERO` payment method\n - Enhanced the card payment method response with `cardholderConsentToStore`\n - Updated the Bancontact payment method acquirer logic\n - Fixed the `RATEPAY` payment method tax rate calculation\n - Fixed the Customer Vault `pseudoCardNumber` and `last4Digits` issues\n - Removed unnecessary recurring object validation\n - Added support for the `BIZUM` payment method\n - Added support for the `UNIONPAY` payment method via `PPRO`\n - Added support for the `ALIPAY` payment method via `PPRO`\n - Added support for the `WECHAT` payment method via `PPRO`\n - Added support for the `MBWAY` payment method via `PPRO`\n - Added services/dcc/quote endpoint\n - Added services/dcc/bin-check endpoint\n - Enhanced the get payment details response for the `CARD` payment method (dccInfo object)\n - Enhanced the create payment hosted (dccEnabled parameter) and direct (dcc object) requests for the `CARD` payment method\n - Enhanced the create session request for the `CARD` payment method (dccEnabled parameter)\n\n2.0.0\n - Initial version of REST API V2 Specification" } ], "paths": { "/authorization/oauth/token": { "servers": [ { "url": "https://test.paymentpage.axepta.bnpparibas", "description": "Test server" }, { "url": "https://paymentpage.axepta.bnpparibas", "description": "Production server" } ], "post": { "tags": [ "Authentication" ], "summary": "Request OAuth Token", "operationId": "authorizationService", "requestBody": { "description": "Request for client authorization", "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/authorizationRequest" }, "examples": { "Default": { "value": { "grant_type": "client_credentials", "client_id": "MerchantId", "client_secret": "ApiKey" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorizationResponse" }, "examples": { "Default": { "value": { "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkZGQzlEM0JEQzY2Mjc3MUYwNzYxRUJDRTkwOTMyMDMyQjdGOTQ1NTQiLCJ4NXQiOiJfOG5UdmNaaWR4OEhZZXZPa0pNZ01yZjVSVlEiLCJ0eXAiOiJhdCtqd3QifQ.eyJpc3MiOiJodHRwczovL2xvY2FsaG9zdDo3MTIxLyIsImV4cCI6MTc0MDQ3NTUwNCwiaWF0IjoxNzQwNDcxOTA0LCJqdGkiOiJiZjU3YmUwMi05YThiLTQxYjctYjNjNi02NzlmMTcxNDU2ZjAiLCJzdWIiOiJDVF9Mb2dlZWNvbV90ZXN0IiwibmFtZSI6IkNUX0xvZ2VlY29tX3Rlc3QiLCJtYXJrZXRwbGFjZUlkIjoiQ1RfTG9nZWVjb21fdGVzdF9NYXJrZXRwbGFjZSIsIm1hcmtldHBsYWNlQWN0aXZlIjpmYWxzZSwib2lfcHJzdCI6IkNUX0xvZ2VlY29tX3Rlc3QiLCJjbGllbnRfaWQiOiJDVF9Mb2dlZWNvbV90ZXN0Iiwib2lfdGtuX2lkIjoiMjEwMWUxNTgtNzY0NC00OGU4LWIzNmYtYmZhNzczNWJmYjAyIn0.Xgtb81-GBPGnQ2tSJKXIlA38koRqlVa2oLhT902t-ICocWYD4_35bTAiPfU2A4HWwQpg1PZTrdf4riSoA_v_5bWSM-rdHAb-Y7fNwQTYAUYDxkcrw9qc5JcjwBGlOgXGTzJR2xyPDTq2sO4qAxo00lhCVjhEQR47yqOFta9rkcCmg1i6T6BxF7ZO6tBECfo7NSJ0wgN7G5_Unmd5MgWuG8V5VdvDxhXa1p_sBQdmy6nBCRi2d2bh1BOrz_uT5U2zngVBPzZBXv046j7971JXZbR20JFpkqwrULCGR6fy78NvkrHNC4U8ZDHmbejBbObMGCb_8pWMnaLhIg0A1k2x0Q", "token_type": "Bearer", "expires_in": 3600 } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorizationValidationErrorResponse" } } } }, "401": { "description": "Unauthorized, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedErrorResponse" } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } } } }, "/payments/sessions": { "post": { "tags": [ "Payments" ], "summary": "Create checkout session", "description": "This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.", "operationId": "createSession", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Create a new checkout session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSessionRequest" }, "examples": { "Example": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "language": "de", "template": { "name": "hpp_template", "customFields": { "customField1": "Field 1 Data", "customField2": "Field 2 Data", "customField3": "Field 3 Data", "customField4": "Field 4 Data", "customField5": "Field 5 Data", "customField6": "Field 6 Data", "customField7": "Field 7 Data", "customField8": "Field 8 Data", "customField9": "Field 9 Data", "customField10": "Field 10 Data", "customField11": "Field 11 Data", "customField12": "Field 12 Data", "customField13": "Field 13 Data", "customField14": "Field 14 Data" } }, "captureMethod": { "type": "AUTOMATIC" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "description": "Order description", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/cancel", "webhook": "https://my.callback.url.com/webhook", "appRedirect": "https://my.callback.url.com/appRedirect" }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "statementDescriptor": "gadgets shop", "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" }, "salutation": "Ms", "title": "Dr", "gender": "female", "maidenName": "Mustermann", "middleName": "sam", "birthDate": "2001-01-01", "birthPlace": "Bamberg", "socialSecurityNumber": "123443534" }, "allowedPaymentMethods": [ "ALIPAY", "BANCONTACT", "BIZUM", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "FLOAPAY", "INSTANEA", "KLARNA", "MBWAY", "MULTIBANCO", "MYBANK", "PAYPAL", "PRZELEWY24", "UNIONPAY", "TRUSTLY", "TWINT", "VIPPSMOBILEPAY", "WECHAT", "WERO" ], "paymentMethods": { "bizum": { "sellingPoint": "Online Store", "service": "BatteryPowerPack", "account": { "accountHolderName": "Max Mustermann" } }, "card": { "subType": [ "VISA", "MASTERCARD" ], "dccEnabled": true, "template": { "name": "card_template", "fontSize": 11, "textColor": "#FFFFFF", "customFields": { "customField1": "Field 1 Data", "customField2": "Field 2 Data", "customField3": "Field 3 Data", "customField4": "Field 4 Data", "customField5": "Field 5 Data", "customField6": "Field 6 Data", "customField7": "Field 7 Data", "customField8": "Field 8 Data", "customField9": "Field 9 Data", "customField10": "Field 10 Data", "customField11": "Field 11 Data", "customField12": "Field 12 Data", "customField13": "Field 13 Data", "customField14": "Field 14 Data" } } }, "klarna": { "layout": { "showSubTotalDetail": "HIDE", "logoUrl": "https://example.com/logo.svg", "pageTitle": "Secure Payment with Klarna" }, "accountId": "exmple_id", "enhancedData": [ { "productCategory": "Test product category", "productName": "Test product name" } ] }, "mbWay": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" }, "multibanco": { "service": "products", "sellingPoint": "sp", "account": { "accountHolder": "John Doe" } }, "payPal": { "accountId": "customer@example.com", "hideAddress": false }, "unionPay": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" }, "eps": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "code": "COBADEFFXXX" }, "optionDate": "2025-10-20", "sellingPoint": "Some selling point", "service": "Some service" }, "weChat": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" } } } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSessionResponse" }, "examples": { "Test Environment": { "value": { "_links": { "redirect": { "href": "https://test.paymentpage.axepta.bnpparibas?token=ce0aef1079d84c5082b3013ee6f9e1fe", "type": "text/html" } } } }, "Live Environment": { "value": { "_links": { "redirect": { "href": "https://paymentpage.axepta.bnpparibas?token=ce0aef1079d84c5082b3013ee6f9e1fe", "type": "text/html" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments": { "post": { "tags": [ "Payments" ], "summary": "Create payment", "description": "This endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types:\n HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment.\n DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments.\n\nNote that not all payment methods support both HOSTED and DIRECT integration types. Some support only one of these options, while others support both. For detailed information about the supported integration types for each payment method, refer to the payment method-specific documentation in our product guide.", "operationId": "createPayment", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Create a new payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequest" }, "examples": { "Bizum - HOSTED": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "6B29FC62-1069", "amount": { "currency": "EUR", "value": 100 }, "paymentMethods": { "integrationType": "HOSTED", "type": "BIZUM", "bizum": { "account": { "accountHolderName": "Jane Doe" }, "sellingPoint": "Post office", "service": "DHL" } } } }, "Card - DIRECT": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "captureMethod": { "type": "AUTOMATIC" }, "browserInfo": { "acceptHeaders": "text", "ipAddress": "93.176.166.240", "javaEnabled": false, "javaScriptEnabled": true, "language": "EN", "userAgent": "Mozilla/5.0" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "description": "Order description", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" }, "salutation": "Ms", "title": "Dr", "gender": "female", "maidenName": "Mustermann", "middleName": "sam", "birthDate": "2001-01-01", "birthPlace": "Bamberg", "socialSecurityNumber": "123443534" }, "channel": "ECOM", "paymentMethods": { "integrationType": "DIRECT", "type": "CARD", "card": { "number": "4242424242424242", "cardHolderName": "Max Mustermann", "expiryDate": "202801", "brand": "VISA", "securityCode": "123", "brandSelection": "MERCHANT", "dcc": { "selected": true, "dccRequestId": "debf1be9841944dc8f6795d73bd4ffb4" } } } } }, "Card - HOSTED": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "language": "de", "captureMethod": { "type": "AUTOMATIC" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "description": "Order description", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/cancel", "webhook": "https://my.callback.url.com/webhook" }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" }, "salutation": "Ms", "title": "Dr", "gender": "female", "maidenName": "Mustermann", "middleName": "sam", "birthDate": "2001-01-01", "birthPlace": "Bamberg", "socialSecurityNumber": "123443534" }, "channel": "ECOM", "paymentMethods": { "integrationType": "HOSTED", "type": "CARD", "card": { "subType": [ "VISA", "MASTERCARD" ], "dccEnabled": true, "template": { "name": "card_template", "fontSize": 11, "textColor": "#FFFFFF", "customFields": { "customField1": "Field 1 Data", "customField2": "Field 2 Data", "customField3": "Field 3 Data", "customField4": "Field 4 Data", "customField5": "Field 5 Data", "customField6": "Field 6 Data", "customField7": "Field 7 Data", "customField8": "Field 8 Data", "customField9": "Field 9 Data", "customField10": "Field 10 Data", "customField11": "Field 11 Data", "customField12": "Field 12 Data", "customField13": "Field 13 Data", "customField14": "Field 14 Data" } } } } } }, "EPS - HOSTED": { "value": { "transId": "unique-trans-id-20251016", "refNr": "unique-ref-nr-20251016", "partialPayment": false, "amount": { "currency": "EUR", "value": 50000 }, "urls": { "return": "https://my.callback.url.com/success", "webhook": "https://my.callback.url.com/webhook" }, "language": "DE", "simulationMode": "Test EPS payment", "order": { "items": [ { "name": "item1", "quantity": 1, "netPrice": 25000 }, { "name": "item2", "quantity": 2, "netPrice": 12500 } ] }, "paymentMethods": { "integrationType": "HOSTED", "type": "EPS", "eps": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "code": "COBADEFFXXX" }, "optionDate": "2025-10-20", "sellingPoint": "Some selling point", "service": "Some service" } } } }, "Ideal - HOSTED": { "value": { "transId": "780863758d4f48d4a4f4712b", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "language": "de", "urls": { "return": "https://my.callback.url.com/return", "webhook": "https://my.callback.url.com/webhook" }, "metadata": { "userData": "my user data", "k1": "v1", "plain": "plain text", "k2": "v2" }, "paymentMethods": { "type": "IDEAL", "integrationType": "HOSTED", "ideal": { "subType": "IDEAL" } } } }, "GooglePay - DIRECT": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "language": "de", "captureMethod": { "type": "AUTOMATIC" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "description": "Order description", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" }, "salutation": "Ms", "title": "Dr", "gender": "female", "maidenName": "Mustermann", "middleName": "sam", "birthDate": "2001-01-01", "birthPlace": "Bamberg", "socialSecurityNumber": "123443534" }, "channel": "ECOM", "paymentMethods": { "integrationType": "DIRECT", "type": "GOOGLEPAY", "googlePay": { "token": "ewogICJzaWduYXR1cmUiOiAiTUVRQ0lDNHovUUhTcnpla1Jra3VrM3ZHWXhCVEJkTmdFUWw1WEZIeDBXazVmRkxJVUFpQjMrcTIyN2hhdkFKZGFnZkdaYU1YYmVmaGF0ZEpFN0RmMnFySW9LRHYxT2c9PSIsCiAgInByb3RvY29sVmVyc2lvbiI6ICJFQ3YxIiwKICAic2lnbmVkTWVzc2FnZSI6ICJ7XCJlbmNyeXB0ZWRNZXNzYWdlXCI6XCJiT1lSbUV4R2VDc0JyRnFFU3Q3a2Q5TzFGTit2UVpmMktHMFVOWUM4ak5BK1ZWZjluUWVLN2xEdlU4azM3Y0grTE96aUpRa0hOTDJPeERISWs2R29SVjFCclhwcndCbkFKUjBPMlZuQ1VIOGxzcXEwRUx3ZW1lcVczNjRJcjhjVS9oREZ6V05wKzM4SDI1SlZEQU1FeFpCS29kTU1UelVYWGd5TytzNWpPeUFsOGpVaG5BdzNmVFJQa2VmdVlzRThORks1dHZjczRMMjloODdabzdvdDAvOFhyVWhYdDliL0ZsZDFMRXRoa3VQU04rSzFlRUZQN2JzZUI2ampSZEhud1lBZHFpRTNpT21oNzFwY0RtTkl5cmxXUmo3NFVKYXN6ZWVyWlc3RG9aTngxMW9ON2ZvdXEvOGZlMXZrbHNyL2UreS9SU0cyblFNV2c1eVIvZk1UZnFDeWFiVERoSk12TU0xWmhlOTErZFEwL3hpL3pLUmdzSWhpb25nSlVqWXRvU05JalVIbk1MUnVWVEtkalg1MENDSTFRT2lCdHI5aDBiT0xlUGh4dzljTFllVTFLd0NmWUp5dDI4REJLQ3ZhV0ZTYkNsK2R6TmNaOUI4M2t2XCIsXCJlcGhlbWVyYWxQdWJsaWNLZXlcIjpcIkJGVWp1NzMvSVQvS3FuQi9uYzBXM0JhTDNCWEZ5YnJiWWFQaU1DS1hJY2c3OFBic2x3VjdNUlVxM1NwV0VERUpUNnBha0xDdmYzNDQxMkhiREdDcHNhNFxcdTAwM2RcIixcInRhZ1wiOlwieEl1Q1VXQjJVNnlXRWZpZHNKcFFhYStsZVUva3FTNTIySkxPbnJuazQyZ1xcdTAwM2RcIn0iCn0K" } } } }, "Klarna - DIRECT": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "unique-reference-number-91011", "partialPayment": false, "amount": { "currency": "EUR", "value": 50000, "taxTotal": 500 }, "language": "en", "order": { "id": "order-id-123", "numberOfArticles": 1, "creationDate": "2025-02-07T15:30:00Z", "items": [ { "id": "12345", "sku": "ABCD1234", "name": "Wireless Headphones", "type": "physical", "quantity": 40, "grossPrice": 500, "quantityUnit": "unit", "description": "Premium noise-canceling wireless headphones with 20 hours of battery life.", "marketplaceSellerId": "seller123", "googleProductCategoryId": 123, "productInfo": { "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "MPN9876543210", "imageUrl": "https://example.com/product-image.jpg", "productUrl": "https://example.com/wireless-headphones" } } ] }, "billingAddress": { "streetName": "123 Main St", "streetNumber": "45", "city": "New York", "postalCode": "10001", "country": "USA", "addressLine2": "Apt 12B", "addressLine3": "Building C", "state": "NY" }, "shipping": { "address": { "firstName": "John", "lastName": "Doe", "streetName": "Main Street", "streetNumber": "123", "city": "New York", "postalCode": "10001", "country": "USA", "addressLine2": "Apt 4B", "addressLine3": "Building 12", "state": "NY" }, "type": "CLICK_AND_COLLECT" }, "browserInfo": { "ipAddress": "192.168.1.1" }, "customerInfo": { "merchantCustomerId": "customer-123" }, "paymentMethods": { "integrationType": "DIRECT", "type": "KLARNA", "klarna": { "layout": { "borderColor": "#FF9900", "borderColorSelected": "#FF9900", "detailsColor": "#FF9900", "borderRadius": "8px" }, "accountId": "test", "enhancedData": [ { "productCategory": "Test product category", "productName": "Test product name" } ], "description": "This is a test payment method for demonstration purposes.", "billingAgreementId": "1234567890asdf" } } } }, "Klarna - HOSTED": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "unique-reference-number-91011", "partialPayment": false, "amount": { "currency": "EUR", "value": 50000, "taxTotal": 500 }, "urls": { "return": "https://my.callback.url.com/success", "webhook": "https://my.callback.url.com/notify", "cancel": "https://my.callback.url.com/cancel" }, "language": "en", "order": { "id": "order-id-123", "numberOfArticles": 1, "creationDate": "2025-02-07T15:30:00Z", "items": [ { "id": "12345", "sku": "ABCD1234", "name": "Wireless Headphones", "type": "physical", "quantity": 2, "quantityUnit": "unit", "taxRate": 15, "netPrice": 5000, "grossPrice": 5750, "discountAmount": 500, "taxAmount": 750, "merchantData": "Special discount for VIP customers", "description": "Premium noise-canceling wireless headphones with 20 hours of battery life.", "marketplaceSellerId": "seller123", "lineNumber": 1, "merchantProductType": "Electronics", "googleProductCategory": "Electronics", "googleProductCategoryId": 123, "groupId": "group456", "taxCategory": "standard", "productInfo": { "brand": "TechAudio", "categories": [ "Headphones", "Electronics", "Audio" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "MPN9876543210", "imageUrl": "https://example.com/product-image.jpg", "productUrl": "https://example.com/wireless-headphones" } } ] }, "billingAddress": { "streetName": "123 Main St", "streetNumber": "45", "city": "New York", "postalCode": "10001", "country": "USA", "addressLine2": "Apt 12B", "addressLine3": "Building C", "state": "NY" }, "shipping": { "address": { "firstName": "John", "lastName": "Doe", "streetName": "Main Street", "streetNumber": "123", "city": "New York", "postalCode": "10001", "country": "USA", "addressLine2": "Apt 4B", "addressLine3": "Building 12", "state": "NY" }, "type": "CLICK_AND_COLLECT" }, "browserInfo": { "ipAddress": "192.168.1.1" }, "customerInfo": { "merchantCustomerId": "customer-123" }, "paymentMethods": { "integrationType": "HOSTED", "type": "KLARNA", "klarna": { "layout": { "showSubTotalDetail": "HIDE", "logoUrl": "https://example.com/klarna", "pageTitle": "Secure Payment with Klarna" }, "accountId": "test", "enhancedData": [ { "productCategory": "Test product category", "productName": "Test product name" } ], "description": "This is a test payment method for demonstration purposes." } } } }, "MbWay - HOSTED": { "value": { "transId": "unique-trans-id-20251016", "refNr": "unique-ref-nr-20251016", "amount": { "currency": "EUR", "value": 50000 }, "urls": { "return": "https://my.callback.url.com/success", "webhook": "https://my.callback.url.com/webhook", "cancel": "http://example.com/cancel" }, "language": "DE", "simulationMode": "Test MBWay payment", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2" }, "customerInfo": { "phone": { "countryCode": "+49", "number": "912345678" } }, "paymentMethods": { "integrationType": "HOSTED", "type": "MBWAY", "mbWay": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" } } } }, "Multibanco - HOSTED": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refnr": "6B29FC62-1069", "partialPayment": false, "amount": { "currency": "EUR", "value": 50000 }, "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/cancel", "webhook": "https://my.callback.url.com/webhook" }, "language": "DE", "channel": "ECOM", "metadata": { "userData": "my userData", "k1": "v1", "plain": "some plain text", "k2": "v2" }, "paymentMethods": { "integrationType": "HOSTED", "type": "MULTIBANCO", "multibanco": { "service": "products", "sellingPoint": "sp", "account": { "accountHolder": "John Doe" } } } } }, "PagBrasilPL - DIRECT": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 123, "currency": "BRL" }, "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/failure", "webhook": "https://my.callback.url.com/notify" }, "customerInfo": { "phone": { "countryCode": "47", "subscriberNumber": "1234567565" }, "firstName": "John", "lastName": "Doe", "email": "random@gmail.com", "taxId": "28476378696" }, "billingAddress": { "streetName": "Hartmanstr 7", "city": "Bamberg", "state": "RO", "postalCode": "54330355" }, "statementDescriptor": "chDescending", "expirationTime": "2026-05-06", "paymentMethods": { "type": "PagBrasilPL", "integrationType": "DIRECT", "pagBrasilPl": { "payType": [ "C", "D" ], "productName": "Test product" } } } }, "PayPal - DIRECT": { "value": { "transId": "20230511-081056-103", "refNr": "RefNr20230511003", "partialPayment": false, "amount": { "value": 12345, "currency": "EUR", "taxTotal": 0, "netItemTotal": 0, "netShippingAmount": 0 }, "order": { "id": "order-id-123", "numberOfArticles": 1, "creationDate": "2025-02-07T15:30:00Z", "items": [ { "id": "12345", "sku": "ABCD1234", "name": "Wireless Headphones", "quantity": 2, "taxRate": 15, "netPrice": 5000, "description": "Premium noise-canceling wireless headphones with 20 hours of battery life." } ] }, "language": "en", "captureMethod": { "type": "AUTOMATIC" }, "billingAddress": { "streetName": "123 Main St", "streetNumber": "45", "city": "New York", "postalCode": "10001", "country": "US", "addressLine2": "Apt 12B", "addressLine3": "Building C", "state": "NY" }, "paymentMethods": { "integrationType": "DIRECT", "type": "PAYPAL", "payPal": { "accountId": "Your Paypal account ID", "hideAddress": true } } } }, "UnionPay - HOSTED": { "value": { "transId": "unique-trans-id-20251016", "refNr": "unique-ref-nr-20251016", "amount": { "currency": "EUR", "value": 50000 }, "urls": { "return": "https://my.callback.url.com/success", "webhook": "https://my.callback.url.com/webhook" }, "language": "DE", "simulationMode": "Test UnionPay payment", "paymentMethods": { "integrationType": "HOSTED", "type": "UNIONPAY", "unionPay": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" } } } }, "WeChat - HOSTED": { "value": { "transId": "unique-trans-id-20251016", "refNr": "unique-ref-nr-20251016", "amount": { "currency": "EUR", "value": 50000 }, "urls": { "return": "https://my.callback.url.com/success", "webhook": "https://my.callback.url.com/webhook" }, "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2" }, "billingAddress": { "country": "DEU" }, "language": "DE", "simulationMode": "Test WeChat payment", "paymentMethods": { "integrationType": "HOSTED", "type": "WECHAT", "weChat": { "account": { "accountHolderName": "John Doe" }, "sellingPoint": "Some selling point", "service": "Some service" } } } }, "Wero - HOSTED": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "partialPayment": false, "amount": { "currency": "EUR", "value": 10000 }, "simulationMode": "Test WERO payment", "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/cancel", "webhook": "https://my.callback.url.com/notify" }, "order": { "description": "Order description", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical" } ] }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "addressLine2": "Siechenstr. 61", "city": "Bamberg", "country": "DEU", "postalCode": "96050", "state": "BY" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "addressLine2": "Feldkirchenstr. 21", "city": "Bamberg", "country": "DEU", "postalCode": "96050", "state": "BY" } }, "statementDescriptor": "gadgets shop there was a validation for this kvp parameter that it must be a maximum length of 35 characters", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" } }, "paymentMethods": { "integrationType": "HOSTED", "type": "WERO", "wero": { "walletId": "test_wallet_id" } } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentDirectResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "paymentMethods": { "card": { "pseudoCardNumber": "0723219245645111", "expiryDate": "202506", "brand": "VISA", "source": "CREDIT", "issuer": "JPMORGAN CHASE BANK, N.A.", "country": "US", "bin": { "accountBin": "411111" }, "versioningData": { "threeDSServerTransId": "14dd844c-b0fc-4dfe-8635-366fbf43468c", "acsStartProtocolVersion": "2.1.0", "acsEndProtocolVersion": "2.1.0", "dsStartProtocolVersion": "2.1.0", "dsEndProtocolVersion": "2.1.0", "threeDSMethodUrl": "https://paymentpage.axepta.bnpparibas/acs/3ds-method", "threeDSMethodDataForm": "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly93d3cuY29tcHV0b3AtcGF5Z2F0ZS5jb20vY2JUaHJlZURTLmFzcHg_YWN0aW9uPW10aGROdGZuIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIxNGRkODQ0Yy1iMGZjLTRkZmUtODYzNS0zNjZmYmY0MzQ2OGMifQ==", "threeDSMethodData": { "threeDSMethodNotificationUrl": "https://paymentpage.axepta.bnpparibas/cbThreeDS.aspx?action=mthdNtfn", "threeDSServerTransId": "14dd844c-b0fc-4dfe-8635-366fbf43468c" } }, "providerApprovalCode": "20000000", "providerResponseCode": "201", "providerResponseMessage": "SUCCESS" } } } }, "GooglePay": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6C21FC4093DD0108765", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "customerInfo": { "merchantCustomerId": "XXX123" }, "metadata": { "userData": "some user data" }, "paymentMethods": { "googlePay": { "schemeReferenceId": "6C21FC4093DD0105678" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "klarna": { "accessToken": "2738598h48t672909th", "providerResponseCode": "201", "provideResponseText": "success" } } } }, "PayPal": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "payPal": { "orderId": "pay-pal-order-id-123" } } } } } } }, "links": { "self": { "operationId": "getPaymentStatusById", "parameters": { "paymentId": ".body#/id" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentHostedResponse" }, "examples": { "Test Environment": { "value": { "_links": { "redirect": { "href": "https://test.paymentpage.axepta.bnpparibas?token=ce0aef1079d84c5082b3013ee6f9e1fe", "type": "text/html" } } } }, "Live Environment": { "value": { "_links": { "redirect": { "href": "https://paymentpage.axepta.bnpparibas?token=ce0aef1079d84c5082b3013ee6f9e1fe", "type": "text/html" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentErrorResponse" }, "examples": { "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "card": { "providerResponseCode": "05", "providerResponseMessage": "Do not honor", "issuerResponseCode": "2001", "issuerResponseMessage": "Insufficient funds" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "ratepay": { "providerResponseCode": "101", "providerResponseText": "The transaction was declined due to insufficient funds in the account." } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}/confirms": { "post": { "tags": [ "Payments" ], "summary": "Confirm payment", "description": "This endpoint is used for payment methods that require a multi-step payment flow. It allows you to confirm a previously created payment instance (initiated via the Create Payment endpoint) to complete the transaction. This step is essential for certain payment methods to finalize the payment process.", "operationId": "confirmPayment", "parameters": [ { "name": "id", "in": "path", "description": "PayId assigned by Axepta Online in the initial request", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Confirm payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmRequest" }, "examples": { "Card": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432", "captureMethod": { "type": "AUTOMATIC" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "paymentMethods": { "card": { "eventToken": "ORDER" } } } }, "Klarna": { "value": { "transId": "some-trans-id", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "some-ref-nr", "order": { "id": "order-1-id", "items": [ { "name": "item-1", "quantity": 1, "netPrice": 5000, "taxRate": 0 }, { "name": "item-2", "quantity": 1, "netPrice": 5000, "taxRate": 0 } ] }, "billingAddress": { "streetName": "test", "streetNumber": "22", "postalCode": "10115", "country": "DE" }, "shipping": { "address": { "country": "NL" } }, "paymentMethods": { "klarna": { "accessToken": "some-access-token" } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmResponse" }, "examples": { "Default": { "value": { "merchantId": "merchant-test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "ApplePay": { "value": { "merchantId": "merchant-test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "customerInfo": { "merchantCustomerId": "XXX123" } } }, "Card": { "value": { "merchantId": "merchant-test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" } } }, "GooglePay": { "value": { "merchantId": "merchant-test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "customerInfo": { "merchantCustomerId": "XXX123" } } }, "Klarna": { "value": { "merchantId": "merchant-test", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-br", "paymentMethods": { "klarna": { "providerTransactionId": "klarna-transaction-id", "billingAgreementId": "klarna-billing-id", "redirectUrl": "https://redirect-url.com", "providerResponseCode": "200", "providerResponseText": "Operation successful" } } } }, "PayPal": { "value": { "merchantId": "merchant-test", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-br", "paymentMethods": { "payPal": { "providerResponseCode": "200" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmErrorResponse" }, "examples": { "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "klarna": { "providerResponseCode": "101", "providerResponseText": "The transaction was declined due to insufficient funds in the account." } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}/incrementals": { "post": { "tags": [ "Payments" ], "summary": "Incremental authorization", "description": "This endpoint allows you to increase the authorized amount for an existing card transaction when the initial authorization is insufficient. The additional amount is appended to the original authorization, and the total authorized amount reflects both.", "operationId": "incrementAuthorization", "parameters": [ { "name": "id", "in": "path", "description": "payId assigned by Axepta Online in the initial request.", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Increase amount of existing authorization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incrementalRequest" }, "examples": { "Default": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "duration": 10 } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incrementalResponse" }, "examples": { "Default": { "value": { "merchantId": "test-merchant", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-nr" } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incrementalErrorResponse" } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}/reversals": { "post": { "tags": [ "Payments" ], "summary": "Reverse payment", "description": "This endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization.", "operationId": "reversePayment", "parameters": [ { "name": "id", "in": "path", "description": "payId assigned by Axepta Online in the initial request", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Reverse existing payment that has not been Captured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reversalRequest" }, "examples": { "Default": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432" } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reversalResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Card": { "value": { "merchantId": "test-merchant", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-nr", "paymentMethods": { "card": { "providerResponseCode": "200", "providerTransactionId": "some-clearhaus-transaction-id", "providerApprovalCode": "some-approval-code" } } } }, "Klarna": { "value": { "merchantId": "test-merchant", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-nr", "paymentMethods": { "klarna": { "providerResponseCode": "200", "providerResponseText": "Operation successful" } } } }, "PayPal": { "value": { "merchantId": "test-merchant", "payId": "some-pay-id", "xId": "some-x-id", "transId": "some-trans-id", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "some-ref-nr", "paymentMethods": { "payPal": { "providerResponseCode": "200" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reversalErrorResponse" }, "examples": { "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "card": { "providerResponseCode": "51", "providerResponseText": "Invalid card number" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "ratepay": { "providerResponseCode": "101", "providerResponseText": "The transaction was declined due to insufficient funds in the account." } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}/captures": { "post": { "tags": [ "Payments" ], "summary": "Capture payment", "description": "This endpoint is used to capture an existing authorized payment.", "operationId": "capturePayment", "parameters": [ { "name": "id", "in": "path", "description": "PayId assigned by Axepta Online in the initial request.", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Capture existing authorized payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/captureRequest" }, "examples": { "Default": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432", "statementDescriptor": "gadgets shop", "captureMethod": { "manual": { "currentSequence": 1, "final": false, "total": 3 } } } }, "Card": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432", "statementDescriptor": "gadgets shop", "captureMethod": { "manual": { "currentSequence": 1, "final": false, "total": 3 } }, "paymentMethods": { "card": { "finishAuth": true } } } }, "Klarna": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 1200, "currency": "EUR" }, "refNr": "6B29FC40-1067-B31D", "statementDescriptor": "Purchase at ABC Store", "captureMethod": { "manual": { "currentSequence": 1, "final": false, "total": 3 } }, "paymentMethods": { "klarna": { "completeType": "yes", "shippingInfo": { "shippingCompany": "17postservice", "shippingMethod": "Home", "trackingId": "63456415674545679074", "trackingUrl": "https://shipping.example/findmypackage?63456415674545679074", "returnShippingCompany": "aaa-cooper", "returnTrackingId": "93456415674545679000", "returnTrackingUrl": "https://shipping.example/findmypackage?93456415674545679000" } } } } }, "PayPal": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 1200, "currency": "EUR" }, "refNr": "6B29FC40-1067-B31D", "statementDescriptor": "Purchase at ABC Store", "captureMethod": { "manual": { "currentSequence": 1, "final": false, "total": 3 } }, "paymentMethods": { "payPal": { "completeType": true } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/captureResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "card": { "providerResponseCode": "SC123", "providerResponseText": "Payment successfully processed.", "providerTransactionId": "CLEAR12345", "providerApprovalCode": 987654321 } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "klarna": { "providerResponseCode": "200", "providerResponseText": "Payment successfully processed.", "invoiceNumber": "KL-INV-987654321" } } } }, "PayPal": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "payPal": { "providerResponseCode": 200, "providerTransactionId": "PAYPALCAPTURE123456789" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/captureErrorResponse" }, "examples": { "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "card": { "providerResponseCode": "51", "providerResponseText": "Invalid card number" } } } }, "PayPal": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "payPal": { "providerResponseCode": "05" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "ratepay": { "providerResponseCode": "101", "providerResponseText": "The transaction was declined due to insufficient funds in the account." } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}/refunds": { "post": { "tags": [ "Payments" ], "summary": "Refund payment with reference", "description": "This endpoint is used to refund a captured payment.", "operationId": "refundPayment", "parameters": [ { "name": "id", "in": "path", "description": "PayId assigned by Axepta Online in the initial request.", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Refund a payment that has been captured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refundRequest" }, "examples": { "Default": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432", "statementDescriptor": "gadget shop" } }, "Card": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 10000, "currency": "EUR" }, "refNr": "24235345432", "statementDescriptor": "gadget shop", "paymentMethods": { "card": { "providerTransactionId": "745638292011384" } } } }, "PayPal": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 1200, "currency": "EUR" }, "refNr": "6B29FC40-1067-B31D", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "statementDescriptor": "Example Store Purchase", "paymentMethods": { "payPal": { "providerTransactionId": "PAYPAL1234567890" } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refundResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "card": { "providerResponseCode": "200", "providerResponseText": "Transaction successfully synchronized.", "providerTransactionId": "CLEARHAUS987654321" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "klarna": { "providerResponseCode": "200", "providerResponseText": "Payment successfully authorized.", "invoiceNumber": "INV123456789" } } } }, "PayPal": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "payPal": { "providerResponseCode": "200", "feeRefundAmount": 5.23, "grossRefundAmount": 50.11, "netRefundAmount": 45.4 } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refundErrorResponse" }, "examples": { "Bizum": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Action could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "bizum": { "providerResponseText": "Invalid account number" } } } }, "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "card": { "providerResponseCode": "51", "providerResponseText": "Invalid card number" } } } }, "EPS": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Action could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "eps": { "providerResponseText": "Invalid account number" } } } }, "PayPal": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "payPal": { "providerResponseCode": "05" } } } }, "Klarna": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "ratepay": { "providerResponseCode": "101", "providerResponseText": "The transaction was declined due to insufficient funds in the account." } } } }, "UnionPay": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Action could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "unionPay": { "providerResponseText": "Invalid account number" } } } }, "WeChat": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Action could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "weChat": { "providerResponseText": "Invalid account number" } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/refunds": { "post": { "tags": [ "Payments" ], "summary": "Refund payment without reference", "description": "This endpoint is used to refund a payment without reference.", "operationId": "refundExternalPayment", "requestBody": { "description": "Refund the payment that was not processed through Axepta Online", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creditExRequest" }, "examples": { "Card": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "refNr": "24235345432", "amount": { "value": 10000, "currency": "EUR" }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "statementDescriptor": "gadgets shop", "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "123654789" }, "birthDate": "2001-01-01" }, "browserInfo": { "acceptHeaders": "application/json, text/javascript, */*; q=0.01", "ipAddress": "192.168.1.1", "sessionId": "session1234567890" }, "paymentMethods": { "card": { "number": "4242424242424242", "cardholderName": "Max Mustermann", "expiryDate": "202701", "brand": "VISA", "securityCode": "123" } } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creditExResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "trans-id-123", "status": "OK", "responseCode": 200, "responseDescription": "success", "refNr": "6729FC4093DA010662DA", "metadata": { "k1": "v1", "userData": "my user data", "k2": "v2", "plain": "some plain text", "k3": "v3" }, "paymentMethods": { "card": { "providerResponseCode": "APPROVED", "providerResponseText": "Transaction successfully synchronized.", "providerTransactionId": "CH1234567890XYZ", "providerApprovalCode": 200 } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creditExErrorResponse" }, "examples": { "Card": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "FAILED", "responseCode": "422", "responseDescription": "Payment could not be processed.", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "card": { "providerResponseCode": "51", "providerResponseText": "Invalid card number" } } } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/getByPayId/{id}": { "get": { "tags": [ "Payments" ], "summary": "Retrieve payment details by Payment ID", "description": "Returns all details about existing payment.", "operationId": "getPaymentDetailsByPaymentId", "parameters": [ { "name": "id", "in": "path", "description": "ID of payment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentDetailsResponse" }, "examples": { "Card": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "CARD", "card": { "cardholderName": "John Doe", "pseudoCardNumber": "1234567890123456", "cardholderConsentToStore": true, "first6Digits": "123456", "last4Digits": "7890", "expiryDate": "01.01.2025", "brand": "visa", "product": "Business Premium Debit", "source": "CREDIT", "type": "Gold", "issuer": "Bank of Example", "country": "US", "bin": { "accountBin": "123456", "accountRangeLow": "100000", "accountRangeHigh": "999999" }, "versioningData": { "threeDSServerTransId": "server12345", "acsStartProtocolVersion": "1.0", "acsEndProtocolVersion": "2.1", "dsStartProtocolVersion": "1.0", "dsEndProtocolVersion": "2.1", "threeDSMethodDataForm": "POST", "threeDSMethodUrl": "https://method-url.com", "threeDSMethodData": { "threeDSMethodNotificationUrl": "https://notification-url.com", "threeDSServerTransId": "server12345" } }, "fraudData": { "zone": "US", "ipZone": "US", "ipZoneA2": "US", "ipState": "California", "ipCity": "San Francisco", "ipLongitude": "-122.4194", "ipLatitude": "37.7749", "fsStatus": "ACCEPT", "fsCode": "<0100>" }, "authenticationData": { "threeDSServerTransId": "server12345", "acsChallengeMandated": true, "acsDecConInd": false, "acsOperatorId": "operator123", "acsReferenceNumber": "ref12345", "acsRenderingType": { "acsInterface": "HTML", "acsUiTemplate": "template1" }, "acsSignedContent": "signedContentData", "acsTransId": "acsTrans123", "acsURL": "https://acs-url.com", "authenticationType": "3DS2", "authenticationValue": "authValue123", "broadInfo": "info", "cardholderInfo": "holder123", "dsReferenceNumber": "dsRef123", "dsTransId": "dsTrans123", "eci": "05", "messageExtension": "extensionData", "messageType": "Request", "messageVersion": "2.1", "sdkTransId": "sdkTrans123", "transStatus": "Success", "transStatusReason": "Transaction approved", "whiteListStatus": "Approved", "whiteListStatusSource": "Issuer", "challengeRequest": { "threeDSServerTransId": "server12345", "acsTransId": "acsTrans123", "challengeWindowSize": "04", "messageVersion": "2.1", "messageType": "Challenge" }, "base64EncodedChallengeRequest": "encodedData", "threeDSCompInd": "Y" }, "schemeReferenceId": "xyz123456", "providerApprovalCode": "APPROVED123", "providerResponseCode": "00", "providerResponseMessage": "Transaction approved", "providerTransactionId": "txn123456789", "providerToken": "token123456", "providerMerchantId": "merchant123", "providerTerminalId": "terminal123", "providerOrderId": "order123456", "issuerResponseCode": "00", "issuerResponseMessage": "Success", "dccInfo": { "dccSelected": true, "provider": "Nets", "rate": { "exchangeRate": 1.2313, "markupPercentage": 3.5, "timestamp": "20241129" }, "amounts": { "merchant": { "value": 10000, "currency": "EUR" }, "cardholder": { "value": 12313, "currency": "USD", "decimalValue": 123.13 } } } } } } }, "Bizum": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "paymentMethods": { "type": "BIZUM", "bizum": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "bankName": "Example Bank", "accountHolderIdentification": "ES12345678A", "accountNumber": "ES9121000418450200051332", "code": "COBADEFFXXX" }, "paymentGuarantee": "VALIDATED", "providerTransactionId": "bizum-transaction-id-20251016" } } } }, "EPS": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "paymentMethods": { "type": "EPS", "eps": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "code": "COBADEFFXXX" }, "paymentGuarantee": "VALIDATED", "providerTransactionId": "eps-transaction-id-20251016" } } } }, "GooglePay": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "customerInfo": { "merchantCustomerId": "XXX123" }, "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "GOOGLEPAY", "googlePay": { "schemeReferenceId": "abc123xyz456" } } } }, "Ideal": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103121913554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "IDEAL", "ideal": { "account": { "bankName": "Sample Bank", "accountHolderName": "John Doe", "number": "NL20INGB0001234567", "code": "INGBNL2A", "paymentGuarantee": "VALIDATED" }, "paymentPurpose": "Payment for Online Shopping", "providerResponseText": "Transaction Successful", "providerTransactionId": "trans1234567890" } } } }, "Klarna": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "KLARNA", "klarna": { "providerResponseCode": "200", "providerResponseText": "Transaction successful", "providerToken": "consumerToken12345", "providerTransactionId": "klarnaRef123456" } } } }, "MbWay": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "MBWAY", "mbWay": { "account": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Goods and services", "providerTransactionId": "mbWay-transaction-id-20251016" } } } } }, "PayPal": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "PAYPAL", "payPal": { "orderId": "PAY123456789", "providerResponseCode": "200", "payerStatus": "VERIFIED", "infoText": "Transaction successful", "payerId": "A1B2C3D4E5F6", "grossAmount": "100.00", "feeAmount": "2.50", "settleAmount": "97.50", "taxAmount": "5.00", "exchangeRate": "1.12", "mcFee": "2.50", "mcGross": "102.50", "providerCaptureId": "CAPTURE123456789" } } } }, "UnionPay": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "UNIONPAY", "unionPay": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Invoice payment", "providerTransactionId": "unionPay-transaction-id-20251016" } } } }, "Wero": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "type": "WERO", "wero": { "walletId": "WALLET_987654321", "payplan": "payplan_test", "consentId": "AMB-1058479328", "paymentId": "AMB-1058479328", "captureId": "XXZ-7947204730", "refundId": "PTL-64927490573" } } } }, "WeChat": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "WECHAT", "weChat": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Goods and services", "providerTransactionId": "weChat-transaction-id-20251016" } } } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Payment not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentNotFoundResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "00000000000000000000000000000000", "xId": "", "transId": "ed7773c09f314c45b2a0de47a1994e1d", "refNr": "", "status": "FAILED", "responseCode": "20600061", "responseDescription": "PAYMENT NOT FOUND" } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/getByTransId/{id}": { "get": { "tags": [ "Payments" ], "summary": "Retrieve payment details by Transaction ID", "description": "This endpoint is used to retrieve payment details with the Transaction ID (transId).", "operationId": "getPaymentDetailsByTransactionId", "parameters": [ { "name": "id", "in": "path", "description": "ID of transaction", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentDetailsResponse" }, "examples": { "Card": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "CARD", "card": { "cardholderName": "John Doe", "pseudoCardNumber": "1234567890123456", "cardholderConsentToStore": true, "first6Digits": "123456", "last4Digits": "7890", "expiryDate": "01.01.2025", "brand": "visa", "product": "Business Premium Debit", "source": "CREDIT", "type": "Gold", "issuer": "Bank of Example", "country": "US", "bin": { "accountBin": "123456", "accountRangeLow": "100000", "accountRangeHigh": "999999" }, "versioningData": { "threeDSServerTransId": "server12345", "acsStartProtocolVersion": "1.0", "acsEndProtocolVersion": "2.1", "dsStartProtocolVersion": "1.0", "dsEndProtocolVersion": "2.1", "threeDSMethodDataForm": "POST", "threeDSMethodUrl": "https://method-url.com", "threeDSMethodData": { "threeDSMethodNotificationUrl": "https://notification-url.com", "threeDSServerTransId": "server12345" } }, "fraudData": { "zone": "US", "ipZone": "US", "ipZoneA2": "US", "ipState": "California", "ipCity": "San Francisco", "ipLongitude": "-122.4194", "ipLatitude": "37.7749", "fsStatus": "ACCEPT", "fsCode": "<0100>" }, "authenticationData": { "threeDSServerTransId": "server12345", "acsChallengeMandated": true, "acsDecConInd": false, "acsOperatorId": "operator123", "acsReferenceNumber": "ref12345", "acsRenderingType": { "acsInterface": "HTML", "acsUiTemplate": "template1" }, "acsSignedContent": "signedContentData", "acsTransId": "acsTrans123", "acsURL": "https://acs-url.com", "authenticationType": "3DS2", "authenticationValue": "authValue123", "broadInfo": "info", "cardholderInfo": "holder123", "dsReferenceNumber": "dsRef123", "dsTransId": "dsTrans123", "eci": "05", "messageExtension": "extensionData", "messageType": "Request", "messageVersion": "2.1", "sdkTransId": "sdkTrans123", "transStatus": "Success", "transStatusReason": "Transaction approved", "whiteListStatus": "Approved", "whiteListStatusSource": "Issuer", "challengeRequest": { "threeDSServerTransId": "server12345", "acsTransId": "acsTrans123", "challengeWindowSize": "04", "messageVersion": "2.1", "messageType": "Challenge" }, "base64EncodedChallengeRequest": "encodedData", "threeDSCompInd": "Y" }, "schemeReferenceId": "xyz123456", "providerApprovalCode": "APPROVED123", "providerResponseCode": "00", "providerResponseMessage": "Transaction approved", "providerTransactionId": "txn123456789", "providerToken": "token123456", "providerMerchantId": "merchant123", "providerTerminalId": "terminal123", "providerOrderId": "order123456", "issuerResponseCode": "00", "issuerResponseMessage": "Success", "dccInfo": { "dccSelected": true, "provider": "Nets", "rate": { "exchangeRate": 1.2313, "markupPercentage": 3.5, "timestamp": "20241129" }, "amounts": { "merchant": { "value": 10000, "currency": "EUR" }, "cardholder": { "value": 12313, "currency": "USD", "decimalValue": 123.13 } } } } } } }, "Bizum": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "paymentMethods": { "type": "BIZUM", "bizum": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "bankName": "Example Bank", "accountHolderIdentification": "ES12345678A", "accountNumber": "ES9121000418450200051332", "code": "COBADEFFXXX" }, "paymentGuarantee": "VALIDATED", "providerTransactionId": "bizum-transaction-id-20251016" } } } }, "EPS": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "paymentMethods": { "type": "EPS", "eps": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "code": "COBADEFFXXX" }, "paymentGuarantee": "VALIDATED", "providerTransactionId": "eps-transaction-id-20251016" } } } }, "GooglePay": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "order": { "invoiceId": "ABC123", "merchantReference": "XYZ123" }, "customerInfo": { "merchantCustomerId": "XXX123" }, "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "GOOGLEPAY", "googlePay": { "schemeReferenceId": "abc123xyz456" } } } }, "Ideal": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103121913554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "IDEAL", "ideal": { "account": { "bankName": "Sample Bank", "accountHolderName": "John Doe", "number": "NL20INGB0001234567", "code": "INGBNL2A", "paymentGuarantee": "VALIDATED" }, "paymentPurpose": "Payment for Online Shopping", "providerResponseText": "Transaction Successful", "providerTransactionId": "trans1234567890" } } } }, "Klarna": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "KLARNA", "klarna": { "providerResponseCode": "200", "providerResponseText": "Transaction successful", "providerToken": "consumerToken12345", "providerTransactionId": "klarnaRef123456" } } } }, "MbWay": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "MBWAY", "mbWay": { "account": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Goods and services", "providerTransactionId": "mbWay-transaction-id-20251016" } } } } }, "PayPal": { "value": { "amount": { "currency": "EUR", "value": 1000 }, "externalIntegrationId": "12345-abcde-67890-fghij", "language": "en", "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "PAYPAL", "payPal": { "orderId": "PAY123456789", "providerResponseCode": "200", "payerStatus": "VERIFIED", "infoText": "Transaction successful", "payerId": "A1B2C3D4E5F6", "grossAmount": "100.00", "feeAmount": "2.50", "settleAmount": "97.50", "taxAmount": "5.00", "exchangeRate": "1.12", "mcFee": "2.50", "mcGross": "102.50", "providerCaptureId": "CAPTURE123456789" } } } }, "UnionPay": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "UNIONPAY", "unionPay": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Invoice payment", "providerTransactionId": "unionPay-transaction-id-20251016" } } } }, "Wero": { "value": { "merchantId": "MerchantIdTest", "payId": "6B29FC4093DD010662DE", "xId": "6B29FC4093DD010662DB", "transId": "6B29FC4093DD010662DC", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "6C21FC4093DD0108765", "paymentMethods": { "type": "WERO", "wero": { "walletId": "WALLET_987654321", "payplan": "payplan_test", "consentId": "AMB-1058479328", "paymentId": "AMB-1058479328", "captureId": "XXZ-7947204730", "refundId": "PTL-64927490573" } } } }, "WeChat": { "value": { "payId": "ed7773c09f314c45b2a0de47a1994e1d", "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca", "transId": "20240103-121913-554", "merchantId": "MerchantIdTest", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "refNr": "refNr01", "metadata": { "userData": "my user data", "plain": "some plain text", "key1": "value1", "key2": "value2" }, "paymentMethods": { "type": "WECHAT", "weChat": { "paymentGuarantee": "VALIDATED", "paymentPurpose": "Goods and services", "providerTransactionId": "weChat-transaction-id-20251016" } } } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Payment not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentNotFoundResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "00000000000000000000000000000000", "xId": "", "transId": "ed7773c09f314c45b2a0de47a1994e1d", "refNr": "", "status": "FAILED", "responseCode": "20600061", "responseDescription": "PAYMENT NOT FOUND" } } } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/{id}": { "patch": { "tags": [ "Payments" ], "summary": "Update payment details", "description": "Update details about existing payment.", "operationId": "updatePaymentDetails", "parameters": [ { "name": "id", "in": "path", "description": "PayId assigned by Axepta Online in the initial request.", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Update the details of an existing payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateRequest" }, "examples": { "Default": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 1000, "currency": "USD" }, "refNr": "unique-reference-number-91011", "billingAddress": { "streetName": "Main St", "streetNumber": "123", "city": "New York", "postalCode": "10001", "country": "USA", "addressLine2": "Suite 4B", "addressLine3": "Building 12", "state": "NY" }, "shipping": { "address": { "streetName": "Park Ave", "streetNumber": "456", "city": "New York", "postalCode": "10002", "country": "USA", "addressLine2": "Apt 7C", "addressLine3": "Apt 4B", "state": "NY" }, "type": "CLICK_AND_COLLECT" }, "eventToken": "UPDATE_ORDER_DETAILS" } }, "Klarna": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "amount": { "value": 1000, "currency": "USD" }, "refNr": "unique-reference-number-91011", "shipping": { "address": { "streetName": "Park Ave", "streetNumber": "456", "city": "New York", "postalCode": "10002", "country": "USA", "addressLine2": "Apt 7C", "addressLine3": "Apt 4B", "state": "NY" }, "type": "CLICK_AND_COLLECT" }, "customerInfo": { "title": "Dr", "firstName": "Emily", "lastName": "Thompson", "companyName": "Thompson Health Solutions", "email": "test@gmail.com", "phone": { "countryCode": "49", "number": "321654789" } }, "eventToken": "UPDATE_ADDRESS" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateResponse" }, "examples": { "Default": { "value": { "merchantId": "CT_Logeecom_test", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" } }, "Klarna": { "value": { "payId": "1234567890abcdef", "merchantId": "merchant_987654321", "transId": "6B29FC40-1067-B31D-00DD010662DA", "xId": "xId_67890", "refNr": "ref_54321", "status": "AUTHORIZED", "responseDescription": "Transaction approved.", "responseCode": 200, "paymentMethods": { "klarna": { "providerResponseCode": "200", "providerResponseText": "Klarna payment approved." } } } }, "PayPal": { "value": { "payId": "1234567890abcdef", "merchantId": "merchant_987654321", "transId": "6B29FC40-1067-B31D-00DD010662DA", "xId": "xId_67890", "refNr": "ref_54321", "status": "AUTHORIZED", "responseDescription": "Transaction approved.", "responseCode": 200, "paymentMethods": { "payPal": { "providerResponseCode": 200 } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "404": { "description": "Payment not found" }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/payments/links": { "post": { "tags": [ "Payments" ], "summary": "Create payment link", "description": "This endpoint allows you to generate a payment link that can be shared with customers via email, SMS, or other channels. When customers click the link, they are redirected to a hosted payment page where they can select their preferred payment method and complete the transaction.", "operationId": "createPaymentLink", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Create payment link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createLinkRequest" }, "examples": { "Example": { "value": { "transId": "6B29FC40-1067-B31D-00DD010662DA", "partialPayment": false, "refNr": "24235345432", "amount": { "currency": "EUR", "value": 10000 }, "language": "de", "template": { "name": "hpp_template", "customFields": { "customField1": "Field 1 Data", "customField2": "Field 2 Data", "customField3": "Field 3 Data", "customField4": "Field 4 Data", "customField5": "Field 5 Data", "customField6": "Field 6 Data", "customField7": "Field 7 Data", "customField8": "Field 8 Data", "customField9": "Field 9 Data", "customField10": "Field 10 Data", "customField11": "Field 11 Data", "customField12": "Field 12 Data", "customField13": "Field 13 Data", "customField14": "Field 14 Data" } }, "captureMethod": { "type": "AUTOMATIC" }, "order": { "merchantReference": "112-445-34567", "numberOfArticles": 1, "creationDate": "2025-03-31T11:58:37Z", "invoiceId": "555-333-2222", "items": [ { "id": "1", "sku": "19-402-DEU", "name": "BatteryPowerPack", "quantity": 1, "quantityUnit": "pcs", "taxRate": 0, "netPrice": 1000, "grossPrice": 1000, "taxAmount": 0, "discountAmount": 0, "description": "BatteryPowerPack", "type": "physical", "productInfo": { "brand": "Intel", "categories": [ "Electronics Store", "Computers", "Desktops" ], "globalTradeItemNumber": "EAN", "manufacturerPartNumber": "BOXNUC5CPYA", "imageUrl": "https://www.exampleobjects.com/logo.png", "productUrl": "https://www.estore.com/products/f2a8d7e34" } } ] }, "urls": { "return": "https://my.callback.url.com/success", "cancel": "https://my.callback.url.com/cancel", "webhook": "https://my.callback.url.com/webhook" }, "billingAddress": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" }, "shipping": { "address": { "streetName": "Schwarzenbergstr", "streetNumber": "4", "city": "Bamberg", "country": "DEU", "postalCode": "96050" } }, "statementDescriptor": "gadgets shop", "customerInfo": { "merchantCustomerId": "cus_1234567890abcdef", "customerType": "individual", "firstName": "Max", "lastName": "Mustermann", "email": "customer@example.com", "phone": { "countryCode": "+49", "number": "1236547890" }, "salutation": "Ms", "title": "Dr", "gender": "female", "maidenName": "Mustermann", "middleName": "sam", "birthDate": "2001-01-01", "birthPlace": "Bamberg", "socialSecurityNumber": "123443534" }, "allowedPaymentMethods": [ "BANCONTACT", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "INSTANEA", "KLARNA", "MULTIBANCO", "MYBANK", "PAYPAL", "PRZELEWY24", "TRUSTLY", "TWINT", "VIPPSMOBILEPAY", "WERO" ], "paymentMethods": { "card": { "subType": [ "VISA", "MASTERCARD" ], "template": { "name": "card_template", "fontSize": 11, "textColor": "#FFFFFF", "customFields": { "customField1": "Field 1 Data", "customField2": "Field 2 Data", "customField3": "Field 3 Data", "customField4": "Field 4 Data", "customField5": "Field 5 Data", "customField6": "Field 6 Data", "customField7": "Field 7 Data", "customField8": "Field 8 Data", "customField9": "Field 9 Data", "customField10": "Field 10 Data", "customField11": "Field 11 Data", "customField12": "Field 12 Data", "customField13": "Field 13 Data", "customField14": "Field 14 Data" } } }, "klarna": { "layout": { "showSubTotalDetail": "HIDE", "logoUrl": "https://example.com/logo.svg", "pageTitle": "Secure Payment with Klarna" }, "accountId": "exmple_id", "enhancedData": [ { "productCategory": "Test product category", "productName": "Test product name" } ] }, "multibanco": { "sellingPoint": "sp", "account": { "accountHolder": "John Doe" } }, "payPal": { "accountId": "customer@example.com", "hideAddress": false }, "eps": { "account": { "accountHolderName": "John Doe", "number": "DE89370400440532013000", "code": "COBADEFFXXX" }, "optionDate": "2025-10-20", "sellingPoint": "Some selling point", "service": "Some service" } } } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createLinkResponse" }, "examples": { "Test Environment": { "value": { "merchantId": "CT_Logeecom_test", "payId": "5ebc6f6e883447d59662059ececc8602", "xId": "af67575bc93547cc8452dda13197a8cd", "transId": "202434533", "status": "REQUEST", "responseDescription": "REQUEST", "responseCode": "0", "url": "https://axepta-uat.link/oKsJu", "orderId": "4b709bb82d5741aebb432c8ad5ff9a76", "qrCode": "data:image/png;base64,", "_links": { "redirect": { "href": "https://test.paymentpage.axepta.bnpparibas?token=7186c6fbec6d43d3b1b731dff5497ffe", "type": "text/html" } } } }, "Live Environment": { "value": { "merchantId": "CT_Logeecom_test", "payId": "5ebc6f6e883447d59662059ececc8602", "xId": "af67575bc93547cc8452dda13197a8cd", "transId": "202434533", "status": "REQUEST", "responseDescription": "REQUEST", "responseCode": "0", "url": "https://axepta-uat.link/oKsJu", "orderId": "4b709bb82d5741aebb432c8ad5ff9a76", "qrCode": "data:image/png;base64,", "_links": { "redirect": { "href": "https://paymentpage.axepta.bnpparibas?token=7186c6fbec6d43d3b1b731dff5497ffe", "type": "text/html" } } } } } } } }, "400": { "description": "Bad request, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validationErrorResponse" } } } }, "422": { "description": "Unprocessable Entity, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorResponse" } } } }, "500": { "description": "Internal Server Error, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverErrorResponse" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/{merchantBasicWebhookUrl}": { "post": { "tags": [ "Webhooks" ], "summary": "Basic Webhook", "description": "The payload contains only the unique Axepta Online payId. The merchant can use this value to call the Retrieve payment details by payment ID endpoint to obtain full transaction details.\n\nSince no sensitive data is transmitted, no HMAC signature is used for this Webhook type.\n\nWhen the merchant receives a webhook, their endpoint must respond with an HTTP status code to acknowledge successful processing.", "requestBody": { "description": "This is a notification sent by Axepta Online about the final result of a payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestBasicWebhooks" }, "example": { "payId": "78f5adccfe8640e5a549613389ff33we" } } } }, "responses": { "2xx": { "description": "Successfully received and processed by merchant system" }, "4xx": { "description": "Delivery will be retried according to Axepta Online retry policy" }, "5xx": { "description": "Delivery will be retried according to Axepta Online retry policy" } } } }, "/{merchantEnhancedWebhookUrl}": { "post": { "tags": [ "Webhooks" ], "summary": "Enhanced Webhook", "description": "The Enhanced Webhook includes detailed transaction data in the payload and is signed with an HMAC signature to ensure authenticity and integrity.", "requestBody": { "description": "This is a notification sent by Axepta Online API about the final result of a payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestEnhancedWebhooks" }, "example": { "payId": "78f5adccfe8640e5a549613389ff33we", "transId": "txn_7890", "refNr": "45687", "status": "OK", "responseCode": "00000000", "responseDescription": "success", "amount": { "value": 10000, "currency": "EUR" }, "paymentMethods": [ { "type": "CARD" } ], "creationDate": "2025-09-23T13:20:30Z" } } } }, "responses": { "2xx": { "description": "Successfully received and processed by merchant system" }, "4xx": { "description": "Delivery will be retried according to Axepta Online retry policy" }, "5xx": { "description": "Delivery will be retried according to Axepta Online retry policy" } } } }, "/customers": { "get": { "tags": [ "Customers" ], "summary": "Get list of customers", "description": "Get list of customers", "operationId": "getCustomers", "parameters": [ { "name": "page", "in": "query", "description": "Specifies page number", "required": true, "schema": { "type": "number", "format": "int", "example": 2 } }, { "name": "createdFrom", "in": "query", "description": "The createdAt date from witch the customers will be fetched", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-05-12" } }, { "name": "createdTo", "in": "query", "description": "The createdAt date to witch the customers will be fetched", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-05-15" } }, { "name": "merchantCustomerId", "in": "query", "description": "The merchant customer id", "required": false, "schema": { "type": "string", "example": "Test_Merchant" } }, { "name": "email", "in": "query", "description": "The email address", "required": false, "schema": { "type": "string", "example": "test@gmail.com" } }, { "name": "phoneCountry", "in": "query", "description": "The phone country code", "required": false, "schema": { "type": "string", "example": "33" } }, { "name": "phoneNumber", "in": "query", "description": "The phone number", "required": false, "schema": { "type": "string", "example": "98746321" } } ], "responses": { "200": { "description": "Customers successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customersDetailsResponse" }, "example": { "totalNumberOfPages": 5, "totalNumberOfItems": 82, "page": 5, "pageSize": 20, "data": [ { "id": "cu_841b9b1a99fc4f0", "merchantCustomerId": "1234567890", "firstName": "Max", "lastName": "Mustermann", "email": "maxmustermann@example.com", "phone": { "countryCode": "33", "number": "234567890" }, "scope": "demo_parent", "createdAt": "2023-12-21T12:10:58.087", "updatedAt": "2024-10-01T12:10:58.087" }, { "id": "cu_841b9b1a99fc4f9", "merchantCustomerId": "1234567891", "firstName": "Jane", "lastName": "Doe", "email": "janedoe@example.com", "phone": { "countryCode": "33", "number": "234567889" }, "scope": "demo_parent", "createdAt": "2024-12-05T12:10:58.087", "updatedAt": "2025-05-08T12:10:58.087" } ] } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/customers/{id}": { "get": { "tags": [ "Customers" ], "summary": "Get customer details", "description": "Get customer details", "operationId": "getCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_841b9b1a99fc4f0" } } ], "responses": { "200": { "description": "Customer successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerDetailsResponse" }, "examples": { "Default": { "value": { "id": "cu_841b9b1a99fc4f0", "merchantCustomerId": "1234567890", "firstName": "Max", "lastName": "Mustermann", "email": "maxmustermann@example.com", "phone": { "countryCode": "33", "number": "234567890" }, "billingAddress": { "streetName": "Marienplatz 11A", "city": "Munich", "postalCode": "883433", "state": "Bavaria", "country": "deu" }, "scope": "demo_parent", "createdAt": "2023-12-21T12:10:58.087", "updatedAt": "2024-10-01T12:10:58.087", "lastUsedAt": "2024-10-15T12:10:58.087" } } } } } }, "400": { "description": "Invalid Customer Id supplied" }, "404": { "description": "Customer Details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "patch": { "tags": [ "Customers" ], "summary": "Update customer details", "description": "Updates details about customer", "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_841b9b1a99fc4f0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateCustomerRequest" }, "example": { "firstName": "Jane", "lastName": "Doe", "email": "janedoe@example.com", "phone": { "countryCode": "33", "number": "234567889" }, "billingAddress": { "streetName": "Marienplatz 55B", "city": "Munich", "postalCode": "883433", "state": "Bavaria", "country": "deu" } } } } }, "responses": { "200": { "description": "Customer successfully updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerDetailsResponse" }, "example": { "id": "cu_841b9b1a99fc4f0", "merchantCustomerId": "1234567890", "firstName": "Max", "lastName": "Mustermann", "email": "maxmustermann@example.com", "phone": { "countryCode": "33", "number": "234567890" }, "billingAddress": { "streetName": "Marienplatz 11A", "city": "Munich", "postalCode": "883433", "state": "Bavaria", "country": "deu" }, "scope": "demo_parent", "createdAt": "2023-12-21T12:10:58.087", "updatedAt": "2024-10-01T12:10:58.087", "lastUsedAt": "2024-10-15T12:10:58.087" } } } }, "400": { "description": "Invalid Customer Id supplied" }, "404": { "description": "Customer Details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer details", "description": "Delete customer details", "operationId": "deleteCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_841b9b1a99fc4f0" } } ], "responses": { "200": { "description": "Customer successfully deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteCustomerResponse" }, "example": { "id": "cu_841b9b1a99fc4f0", "deleted": true } } } }, "400": { "description": "Invalid Customer Id supplied" }, "404": { "description": "Customer Details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/customers/{id}/paymentMethods": { "get": { "tags": [ "Customers" ], "summary": "Get list of payment methods for customer", "description": "Get list of payment methods for customer", "operationId": "getPaymentMethods", "parameters": [ { "name": "id", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_841b9b1a99fc4f0" } } ], "responses": { "200": { "description": "Payment methods successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customersPaymentMethodsResponse" }, "example": { "gatewayCustomerId": "cu_841b9b1a99fc4f0", "data": [ { "id": "pm_5555b1a99fe4tg3", "type": "CARD", "last4Digits": "4242", "pseudoCardNumber": "0132332232424242", "cardHolderName": "Max Mustermann", "brand": "visa", "expiryDate": "202506", "createdAt": "2023-12-21T12:10:58.087", "updatedAt": "2024-10-01T12:10:58.087", "lastUsedAt": "2024-10-15T12:10:58.087" }, { "id": "pm_5555b1a99fe4tg4", "type": "CARD", "last4Digits": "1111", "pseudoCardNumber": "0132332235858582", "cardHolderName": "Max Mustermann", "brand": "mastercard", "expiryDate": "203006", "createdAt": "2023-12-22T12:10:58.087", "updatedAt": "2025-03-01T12:10:58.087", "lastUsedAt": "2025-05-15T12:10:58.087" } ] } } } }, "400": { "description": "Invalid Customer Id supplied" }, "404": { "description": "Customer Details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/customers/{customerId}/paymentMethods/{paymentMethodId}": { "get": { "tags": [ "Customers" ], "summary": "Get payment method details", "description": "Get payment method details", "operationId": "getPaymentMethod", "parameters": [ { "name": "customerId", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_96586bedjfe4tg3" } }, { "name": "paymentMethodId", "in": "path", "description": "Payment Method Id", "required": true, "schema": { "type": "string", "example": "pm_5555b1a99fe4tg3" } } ], "responses": { "200": { "description": "Payment Method successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethodsResponse" }, "example": { "id": "pm_5555b1a99fe4tg3", "type": "CARD", "last4Digits": "4242", "pseudoCardNumber": "0132332232424242", "cardHolderName": "Max Mustermann", "brand": "visa", "expiryDate": "202506", "createdAt": "2023-12-21T12:10:58.087", "updatedAt": "2024-10-01T12:10:58.087", "lastUsedAt": "2024-10-15T12:10:58.087" } } } }, "400": { "description": "Invalid Payment Method Id supplied" }, "404": { "description": "Payment method details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete payment method details", "description": "Delete payment method details", "operationId": "deletePaymentMethod", "parameters": [ { "name": "customerId", "in": "path", "description": "Customer Id", "required": true, "schema": { "type": "string", "example": "cu_96586bedjfe4tg3" } }, { "name": "paymentMethodId", "in": "path", "description": "Payment Method Id", "required": true, "schema": { "type": "string", "example": "pm_5555b1a99fe4tg3" } } ], "responses": { "200": { "description": "Payment Method successfully deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deletePaymentMethodResponse" }, "example": { "id": "pm_5555b1a99fe4tg3", "deleted": true } } } }, "400": { "description": "Invalid Payment Method Id supplied" }, "404": { "description": "Payment method details not found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "description": "You should use the token obtained from the /authorization/oauth/token endpoint.", "scheme": "bearer", "bearerFormat": "JWT" }, "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "authorizationRequest": { "type": "object", "title": "AuthorizationServiceRequest", "required": [ "client_id", "client_secret", "grant_type" ], "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials", "payment_intents" ], "description": "Possible values:\n - client_credentials: Pass this for all standard integrations.\n - payment_intents: Pass this if you are requesting a short lived OAuth token for payment intents. Applicable only for the mobile SDK integration" }, "client_id": { "type": "string", "description": "Client ID provided by Axepta Online. This is your merchant ID" }, "client_secret": { "type": "string", "description": "Client secret provided by Axepta Online. This is your API key" }, "payment_intent_id": { "type": "string" } } }, "authorizationResponse": { "type": "object", "title": "AuthorizationServiceResponse", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "enum": [ "bearer" ] }, "expires_in": { "type": "number", "description": "Token expiry time in seconds" } } }, "authorizationValidationErrorResponse": { "type": "object", "title": "ValidationErrorResponse", "properties": { "error": { "type": "string", "example": "Invalid payment_intent_id" } } }, "unauthorizedErrorResponse": { "type": "object", "title": "UnauthorizedResponse", "required": [ "client_id", "client_secret", "grant_type" ], "properties": { "error": { "type": "string", "example": "unsupported_grant_type" }, "error_description": { "type": "string", "example": "The specified 'grant_type' is not supported." }, "error_uri": { "type": "string", "example": "https://documentation.openiddict.com/errors/ID2032" } } }, "serverErrorResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "A specific identifier for the error cause" }, "responseDescription": { "type": "string", "example": "A brief message explaining the error" } } }, "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "value": { "type": "number", "description": "Total order amount in the smallest currency unit, including taxes, shipping costs, discounts, etc." }, "currency": { "type": "string", "description": "3-character ISO currency code." }, "taxTotal": { "type": "number", "description": "Total tax amount." }, "netItemTotal": { "type": "number", "description": "Total net amount of the products as part of the order, excluding shipping costs." }, "netShippingAmount": { "type": "number", "description": "Net shipping costs." }, "grossShippingAmount": { "type": "number", "description": "Gross shipping costs." }, "netDiscount": { "type": "number", "description": "Net discount amount." }, "grossDiscount": { "type": "number", "description": "Gross discount amount." } } }, "customFields": { "type": "object", "description": "Customizable fields that can store additional data or display specific information on the Hosted Payment Page template.", "properties": { "customField1": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField2": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField3": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField4": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField5": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField6": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField7": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField8": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField9": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField10": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField11": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField12": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField13": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField14": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." } } }, "template": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of template to customize the Hosted Payment Page." }, "customFields": { "$ref": "#/components/schemas/customFields" } } }, "captureMethod": { "title": "captureMethod", "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type of capture method being used.", "enum": [ "AUTOMATIC", "MANUAL", "DELAYED" ] }, "delayed": { "type": "object", "properties": { "delayedHours": { "description": "Defines the delay period, in hours, before an authorized payment is automatically captured. Required if type is delayed. Minimum: 1, maximum: 696", "type": "number", "minimum": 1, "maximum": 696 } } } } }, "credentialOnFile": { "title": "credentialOnFile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECURRING", "UNSCHEDULED", "INSTALLMENTS" ], "description": "Indicates the type of credential-on-file transaction." }, "initialPayment": { "type": "boolean", "description": "Specifies whether the transaction is the initial payment in a credential-on-file setup." }, "recurring": { "type": "object", "properties": { "useCase": { "type": "string", "description": "Describes the use case for the unscheduled transaction.", "enum": [ "FIXED", "FLEXIBLE_AMOUNT", "FLEXIBLE_FREQUENCY" ] }, "frequency": { "type": "string", "description": "Defines the frequency of recurring payments.", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "startDate": { "type": "string", "format": "date", "description": "The date when the recurring payment schedule begins in YYYY-MM-DD format." }, "expiryDate": { "type": "string", "format": "date", "description": "The date when the recurring payment schedule ends or expires in YYYY-MM-DD format." } } }, "unscheduled": { "type": "object", "properties": { "subType": { "type": "string", "description": "Specifies the sub-type of an unscheduled credential-on-file transaction.", "enum": [ "CIT", "MIT" ] } } }, "installments": { "type": "object", "properties": { "total": { "type": "number", "description": "Total number of installments for a purchase." }, "curIdx": { "type": "number", "description": "The index or sequence number of the current installment in the series." }, "purchaseAmount": { "type": "number", "description": "The total purchase amount being paid in installments." }, "frequency": { "type": "string", "description": "The frequency of installment payments, such as \"daily\", \"weekly\", \"monthly\", or \"yearly\".", "enum": [ "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "YEARLY" ] }, "expiryDate": { "type": "string", "format": "date", "description": "The date when the installment plan ends or expires in YYYY-MM-DD format." } } } } }, "productInfo": { "type": "object", "properties": { "brand": { "type": "string", "description": "The brand name associated with this product." }, "categories": { "type": "array", "description": "The product's category path as used in the your webshop", "items": { "type": "string" } }, "globalTradeItemNumber": { "type": "string", "description": "The product's Global Trade Item Number (GTIN).", "enum": [ "EAN", "ISBN", "UPC" ] }, "manufacturerPartNumber": { "type": "string", "description": "The product's Manufacturer Part Number (MPN), which - together with the brand - uniquely identifies a product. Only submit MPNs assigned by a manufacturer and use the most specific MPN possible." }, "imageUrl": { "type": "string", "format": "uri", "description": "A URL pointing to an image of this product." }, "productUrl": { "type": "string", "format": "uri", "description": "A URL linking to a detailed product page on the merchant's website." } } }, "order": { "type": "object", "properties": { "merchantReference": { "type": "string", "description": "A unique identifier for the order, assigned by your system." }, "numberOfArticles": { "type": "number", "description": "The total number of articles (items) included in the order." }, "description": { "type": "string", "description": "A short, description of the order (e.g. main product or order summary)." }, "creationDate": { "type": "string", "format": "date-time", "description": "The date and time when the order was created." }, "invoiceId": { "type": "string", "description": "ID of the invoice generated for the order." }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the specific item in the order." }, "sku": { "type": "string", "description": "The Stock Keeping Unit (SKU) of the item, used to uniquely identify the product within the merchant's inventory." }, "name": { "type": "string", "description": "The name or title of the item being purchased." }, "type": { "type": "string", "description": "The type of item, such as \"physical\", \"digital\", \"discount\", \"sales_tax\", \"shipping_fee\", \"discount\", \"gift_card\", \"store_credit\", etc." }, "quantity": { "type": "number", "description": "The quantity of this item being purchased in the order." }, "quantityUnit": { "type": "string", "description": "The unit of measurement for the quantity, such as \"pcs\", \"kg\", or \"liters\"." }, "taxRate": { "type": "number", "description": "The tax rate applied to this item. Percentage sign must be replaced with two zeros. For example: A tax rate of 25% should be sent as 2500." }, "netPrice": { "type": "number", "description": "The net price of a single unit of this item, excluding tax and discounts." }, "grossPrice": { "type": "number", "description": "The gross price of a single unit of this item, including taxes but excluding discounts." }, "discountAmount": { "type": "number", "description": "Discount amount applied to single unit of this item." }, "taxAmount": { "type": "number", "description": "Tax amount applied to single unit of this item." }, "merchantData": { "type": "string", "description": "Additional data or metadata provided by the merchant about this item." }, "description": { "type": "string", "description": "Detailed description of the item." }, "marketplaceSellerId": { "type": "string", "description": "An identifier for the seller in a marketplace context." }, "lineNumber": { "type": "number", "description": "A sequential line number assigned to this item in the order for reference purposes." }, "merchantProductType": { "type": "string", "description": "A classification or type assigned to this product by you." }, "googleProductCategory": { "type": "string", "description": "Indicates the category of the item based on the Google product taxonomy." }, "googleProductCategoryId": { "type": "number", "description": "Google product category ID." }, "groupId": { "type": "string", "description": "An identifier used to group related items together." }, "taxCategory": { "type": "string", "description": "Specifies the tax category applicable to this item." }, "additionalDescription": { "type": "string", "description": "Any additional descriptive information about this item not covered elsewhere." }, "productInfo": { "$ref": "#/components/schemas/productInfo" } } } } } }, "sessionUrls": { "type": "object", "required": [ "return", "cancel", "webhook" ], "properties": { "return": { "type": "string", "format": "uri", "description": "The URL to which the customer is redirected after successfully completing the payment process." }, "cancel": { "type": "string", "format": "uri", "description": "The URL to which the customer is redirected if they cancel the payment process before completion." }, "webhook": { "type": "string", "format": "uri", "description": "The URL endpoint on the merchant's server that receives asynchronous notifications about the outcome of the payment." }, "appRedirect": { "type": "string", "format": "uri", "description": "The URL used in Instanea payments to provide the merchant’s base app URL for redirection." } } }, "billingAddress": { "type": "object", "properties": { "streetName": { "type": "string", "description": "Street name of billing address." }, "streetNumber": { "type": "string", "description": "Street number of billing address." }, "addressLine2": { "type": "string", "description": "Address line 2 of billing address." }, "addressLine3": { "type": "string", "description": "Address line 3 of billing address." }, "city": { "type": "string", "description": "City of billing address." }, "state": { "type": "string", "description": "State of billing address." }, "country": { "type": "string", "description": "3 character ISO country code of billing address." }, "postalCode": { "type": "string", "description": "Postal code of billing address." } } }, "shippingAddress": { "type": "object", "title": "address", "properties": { "firstName": { "type": "string", "description": "Shipping first name." }, "lastName": { "type": "string", "description": "Shipping last name." }, "companyName": { "type": "string", "description": "Shipping company name. Applicable, when the entity where the goods are being delivered is a business entity." }, "streetName": { "type": "string", "description": "Shipping street." }, "streetNumber": { "type": "string", "description": "Shipping street number." }, "addressLine2": { "type": "string", "description": "Address line 2 of shipping address." }, "addressLine3": { "type": "string", "description": "Address line 3 of shipping address." }, "city": { "type": "string", "description": "Shipping city." }, "state": { "type": "string", "description": "State of shipping address." }, "country": { "type": "string", "description": "3 character ISO country code of shipping address." }, "postalCode": { "type": "string", "description": "Shipping postal code." }, "phone": { "type": "object", "description": "Phone number associated with the shipping address.", "properties": { "countryCode": { "type": "string", "description": "Country Code/Area code of the phone number." }, "number": { "type": "string", "description": "Phone number associated with the shipping address." } } } } }, "shippingAddressCreatePayment": { "type": "object", "title": "shipping", "properties": { "address": { "allOf": [ { "$ref": "#/components/schemas/shippingAddress" }, { "type": "object" } ] }, "type": { "type": "string", "description": "Shipping method." } } }, "customerInfo": { "type": "object", "description": "Information about the customer.", "required": [ "email" ], "properties": { "merchantCustomerId": { "type": "string", "description": "A unique identifier for the customer, assigned by the merchant's system." }, "customerType": { "type": "string", "description": "Specifies the type of customer, such as \"individual\" or \"business\"." }, "firstName": { "type": "string", "description": "First name of the customer." }, "lastName": { "type": "string", "description": "Last name (surname) of the customer." }, "email": { "type": "string", "description": "Email address of the customer." }, "phone": { "type": "object", "description": "Phone number of the customer.", "properties": { "countryCode": { "type": "string", "description": "Country Code/Area code of the phone number." }, "number": { "type": "string", "description": "Phone number of the customer." } } }, "salutation": { "type": "string", "description": "Salutation used to address the customer, such as \"Mr\", \"Mrs\", \"Miss \"." }, "title": { "type": "string", "description": "Any additional title or designation associated with the customer, such as \"Dr\", etc." }, "gender": { "type": "string", "description": "Gender of the customer." }, "maidenName": { "type": "string", "description": "Maiden name of the customer." }, "middleName": { "type": "string", "description": "Middle name of the customer." }, "birthDate": { "type": "string", "format": "date", "description": "Birth date of the customer in YYYY-MM-DD format." }, "birthPlace": { "type": "string", "description": "Place of birth of the customer." }, "socialSecurityNumber": { "type": "string", "description": "Customer's Social Security Number." }, "taxId": { "type": "string", "description": "Tax identification number associated with the customer." }, "companyName": { "type": "string", "description": "Name of the company if the customer is a business entity." }, "positionOccupied": { "type": "string", "description": "Position or role occupied by the individual within their company." }, "companyRegistrationNumber": { "type": "string", "description": "Official registration number of the company in its country of incorporation." }, "companyVatId": { "type": "string", "description": "Value Added Tax (VAT) identification number for the company." }, "companyLegalForm": { "type": "string", "description": "The legal form or structure of the company." } } }, "accountInfo": { "type": "object", "description": "The account information contains optional information about the customer account with the merchant.", "properties": { "id": { "type": "string", "description": "The account ID of the cardholder within merchant environment / website (e.g. customer number)." }, "authenticationInfo": { "type": "object", "properties": { "method": { "type": "string", "description": "This data element specifies the mechanism used by the Cardholder to authenticate to the merchant.", "enum": [ "GUEST", "MERCHANT_CREDENTIALS", "FEDERATED_ID", "ISSUER_CREDENTIALS", "THIRD_PARTY_AUTHENTICATION", "FIDO", "SIGNED_FIDO", "SRC_ASSURANCE_DATA" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "Date and time (see RFC 3339) in UTC of the cardholder authentication. YYYY-MM-DDTHH:MM:SS+00:00." }, "data": { "type": "string", "description": "This data element can carry specific authentication attestation data such as FIDO if applicable." } } }, "ageIndicator": { "type": "string", "description": "Length of time that the customer has had the payment instrument / payment account with the merchant.", "enum": [ "GUEST_CHECKOUT", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS" ] }, "changeDate": { "type": "string", "format": "date", "description": "Date that the customer's payment instrument (account) with the merchant was last changed, including billing or shipping address, new payment account, or new user(s) added (YYYY-MM-DD)." }, "changeIndicator": { "type": "string", "description": "Length of time since the customer’s account information with the merchant was last changed, including billing or shipping address, new payment account, or new user(s) added.", "enum": [ "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS" ] }, "creationDate": { "type": "string", "format": "date", "description": "Date that the customer opened the account with the merchant in format YYYY-MM-DD." }, "passwordChangeDate": { "type": "string", "format": "date", "description": "Date that customer's account with the merchant had a password change or account reset in format YYYY-MM-DD." }, "passwordChangeDateIndicator": { "type": "string", "description": "Indicates the length of time since the customer account had a password change or account reset.", "enum": [ "NO_CHANGE", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS" ] }, "numberOfPurchases": { "type": "number", "description": "Number of purchases in the last 6 months" }, "addCardAttemptsDay": { "type": "number", "description": "Number of Add Card attempts in the last 24 hours." }, "numberTransactionsDay": { "type": "number", "description": "Number of transactions (successful and abandoned) in the previous 24 hours." }, "numberTransactionsYear": { "type": "number", "description": "Number of transactions (successful and abandoned) in the previous year." }, "paymentAccountAge": { "type": "string", "format": "date", "description": "Date that the payment account was enrolled in the customer account in format YYYY-MM-DD." }, "paymentAccountAgeIndicator": { "type": "string", "description": "Indicates the length of time that the payment account was enrolled in the customer account.", "enum": [ "GUEST_CHECKOUT", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS" ] }, "shipAddressUsageDate": { "type": "string", "format": "date", "description": "Date when the shipping address used for this transaction was first used in format YYYY-MM-DD." }, "shipAddressUsageIndicator": { "type": "string", "description": "Indicates when the shipping address used for this transaction was first used.", "enum": [ "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS" ] }, "suspiciousAccountActivity": { "type": "boolean", "description": "Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the customer account." } } }, "fraudData": { "type": "object", "title": "fraudData", "properties": { "accountInfo": { "$ref": "#/components/schemas/accountInfo" }, "deliveryEmail": { "type": "string", "description": "For Electronic delivery, the email address to which the merchandise was delivered." }, "deliveryTimeframe": { "type": "string", "description": "Indicates the merchandise delivery timeframe." }, "giftCardAmount": { "type": "number", "description": "For prepaid or gift card purchase, the purchase amount total of prepaid or gift cards in smallest currency unit." }, "giftCardCount": { "type": "number", "description": "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased." }, "giftCardCurrency": { "type": "number", "description": "For prepaid or gift card purchase, ISO 4217 three-digits numeric currency code of the gift card, e.g. 978." }, "preOrderDate": { "type": "string", "format": "date", "description": "For a pre-ordered purchase, the expected date that the merchandise will be available (YYYY-MM-DD)." }, "preOrderPurchaseIndicator": { "type": "boolean", "description": "Indicates whether customer is placing an order for merchandise with a future availability or release date." }, "reorderItemsIndicator": { "type": "boolean", "description": "Indicates whether the customer is reordering previously purchased merchandise." }, "shippingAddressIndicator": { "type": "string", "description": "Indicates shipping method chosen for the transaction. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item." }, "ipZone": { "type": "string", "description": "Codes of countries from which you accept orders, 3 digits numeric according to ISO 3166-1. Separate several countries by commas: 036,040,124." }, "zone": { "type": "string", "description": "Codes of countries where you accept credit cards, 3 digits numeric or alphanumeric according to ISO 3166-1. Separate several countries by commas: 036,040,124." } } }, "subMerchantPaymentFacilitator": { "type": "object", "title": "paymentFacilitator", "description": "Object specifying SubMerchant (Payment Facilitator) details.", "properties": { "subMerchantId": { "type": "string", "description": "SubMerchantID assigned by the Payment Facilitator." }, "subMerchantName": { "type": "string", "description": "Name of the SubMerchantID." }, "subMerchantCity": { "type": "string", "description": "City of the SubMerchantID." }, "subMerchantCountry": { "type": "string", "description": "Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars." }, "subMerchantStreet": { "type": "string", "description": "Street of the SubMerchantID." }, "subMerchantZip": { "type": "string", "description": "Postcode of the SubMerchantID." }, "subMerchantState": { "type": "string", "description": "State of the SubMerchantID." } } }, "browserInfo": { "type": "object", "properties": { "acceptHeaders": { "type": "string", "description": "Exact content of the HTTP accept headers as sent from the customer’s browser." }, "ipAddress": { "type": "string", "description": "IP address of the browser as returned by the HTTP headers." }, "javaEnabled": { "type": "boolean", "description": "Represents the ability of the customer's browser to execute Java. Required when Browser JavaScript Enabled = true; otherwise Optional." }, "javaScriptEnabled": { "type": "boolean", "description": "Represents the ability of the customer's browser to execute JavaScript." }, "language": { "type": "string", "description": "Value representing the browser language as defined in IETF BCP47, returned from navigator.language property, e.g. \"en\", \"de\", \"fr\", \"en-US\", \"en-GB\", \"de-DE\", \"de-AT\", etc." }, "colorDepth": { "type": "number", "description": "Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Required when Browser JavaScript Enabled = true; otherwise optional." }, "screenHeight": { "type": "number", "description": "Total height of the Cardholder’s screen in pixels. Required when Browser JavaScript Enabled = true; otherwise optional." }, "screenWidth": { "type": "number", "description": "Total width of the cardholder’s screen in pixels. Required when Browser JavaScript Enabled = true; otherwise optional." }, "timeZoneOffset": { "type": "string", "description": "Time-zone offset in minutes between UTC and the Cardholder browser local time. Required when Browser JavaScript Enabled = true; otherwise optional." }, "userAgent": { "type": "string", "description": "Exact content of the HTTP user-agent header." } } }, "device": { "type": "object", "properties": { "deviceId": { "type": "string", "description": "Unique Device-ID." }, "deviceType": { "type": "string", "enum": [ "DESKTOP", "TABLET", "SMARTPHONE" ] }, "deviceOs": { "type": "string", "enum": [ "ANDROID", "IOS", "OTHERS" ] }, "confidence": { "type": "number", "description": "A numerical value that indicates the level of confidence in the identification or verification of the customer's device. 0=no allocation, 100=absolutely safe allocation." }, "newDevice": { "type": "boolean", "description": "Indicates whether the device being used is new or has not been previously recognized by the system." }, "isAnonymousProxyUsed": { "type": "boolean", "description": "Specifies whether the customer is using an anonymous proxy to mask their IP address." }, "isProxyUsed": { "type": "boolean", "description": "Indicates whether any kind of proxy is being used by the customer." }, "country": { "type": "string", "description": "The country associated with the device's IP address." }, "city": { "type": "string", "description": "The city associated with the device's IP address." }, "latitude": { "type": "string", "description": "The latitude coordinate of the device's location." }, "longitude": { "type": "string", "description": "The longitude coordinate of the device's location." }, "fraudScore": { "type": "number", "description": "A numerical score that indicates the likelihood of fraudulent activity associated with the device." }, "fraudScoreRules": { "type": "array", "description": "A list or description of the rules or criteria that contributed to the fraud score calculation for the device.", "items": { "type": "string" } }, "browserLanguages": { "type": "array", "description": "A list of languages configured in the browser being used on the device.", "items": { "type": "string" } }, "isMobileDevice": { "type": "boolean", "description": "Indicates whether the device being used is a mobile device." }, "fraud": { "type": "string", "description": "Indicates whether the device has been flagged as potentially fraudulent based on predefined criteria. e.g. fraud, suspicion, nofraud." } } }, "customFieldsCard": { "type": "object", "title": "customFields", "properties": { "customField1": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField2": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField3": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField4": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField5": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField6": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField7": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField8": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField9": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField10": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField11": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField12": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField13": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField14": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." } } }, "bizum": { "type": "object", "required": [ "account" ], "properties": { "sellingPoint": { "type": "string", "description": "Selling point." }, "service": { "type": "string", "description": "Products or service sold." }, "account": { "type": "object", "required": [ "accountHolderName" ], "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder" } } } } }, "threeDsPolicy": { "type": "object", "description": "Object specifying authentication policies and exemption handling strategies.", "properties": { "skip": { "type": "string", "description": "Indicates whether and under which conditions authentication should be skipped or performed as data share only (dataOnly). By default, all transactions and SCA exemptions will be requested through EMV 3DS if not specified otherwise.", "enum": [ "THIS_TRANSACTION", "OUT_OF_SCOPE", "DATA_ONLY" ] }, "exemption": { "type": "object", "properties": { "reason": { "type": "string", "description": "Specifies the reason for requesting an exemption from 3DS authentication.", "enum": [ "TRANSACTION_RISK_ANALYSIS", "DELEGATE_AUTHORITY", "LOW_VALUE", "TRUSTED_BENEFICIARY", "SECURE_CORPORATE_PAYMENT" ] }, "merchantFraudRate": { "type": "number", "minimum": 1, "maximum": 99, "description": "Merchant fraud rate in bps taking into account all Merchant sites and card volumes, calculated as per PSD2 RTS Article 19. The merchant fraud rate is optional and has to be calculated by the Acquirer." } } }, "challengePreference": { "type": "string", "description": "Indicates the merchant's preference for a 3DS challenge.", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "REQUEST_CHALLENGE", "MANDATE_CHALLENGE" ] } } }, "templateCard": { "type": "object", "title": "template", "description": "Applicable only when paymentMethods.integrationType=HOSTED.", "properties": { "name": { "type": "string", "description": "The name of the card template being used for customization." }, "backgroundColor": { "type": "string", "description": "The background color of the card template, specified in hexadecimal format." }, "backgroundImage": { "type": "string", "description": "A URL pointing to an image used as the background of the card template." }, "textColor": { "type": "string", "description": "The color of the text on the card template, specified in hexadecimal format." }, "fontName": { "type": "string", "description": "The name of the font used for text on the card template." }, "fontSize": { "type": "number", "description": "The size of the text on the card template, specified in pixels (px)." }, "tableWidth": { "type": "number", "description": "Specifies the width of a table element within the card template layout, specified in pixels (px)." }, "tableHeight": { "type": "number", "description": "Specifies the height of a table element within the card template layout, specified in pixels (px)." }, "customFields": { "$ref": "#/components/schemas/customFieldsCard" } } }, "cardPrefillInfo": { "type": "object", "title": "prefillInfo", "description": "Applicable only when paymentMethods.integrationType=HOSTED.", "properties": { "number": { "type": "string", "description": "The card number or the pseudo card number of the payment card to prefill the form." }, "cardholderName": { "type": "string", "description": "The name of the cardholder as it appears on the payment card to prefill the form." }, "expiryDate": { "type": "string", "format": "date", "description": "The expiration date of the card in YYYYMM format to prefill the form." }, "brand": { "type": "string", "description": "The brand or network of the card, such as \"visa\", \"mastercard\" to prefill the form." }, "securityCode": { "type": "string", "description": "The Card Security Code, also known as CVV or CVC to prefill the form." } } }, "cardHosted": { "type": "object", "title": "card", "properties": { "eventToken": { "type": "string", "description": "Defines specific use cases of card payments, if applicable.\n- DELAYED_SHIPMENT: Passed in initial request, if you intend to capture the request after the shipment is sent.\n- PRE_AUTH: Passed in initial request, if the initial payment is a preauthorization.\n- PLBS: Passed in initial request, if the payment is related to rental of goods and services and is being initiated as a preauthorization.\n- ORDER: Pass if you want to perform authentication and payment in 2 steps. If you pass it, then the payment should be confirmed by calling the Confirm payment endpoint.\n- ACCOUNT_VERIFICATION: Pass this if you want to verify card account without initiating a payment transaction. Amount is optional when this value is sent.", "enum": [ "DELAYED_SHIPMENT", "PRE_AUTH", "PLBS", "ORDER", "ACCOUNT_VERIFICATION" ] }, "subType": { "type": "array", "description": "Used to define the card payment methods that needs to be shown on the payment form. The values here override your default configuration at merchant level.", "items": { "type": "string", "enum": [ "AIRPLUS", "AMEX", "ARGENCARD", "AURA", "BANCONTACT", "CABAL", "CARTESBANCAIRES", "CBN", "CENCOSUD", "COMFORTCARD", "CUP", "DANKORT", "DINERS", "DISCOVER", "ELO", "HIPERCARD", "JCB", "LASER", "MAESTRO", "MASTERCARD", "NARANJA", "RUPAY", "SHOPPING", "TOTAL", "VISA" ] } }, "threeDsPolicy": { "$ref": "#/components/schemas/threeDsPolicy" }, "template": { "$ref": "#/components/schemas/templateCard" }, "prefillInfo": { "$ref": "#/components/schemas/cardPrefillInfo" }, "dccEnabled": { "type": "boolean", "description": "Defines DCC behavior: true - forces DCC eligibility check; false - disables DCC; omitted - the merchant’s default MAT configuration is applied." } } }, "mandate": { "type": "object", "properties": { "mandateId": { "type": "string", "description": "SEPA Mandate number." }, "dateOfSignature": { "type": "string", "description": "Date of issuing the mandate in the format DD.MM.YYYY." } } }, "directDebitCustomFields": { "type": "object", "title": "customFields", "properties": { "customField1": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField2": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField3": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField4": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField5": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField6": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField7": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField8": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField9": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField10": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField11": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField12": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField13": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." }, "customField14": { "type": "string", "description": "Customizable fields that can store additional data or display specific information on a card template." } } }, "account": { "type": "object", "properties": { "number": { "type": "string", "description": "International Bank Account Number or Mandatory when mandateId is not present." }, "code": { "type": "string", "description": "Bank Identifier Code." }, "bankName": { "type": "string", "description": "Bank name." }, "accountHolderName": { "type": "string", "description": "Account holder name. Mandatory when mandateId is not present." }, "pseudoBankNumber": { "type": "string", "description": "Pseudo Bank Account Number (PBAN) returned by Axepta Online during the initial payment that you can use for follow up payments, if applicable." } } }, "directDebitPrefillInfo": { "type": "object", "title": "prefillInfo", "properties": { "account": { "$ref": "#/components/schemas/account" } } }, "epsAccount": { "title": "account", "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder." }, "number": { "type": "string", "description": "International Bank Account Number for SEPA." }, "code": { "type": "string", "description": "Bank Identifier Code for SEPA." } } }, "epsHosted": { "title": "eps", "type": "object", "properties": { "account": { "$ref": "#/components/schemas/epsAccount" }, "optionDate": { "type": "string", "format": "date", "description": "Desired payment execution date in the format YYYY-MM-DD." }, "sellingPoint": { "type": "string", "description": "Selling point." }, "service": { "type": "string", "description": "Products or service sold." } } }, "customerHistory": { "type": "object", "properties": { "canceledOrderAmount": { "type": "number", "format": "int64", "description": "Total amount in cents of orders cancelled in the last 2 years." }, "canceledOrderCount": { "type": "number", "format": "int64", "description": "Number of orders placed and cancelled by the customer in the last 2 years." }, "firstOrderDate": { "type": "string", "format": "date-time", "description": "Date of first customer order in format DD/MM/YYYY." }, "fraudAlertCount": { "type": "number", "format": "int64", "description": "Number of fraud alerts regarding customer orders in the last 2 years." }, "lastOrderDate": { "type": "string", "format": "date-time", "description": "Date of last customer order in format DD/MM/YYYY." }, "paymentIncidentCount": { "type": "number", "format": "int64", "description": "Number of payment incidents involving customer orders in the last 2 years." }, "refusedManyTimesOrderCount": { "type": "number", "format": "int64", "description": "Number of orders whose payment in instalments has been refused in the last 2 years." }, "unvalidatedOrderCount": { "type": "number", "format": "int64", "description": "Number of orders refused in the validation phase in the last 2 years." }, "validatedOneTimeOrderCount": { "type": "number", "format": "int64", "description": "Number of orders paid in 1 installment in the last 2 years." }, "validatedOrderCount": { "type": "number", "format": "int64", "description": "Number of orders validated in the last 2 years." }, "clientIpAddressRecurrence": { "type": "number", "format": "int64", "description": "Customer IP address recurrence in the last 2 years." }, "ongoingLitigationOrderAmount": { "type": "number", "format": "int64", "description": "Current amounts in dispute not settled." }, "paidLitigationOrderAmount": { "type": "number", "format": "int64", "description": "Amount of litigation settled in the last 2 years." }, "scoreSimulationCount": { "type": "number", "format": "int64", "description": "Number of simulated scores in the last 7 days." } } }, "travelDetails": { "type": "object", "properties": { "insuranceType": { "type": "string", "description": "Type of supplementary insurance chosen by the customer." }, "travelType": { "type": "string", "enum": [ "UNKNOWN", "ONE_WAY", "TWO_WAY", "MULTIPLE" ] }, "departureDate": { "type": "string", "format": "date-time", "description": "Mandatory for tour operators, Optional for all others: Start date in format: DD/MM/YYYY HH:MM." }, "returnDate": { "type": "string", "format": "date-time", "description": "Mandatory for tour operators, Optional for all others: Return date in format: DD/MM/YYYY HH:MM." }, "destinationCountry": { "type": "string", "description": "Mandatory for tour operators, Optional for all others: Alpha-2 ISO code of the destination country." }, "ticketCount": { "type": "number", "format": "int64", "description": "Number of tickets." }, "travellerCount": { "type": "number", "format": "int64", "description": "Mandatory for tour operators, Optional for all others: Number of passengers." }, "travelClass": { "type": "string", "enum": [ "UNKNOWN", "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST", "OTHERS" ] }, "ownTicket": { "type": "boolean", "description": "Indicator to identify whether the holder of the credit card used to fund the trip is participating." }, "mainDepartureCompany": { "type": "string", "description": "Airline Company One Way Flight." }, "travellerPassports": { "type": "array", "description": "Information concerning the passport(s) of the traveler(s).", "items": { "type": "object", "properties": { "expirationDate": { "type": "string", "format": "date-time", "description": "Passport expiration date in format DD/MM/YYYY." }, "issuanceCountry": { "type": "string", "description": "Alpha-2 ISO code of the country of issue of the passport." } } } }, "departureAirport": { "type": "string", "description": "IATA code of the airport of departure." }, "arrivalAirport": { "type": "string", "description": "IATA code of the arrival airport." }, "discountCode": { "type": "string" }, "luggageSupplement": { "type": "string" }, "modificationCancellation": { "type": "boolean" } } }, "stayDetails": { "type": "object", "properties": { "company": { "type": "string", "description": "Shipowner/Operator/Hotel chain." }, "destination": { "type": "string", "description": "Destination city." }, "nightNumber": { "type": "number", "format": "int64", "description": "Number of overnight stays." }, "roomRange": { "type": "number", "format": "int64", "description": "Room range." } } }, "productDetails": { "type": "object", "properties": { "category1": { "type": "string", "description": "Product category number 1." }, "category2": { "type": "string", "description": "Product category number 2." }, "category3": { "type": "string", "description": "Product category number 3." } } }, "additionalField": { "type": "object", "required": [ "index", "value", "type" ], "properties": { "index": { "type": "number", "format": "int64", "description": "Field Index." }, "value": { "type": "string", "description": "Field value." }, "type": { "type": "string", "description": "type of the field.", "enum": [ "N", "T" ] } } }, "ideal": { "type": "object", "properties": { "subType": { "description": "Indicates the provider via which iDEAL payment should be processed.\n\nPossible values:\n\n- IDEAL - Processed directly with iDEAL\n- IDEALPP - Processed via PPRO\n- IDEALRABO - Processed via Rabo Bank\n", "type": "string", "enum": [ "IDEAL", "IDEALPP", "IDEALRABO" ] } } }, "layout": { "allOf": [ { "type": "object", "properties": { "showSubTotalDetail": { "type": "string", "description": "If the value is passed as \"HIDE\" then hides the item positions on the Klarna's hosted payment page." }, "logoUrl": { "type": "string", "description": "URL of the logo to be displayed." }, "pageTitle": { "type": "string", "description": "Title for the Payment Page." } } } ] }, "enhancedData": { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "productCategory": { "type": "string", "description": "The name of the general category to which the specific goods belong, according to the selling merchant's categorization.", "example": "Computers" }, "productName": { "type": "string", "description": "The name of the purchased good.", "example": "Acer 5400" } } } } }, "klarnaHosted": { "type": "object", "title": "klarna", "properties": { "layout": { "$ref": "#/components/schemas/layout" }, "accountId": { "type": "string", "description": "Within Axepta Online several Klarna account names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value \"0\", if you have several Klarna accounts, the values must be agreed with Axepta Online Helpdesk." }, "enhancedData": { "$ref": "#/components/schemas/enhancedData" }, "description": { "type": "string", "description": "Description of the purpose of the token. Required when credentialOnfile. Type is recurring." } } }, "mbWayAccount": { "title": "account", "type": "object", "required": [ "accountHolderName" ], "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder." } } }, "mbWayHosted": { "title": "mbWay", "type": "object", "required": [ "account" ], "properties": { "account": { "$ref": "#/components/schemas/mbWayAccount" }, "sellingPoint": { "type": "string", "description": "Selling point." }, "service": { "type": "string", "description": "Products or service sold." } } }, "multibanco": { "allOf": [ { "type": "object", "properties": { "sellingPoint": { "type": "string", "description": "Selling point" }, "service": { "type": "string", "description": "products or service sold" }, "account": { "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder" } } } } } ] }, "payPal": { "type": "object", "required": [ "eventToken" ], "properties": { "accountId": { "type": "string", "description": "Your Paypal account ID. It can be ID or email address associated with the Paypal account. This parameter can be passed to override the static merchant configuration if you have multiple Paypal accounts." }, "hideAddress": { "type": "boolean", "description": "Indicates if shipping address stored on customer's Paypal account should be hidden." } } }, "unionPayAccount": { "title": "account", "type": "object", "required": [ "accountHolderName" ], "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder." } } }, "unionPayHosted": { "title": "unionPay", "type": "object", "required": [ "account" ], "properties": { "account": { "$ref": "#/components/schemas/unionPayAccount" }, "sellingPoint": { "type": "string", "description": "Selling point." }, "service": { "type": "string", "description": "Products or service sold." } } }, "weChatAccount": { "title": "account", "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder." } } }, "weChat": { "title": "weChat", "type": "object", "properties": { "account": { "$ref": "#/components/schemas/weChatAccount" }, "sellingPoint": { "type": "string", "description": "Selling point." }, "service": { "type": "string", "description": "Products or service sold." } } }, "paymentSession": { "title": "paymentMethods", "properties": { "bizum": { "$ref": "#/components/schemas/bizum" }, "card": { "$ref": "#/components/schemas/cardHosted" }, "eps": { "$ref": "#/components/schemas/epsHosted" }, "ideal": { "$ref": "#/components/schemas/ideal" }, "klarna": { "$ref": "#/components/schemas/klarnaHosted" }, "mbWay": { "$ref": "#/components/schemas/mbWayHosted" }, "multibanco": { "$ref": "#/components/schemas/multibanco" }, "payPal": { "$ref": "#/components/schemas/payPal" }, "unionPay": { "$ref": "#/components/schemas/unionPayHosted" }, "weChat": { "$ref": "#/components/schemas/weChat" } } }, "createSessionRequest": { "title": "CreateSessionRequest", "type": "object", "required": [ "transId", "amount", "urls" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "externalIntegrationId": { "type": "string", "description": "External integration identifier" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "amount": { "$ref": "#/components/schemas/amount" }, "language": { "type": "string", "description": "Language code to determine the language of the payment form and customer communication where applicable." }, "template": { "$ref": "#/components/schemas/template" }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "credentialOnFile": { "$ref": "#/components/schemas/credentialOnFile" }, "order": { "$ref": "#/components/schemas/order" }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "urls": { "$ref": "#/components/schemas/sessionUrls" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/customerInfo" }, "partialPayment": { "type": "boolean", "description": "Defines if the payment is a partial payment. Possible values: true or false." }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "fraudData": { "$ref": "#/components/schemas/fraudData" }, "paymentFacilitator": { "$ref": "#/components/schemas/subMerchantPaymentFacilitator" }, "browserInfo": { "$ref": "#/components/schemas/browserInfo" }, "device": { "$ref": "#/components/schemas/device" }, "channel": { "type": "string", "description": "Specifies the sales or interaction channel through which the transaction is initiated. ", "enum": [ "ECOM", "MOTO", "APP", "PAYBYLINK", "POS" ] }, "remittanceInfo": { "type": "string", "description": "Additional transaction description." }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "allowedPaymentMethods": { "type": "array", "description": "Indicates list of allowed payment methods that should be shown on the hosted payment page. If not passed default merchant level configuration is used to display the allowed payment methods.", "items": { "type": "string", "enum": [ "ALIPAY", "APPLEPAY", "BANCONTACT", "BIZUM", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "FLOAPAY", "GOOGLEPAY", "IDEAL", "INSTANEA", "KLARNA", "MBWAY", "MULTIBANCO", "MYBANK", "PAYPAL", "PRZELEWY24", "TRUSTLY", "TWINT", "UNIONPAY", "VIPPSMOBILEPAY", "WECHAT", "WERO" ] } }, "paymentMethods": { "$ref": "#/components/schemas/paymentSession" } } }, "paymentHostedResponse": { "type": "object", "title": "PaymentResponse", "properties": { "_links": { "type": "object", "properties": { "redirect": { "type": "object", "description": "This link is present when redirection to payment page must be done in order to complete the payment process. Decoded URL value with the exception of PagBrasil Boleto Bancario, where the encoded URL value is returned.", "properties": { "href": { "type": "string", "format": "uri", "description": "The URL to which the customer should be redirected to complete the payment." }, "type": { "type": "string", "description": "Specifies the type of redirect link." } } } } } } }, "createSessionResponse": { "title": "CreateSessionResponse", "allOf": [ { "$ref": "#/components/schemas/paymentHostedResponse" } ] }, "validationErrorResponse": { "title": "ValidationProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "A URI reference that identifies the problem type", "example": "https://tools.ietf.org/html/rfc9110#section-15.5.1" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type", "example": "One or more validation errors occurred." }, "status": { "type": "integer", "description": "The HTTP status code", "example": 400 }, "traceId": { "type": "string", "description": "Trace Id", "example": "00-a06284de9126d7fa46a5d112b3a721c3-c923572965eea46b-00" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "Object": [ "Error 1", "Error 2" ] } } } }, "errorResponse": { "type": "object", "title": "ErrorResponse", "properties": { "payId": { "type": "string", "example": 0 }, "responseCode": { "type": "string", "example": 422 }, "responseDescription": { "type": "string", "description": "Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!", "example": "Payment could not be processed." } } }, "paymentUrls": { "type": "object", "properties": { "return": { "type": "string", "format": "uri", "description": "Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT." }, "cancel": { "type": "string", "format": "uri", "description": "Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT." }, "webhook": { "type": "string", "format": "uri", "description": "Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT." }, "appRedirect": { "type": "string", "format": "uri", "description": "The URL used in Instanea payments to provide the merchant’s base app URL for redirection." } } }, "CountryRestriction": { "type": "object", "properties": { "statesOrRegions": { "type": "array", "items": { "type": "string" } }, "zipCodes": { "type": "array", "items": { "type": "string" } } } }, "tokenData": { "type": "object", "title": "tokenData", "description": "Token data if you are connected to MDES and VTS directly.", "properties": { "cryptogram": { "type": "string", "description": "Cryptogram as received from Tokenization Service." }, "eci": { "type": "string", "description": "Payment system specific Electronic Commerce Indicator." }, "tokenRequestor": { "type": "string", "description": "Token Requestor.", "enum": [ "APPLEPAY", "GOOGLEPAY", "MERCHANT_TOKENIZATION" ] }, "tokenRequestorId": { "type": "string", "description": "Token Requestor ID assigned by the card scheme.Required when tokenRequestor is MERCHANT_TOKENIZATION and MasterCard transaction." } } }, "priorAuthenticationInfo": { "type": "object", "description": "Prior Transaction Authentication Information contains optional information about a 3DS cardholder authentication that occurred prior to the current transaction", "properties": { "data": { "type": "string", "description": "Data that documents and supports a specific authentication process performed by the merchant such as FIDO" }, "method": { "type": "string", "description": "The method used for prior authentication.", "enum": [ "FRICTIONLESS", "ACS_CHALLENGE", "AVS_VERIFIED", "OTHER" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the prior authentication event in YYYY-MM-DDTHH:MM:SS+00:00 format" }, "reference": { "type": "string", "description": "A reference to the prior authentication event. It should contain the ACS Transaction ID. For example: the first recurring transaction that was authenticated with the cardholder." } } }, "threeDsData": { "type": "object", "required": [ "acsProtocolVersion", "eci" ], "properties": { "acsProtocolVersion": { "type": "string", "description": "The protocol version used for authentication.", "enum": [ "1.0.2", "2.1.0", "2.2.0", "2.3.0" ] }, "eci": { "type": "string", "description": "Payment system specific Electronic Commerce Indicator." }, "authenticationValue": { "type": "string", "description": "Payment system specific value to provide proof of authentication." }, "cavvAlgorithm": { "type": "string", "description": "3DS 2.0 only with Cartes Bancaires." }, "serverTransactionId": { "type": "string", "description": "3DS 2.0 only. Universally unique transaction identifier assigned by the 3DS Server." }, "acsXid": { "type": "string", "description": "3DS 1.0 only. ACS assigned transaction ID." }, "dsTransactionId": { "type": "string", "description": "3DS 2.0 only. Universally unique transaction identifier assigned by the DS to identify a single transaction." }, "intermediateStatus": { "type": "string", "description": "This is the transaction status transStatus from the Authentication Response (ARes).\n- Y = Authentication Verification Successful.\n- N = Not Authenticated /Account Not Verified; Transaction denied.\n- U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq.\n- A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided.\n- C = Challenge Required; Additional authentication is required using the CReq/CRes.\n- D = Challenge Required; Decoupled Authentication confirmed.\n- I = Informational Only; 3DS Requestor challenge preference acknowledged.", "enum": [ "Y", "N", "U", "A", "C", "D", "I" ] }, "finalStatus": { "type": "string", "description": "This is the transaction status transStatus from the Result Request (RReq).\n- Y = Authentication Verification Successful.\n- U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq.\n- A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided.", "enum": [ "Y", "U", "A" ] }, "challengeRequestIndicator": { "type": "string", "description": "Specifies value for \"3DS Requestor Challenge Indicator\"\n- 01 = No preference – default value if the data element is absent or not set to a value\n- 02 = No authentication\n- 03 = Authentication requested\n- 04 = Authentication required\n- 05 = No authentication: transaction risk analysis already performed\n- 06 = No authentication: data share only\n- 07 = No authentication: SCA already performed\n- 08 = No authentication: whitelist\n- 09 = Authentication required", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "challengeCancellationIndicator": { "type": "string", "description": "Specifies value for \"Challenge Cancellation Indicator\"\n- 01 = Cardholder selected “Cancel”\n- 02 = 3DS Requestor cancelled Authentication.\n- 03 = Transaction Abandoned\n- 04 = Transaction Timed Out at ACS— other timeouts\n- 05 = Transaction Timed Out at ACS— First CReq not received by ACS\n- 06 = Transaction Error\n- 07 = Unknown", "enum": [ 1, 2, 3, 4, 5, 6, 7 ] }, "dsScore": { "type": "string", "description": "Specifies value for \"DS Score\", scoring returned by the CB DS." }, "transactionStatusReason": { "type": "string", "description": "Specifies value for \"Transaction Status Reason Code\".", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 80, 81, 82, 83, 84, 85, 86, 87, 88 ] } } }, "threeDsSDK": { "type": "object", "properties": { "sdkApplicationId": { "type": "string", "description": "A unique identifier for the 3D Secure (3DS) SDK application used to facilitate authentication on the customer's device." }, "deviceData": { "type": "string", "description": "Data collected from the customer's device during the 3DS authentication process." }, "sdkEphemeralPublicKey": { "type": "string", "description": "The ephemeral public key generated by the 3DS SDK." }, "sdkReferenceNumber": { "type": "string", "description": "A reference number assigned to the 3DS SDK." }, "sdkTransactionId": { "type": "string", "description": "Unique identifier for the transaction generated by the 3DS SDK." }, "messageVersion": { "type": "string", "description": "The version of the 3D Secure protocol being used by the SDK.", "enum": [ "2.1.0", "2.2.0", "LATEST" ] } } }, "cardDcc": { "type": "object", "title": "dcc", "description": "Carries the customer’s DCC decision for integration type direct. Required when the customer opts into DCC.", "properties": { "selected": { "type": "boolean", "description": "Customer decision: true = opted in, false = opted out. Required if dcc object is present." }, "dccRequestId": { "type": "string", "description": "Identifier of the DCC quote. Required if selected is true." } } }, "card": { "type": "object", "properties": { "eventToken": { "type": "string", "description": "Defines specific use cases of card payments, if applicable.\n- DELAYED_SHIPMENT: Passed in initial request, if you intend to capture the request after the shipment is sent.\n- PRE_AUTH: Passed in initial request, if the initial payment is a preauthorization.\n- PLBS: Passed in initial request, if the payment is related to rental of goods and services and is being initiated as a preauthorization.\n- ORDER: Pass if you want to perform authentication and payment in 2 steps. If you pass it, then the payment should be confirmed by calling the Confirm payment endpoint.\n- REAUTHORIZATION: Passed in subsequent merchant initiated transaction. You can initiate a re-authorization when the \ncompletion or fulfillment of the original order or service extends beyond the authorization validity limit set by Visa.There\nare two common re-authorization scenarios:\n - Split or delayed shipments at eCommerce retailers. A split shipment occurs when not all the goods ordered are\n available for shipment at the time of purchase. If the fulfillment of the goods takes place after the authorization\n validity limit set by Visa, eCommerce merchants perform a separate authorization to ensure that consumer funds are \n available.\n - Extended stay hotels, car rentals, and cruise lines. A re-authorization is used for stays, voyages, and/or rentals that\n extend beyond the authorization validity period set by Visa.\n- RESUBMISSION: Passed in subsequent merchant initiated transaction. You perform a re-submission in cases where it requested an authorization, but received a decline due to insufficient funds; however, the goods or services were already delivered to the cardholder.\n In such scenarios you can resubmit the request to recover outstanding debt from cardholders.\n- DELAYED_CHARGES: Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed.\n- NO_SHOW: Passed in subsequent merchant initated transaction. Cardholders can use their Visa cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows you to perform a No Show transaction to charge the cardholder a penalty according to the your cancellation policy.\n- ACCOUNT_VERIFICATION: Pass this if you want to verify card account without initiating a payment transaction. Amount is optional when this value is sent.\n- ADDITIONAL_CHARGES", "enum": [ "DELAYED_SHIPMENT", "PRE_AUTH", "PLBS", "ORDER", "REAUTHORIZATION", "RESUBMISSION", "DELAYED_CHARGES", "NO_SHOW", "ACCOUNT_VERIFICATION", "ADDITIONAL_CHARGES" ] }, "subType": { "type": "array", "description": "Used to define the card payment methods that needs to be shown on the payment form. The values here override your default configuration at merchant level.", "items": { "type": "string", "enum": [ "AIRPLUS", "AMEX", "ARGENCARD", "AURA", "BANCONTACT", "CABAL", "CARTESBANCAIRES", "CBN", "CENCOSUD", "COMFORTCARD", "CUP", "DANKORT", "DINERS", "DISCOVER", "ELO", "HIPERCARD", "JCB", "LASER", "MAESTRO", "MASTERCARD", "NARANJA", "RUPAY", "SHOPPING", "TOTAL", "VISA" ] } }, "number": { "type": "string", "description": "The card number, pseudo card number or the network token of the payment card.Mandatory when paymentMethod.integrationType=DIRECT." }, "cardHolderName": { "type": "string", "description": "The name of the cardholder as it appears on the payment card.Mandatory when paymentMethod.integrationType=DIRECT." }, "expiryDate": { "type": "string", "format": "date", "description": "The expiration date of the card in YYYYMM format.Mandatory when paymentMethod.integrationType=DIRECT." }, "brand": { "type": "string", "description": "The brand or network of the card, such as \"visa\", \"mastercard\".Applicable only when paymentMethod.integrationType=DIRECT." }, "securityCode": { "type": "string", "description": "The Card Security Code, also known as CVV or CVC." }, "startDate": { "type": "string", "description": "The start date of the card, if applicable. Applicable for some UK debit cards.Applicable only when paymentMethod.integrationType=DIRECT." }, "sequenceNumber": { "type": "string", "description": "A number assigned to specific cards by issuers to distinguish between multiple versions of the same card. Applicable for some UK debit cards.Applicable only when paymentMethod.integrationType=DIRECT." }, "brandSelection": { "type": "string", "description": "Indicates the party that made the card brand choice during the payment. Applicable only when paymentMethods.integrationType=DIRECT\nPossible values:\n- CUSTOMER: Customer made the brand choice during the payment\n- MERCHANT: Originally selected brand by the merchant was not overriden by the customer during the payment", "enum": [ "CUSTOMER", "MERCHANT" ] }, "tokenData": { "$ref": "#/components/schemas/tokenData" }, "schemeReferenceId": { "type": "string", "description": "A unique identifier assigned by the card network to track the transaction or card across its lifecycle. It is required to send this information for credential on file transactions when intialPayment is false." }, "approvalCodeTel": { "type": "string", "description": "For 3-D Secure: Telephone authorisation code." }, "priorAuthenticationInfo": { "$ref": "#/components/schemas/priorAuthenticationInfo" }, "threeDsData": { "$ref": "#/components/schemas/threeDsData" }, "threeDsSDK": { "$ref": "#/components/schemas/threeDsSDK" }, "threeDsPolicy": { "$ref": "#/components/schemas/threeDsPolicy" }, "template": { "$ref": "#/components/schemas/templateCard" }, "prefillInfo": { "$ref": "#/components/schemas/cardPrefillInfo" }, "dccEnabled": { "type": "boolean", "description": "Defines DCC behavior for integration type hosted: true - forces DCC eligibility check; false - disables DCC; omitted - the merchant’s default MAT configuration is applied." }, "dcc": { "$ref": "#/components/schemas/cardDcc" } } }, "accountCreate": { "type": "object", "title": "account", "properties": { "number": { "type": "string", "description": "International Bank Account Number or Mandatory when mandateId is not present." }, "code": { "type": "string", "description": "Bank Identifier Code." }, "bankName": { "type": "string", "description": "Bank name." }, "accountHolderName": { "type": "string", "description": "Account holder name. Mandatory when mandateId is not present." } } }, "directDebitCreatePrefillInfo": { "type": "object", "title": "prefillInfo", "properties": { "account": { "$ref": "#/components/schemas/accountCreate" } } }, "googlePay": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "description": "Token as received by you from Google. Data should be submitted Base64 encoded." } } }, "klarnaLayout": { "type": "object", "title": "layout", "description": "Layout parameters for Klarna widgets.", "properties": { "borderColor": { "type": "string", "description": "Color for the border of elements within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"." }, "borderColorSelected": { "type": "string", "description": "Color for the border of elements within the iFrame when selected by the customer. Value should be a CSS hex color, e.g. \"#FF9900\"." }, "detailsColor": { "type": "string", "description": "Defines the color used for additional details or informational text." }, "borderRadius": { "type": "string", "description": "Radius for the border of elements within the iFrame." }, "showSubTotalDetail": { "type": "string", "description": "If the value is passed as \"HIDE\" then hides the item positions on the Klarna's hosted payment page." }, "logoUrl": { "type": "string", "description": "URL of the logo to be displayed." }, "pageTitle": { "type": "string", "description": "Title for the Payment Page." } } }, "klarna": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/klarnaLayout" }, "accountId": { "type": "string", "description": "Within Axepta Online several Klarna user names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value \"0\", if you have several Klarna accounts, the values must be agreed with Axepta Online Helpdesk." }, "enhancedData": { "$ref": "#/components/schemas/enhancedData" }, "description": { "type": "string", "description": "Description of the purpose of the token. Required when credentialOnfile.Type is recurring.InitialPayment is true." }, "billingAgreementId": { "type": "string", "description": "Provider Token returned in the response of initial payment of recurring flow. Required when credentialOnfile.Type is recurring and credentialOnfile.InitialPayment is false." } } }, "pagBrasilPL": { "type": "object", "properties": { "productName": { "type": "string" }, "payType": { "type": "array", "items": { "type": "string", "enum": [ "C", "D", "B", "X" ] }, "description": "C = Credit card, D = Débito Flash™, B = Boleto Flash®, X = PagBrasil Pix" } } }, "accountRatepay": { "type": "object", "title": "account", "properties": { "number": { "type": "string", "description": "International Bank Account Number. Mandatory when transferType is SEPA_DIRECT_DEBIT." }, "code": { "type": "string", "description": "Bank identifier code." }, "accountHolderName": { "type": "string", "description": "Name of account holder. Mandatory when transferType is SEPA_DIRECT_DEBIT." } } }, "accountRiverty": { "type": "object", "title": "account", "properties": { "code": { "type": "string", "description": "Bank Identifier Code." }, "number": { "type": "string", "description": "International Bank Account Number. Mandatory if subType is INVOICE or INSTALLMENT." } } }, "orderRisk": { "type": "object", "properties": { "channelType": { "type": "string", "description": "Order channel type.", "enum": [ "INTERNET", "CATALOG", "CALLCENTER", "STATIONARY", "OTHER" ] }, "deliveryType": { "type": "string", "description": "Order delivery type.", "enum": [ "NORMAL", "EXPRESS" ] }, "ticketDeliveryMethod": { "type": "string", "description": "Ticket's delivery method..", "enum": [ "NOTSET", "PICKUP", "EMAIL", "POST", "PHONE" ] } } }, "customerRisk": { "type": "object", "properties": { "existingCustomer": { "type": "boolean", "description": "Indicates whether the customer is an existing customer of the merchant." }, "verifiedCustomerIdentification": { "type": "boolean", "description": "Indicates whether the customer has been verified." }, "marketingOptIn": { "type": "boolean", "description": "Indicates whether marketing material is requested." }, "customerSince": { "type": "string", "description": "Date in format YYYY-MM-DD since which the customer has existed." }, "customerClassification": { "type": "string", "description": "Customer classification." }, "acquistitionChannel": { "type": "string", "description": "Indicates the channel via which the merchant is reached.", "enum": [ "NOTSET", "ADVERTISEMENT", "SOCIALNETWORK", "DIRECT", "SEARCHENGINE", "OTHER" ] }, "hasCustomerCard": { "type": "boolean", "description": "Indicates whether the customer has a loyalty card." }, "customerCardSince": { "type": "string", "description": "Date in format YYYY-MM-DD since which the loyalty card has existed." }, "customerCardClassification": { "type": "string", "description": "Indicates the loyalty card level, e.g. \"Gold Member\"." }, "profileTrackingId": { "type": "string", "description": "Unique TrackingID." }, "numberOfTransactions": { "type": "number", "description": "Number of successful transactions already completed by the customer." }, "customerIndividualScore": { "type": "number", "description": "Individual score for the customer supplied by the merchant." }, "userAgent": { "type": "string", "description": "UserAgent of this specific consumer." }, "amountOfTransactions": { "type": "number", "description": "Amount of paid orders last 12 months." }, "otherPaymentMethods": { "type": "boolean", "description": "Other payment method than MI in wallet." } } }, "wero": { "type": "object", "title": "wero", "properties": { "walletId": { "type": "string", "description": "EPI provided Wallet ID identifying the Consumer Wallet used during a Wero payment" } } }, "payment": { "title": "paymentMethods", "type": "object", "required": [ "type", "integrationType" ], "properties": { "integrationType": { "type": "string", "description": "Indicates the integration approach for the payment method.\n- HOSTED: customer is redirected to a payment page,\n- DIRECT: server to server communication", "enum": [ "HOSTED", "DIRECT" ] }, "type": { "type": "string", "description": "Specifies the type of payment method being used.", "enum": [ "ALIPAY", "AMAZONPAY", "APPLEPAY", "BANCONTACT", "BIZUM", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "FLOAPAY", "GOOGLEPAY", "IDEAL", "INSTANEA", "KLARNA", "MBWAY", "MOBILEPAY", "MULTIBANCO", "MYBANK", "PAGBRASILPL", "PAYPAL", "PAYU", "PFCONNECT", "PRZELEWY24", "RATEPAY", "RIVERTY", "SWISH", "VIPPSMOBILEPAY", "TRUSTLY", "TWINT", "UNIONPAY", "WECHAT", "WERO" ] }, "bizum": { "$ref": "#/components/schemas/bizum" }, "card": { "$ref": "#/components/schemas/card" }, "eps": { "$ref": "#/components/schemas/epsHosted" }, "googlePay": { "$ref": "#/components/schemas/googlePay" }, "ideal": { "$ref": "#/components/schemas/ideal" }, "klarna": { "$ref": "#/components/schemas/klarna" }, "mbWay": { "$ref": "#/components/schemas/mbWayHosted" }, "multibanco": { "$ref": "#/components/schemas/multibanco" }, "pagBrasilPL": { "$ref": "#/components/schemas/pagBrasilPL" }, "payPal": { "$ref": "#/components/schemas/payPal" }, "unionPay": { "$ref": "#/components/schemas/unionPayHosted" }, "wero": { "$ref": "#/components/schemas/wero" }, "weChat": { "$ref": "#/components/schemas/weChat" } } }, "paymentRequest": { "title": "PaymentRequest", "type": "object", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment. \n\nFor iDEAL only a-z, A-Z, 0-9 characters are permitted and the length should be <= 24", "maxLength": 64 }, "externalIntegrationId": { "type": "string", "description": "External integration identifier" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "amount": { "$ref": "#/components/schemas/amount" }, "language": { "type": "string", "description": "Language code to determine the language of the payment form and customer communication where applicable." }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "credentialOnFile": { "$ref": "#/components/schemas/credentialOnFile" }, "order": { "$ref": "#/components/schemas/order" }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "urls": { "$ref": "#/components/schemas/paymentUrls" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/customerInfo" }, "partialPayment": { "type": "boolean", "description": "Defines if the payment is a partial payment. Possible values: true or false." }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "fraudData": { "$ref": "#/components/schemas/fraudData" }, "paymentFacilitator": { "$ref": "#/components/schemas/subMerchantPaymentFacilitator" }, "browserInfo": { "$ref": "#/components/schemas/browserInfo" }, "device": { "$ref": "#/components/schemas/device" }, "channel": { "type": "string", "description": "Specifies the sales or interaction channel through which the transaction is initiated. Examples include \"online\", \"in-store\", \"mobile app\".", "enum": [ "ECOM", "MOTO", "APP", "PAYBYLINK", "POS" ] }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "referencePayId": { "type": "string", "description": "Payment ID referring to the previous related request. Only applicable for PFConnect Authorization and Subsequent card installment payments." }, "paymentMethods": { "$ref": "#/components/schemas/payment" } } }, "baseResponse": { "type": "object", "title": "BaseResponse", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Transaction ID provided by you in the request." }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "refNr": { "type": "string", "description": "Reference number provided by you in the request." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs as you passed in the request." } } }, "getDetailsCustomerInfo": { "type": "object", "title": "customerInfo", "properties": { "gatewayCustomerId": { "type": "string", "description": "Unique identifier for the customer assigned by Axepta Online. Populated if Customer Vault feature is enabled" } }, "allOf": [ { "$ref": "#/components/schemas/customerInfo" } ] }, "bin": { "type": "object", "properties": { "accountBin": { "type": "string", "description": "The leading six digits of the account number also known as bank identification number (BIN). The BIN consists of 6 to 8 digits – because of PCI DSS rules a maximum of the first 6 digits may be output." }, "accountRangeLow": { "type": "string", "description": "The account number at the low end of the account range." }, "accountRangeHigh": { "type": "string", "description": "The account number at the high end of the account range." } } }, "errorDetails": { "type": "object", "properties": { "threeDSServerTransId": { "type": "string" }, "errorCode": { "type": "string" }, "errorComponent": { "type": "string" }, "errorDescription": { "type": "string" } } }, "versioningDataObjectResponse": { "type": "object", "title": "versioningData", "description": "Specific object for Card payment method.", "properties": { "threeDSServerTransId": { "type": "string" }, "acsStartProtocolVersion": { "type": "string" }, "acsEndProtocolVersion": { "type": "string" }, "dsStartProtocolVersion": { "type": "string" }, "dsEndProtocolVersion": { "type": "string" }, "threeDSMethodDataForm": { "type": "string" }, "threeDSMethodUrl": { "type": "string" }, "threeDSMethodData": { "type": "object", "properties": { "threeDSMethodNotificationUrl": { "type": "string" }, "threeDSServerTransId": { "type": "string" } } }, "errorDetails": { "$ref": "#/components/schemas/errorDetails" } } }, "fraudPreventionObjectResponse": { "type": "object", "title": "fraudData", "properties": { "zone": { "type": "string", "description": "If country codes have been entered in Zone Axepta Online returns the country code for the credit card or \"UNKNOWN\"." }, "ipZone": { "type": "string", "description": "If IP-countries are transmitted in IPZone in the case of the inquiry Axepta Online returns the country code of the IP address or \"UNKNOWN\"." }, "ipZoneA2": { "type": "string", "description": "If IPZone is submitted within the request Axepta Online returns the two-character country code of the IP address or \"UNKNOWN\". (DE=Germany, FR=France etc.)" }, "ipState": { "type": "string", "description": "If IPZone is submitted in the request Axepta Online returns the federal state from which the IP address of your customer originates." }, "ipCity": { "type": "string", "description": "If IPZone is submitted in the request Axepta Online returns the town/city from which the IP address of your customer originates." }, "ipLongitude": { "type": "string", "description": "If IPZone is submitted in the request Axepta Online returns the geographical longitude (floating point, decimal) of the dial-in node (PoP) of your customer." }, "ipLatitude": { "type": "string", "description": "If IPZone is submitted in the request Axepta Online returns the geographical latitude (floating point, decimal) of the dial-in node (PoP) of your customer." }, "fsStatus": { "type": "string", "description": "Only with EVO Payments International: ACCEPT=no suspicion of card fraud, DENY=refusal recommended, CHALLENGE= verification recommended, NOSCORE=No risk analysis, ENETFP=Exceptional error in the network, ERROR=Error in the data processing centre, ETMOUT=Timeout." }, "fsCode": { "type": "string", "description": "Only with EVO Payments International: Recommended action: <0000> no result, <0100> accept, <0150> always accept, <0200> deny, <0250> always deny, <0300> suspicious, <0330> please check, <0400> suspicious ReD blacklist, <0500> questionable, <0600> questionable ReD blacklist, <0700> threshold exceeded, <0800> unusual usage, <901> intern ebitGuard error, <902> format error." } } }, "authenticationResultObjectResponse": { "type": "object", "title": "authenticationData", "description": "Specific object for Card payment method.", "properties": { "threeDSServerTransId": { "type": "string" }, "acsChallengeMandated": { "type": "boolean" }, "acsDecConInd": { "type": "boolean" }, "acsOperatorId": { "type": "string" }, "acsReferenceNumber": { "type": "string" }, "acsRenderingType": { "type": "object", "properties": { "acsInterface": { "type": "string" }, "acsUiTemplate": { "type": "string" } } }, "acsSignedContent": { "type": "string" }, "acsTransId": { "type": "string" }, "acsURL": { "type": "string" }, "authenticationType": { "type": "string" }, "authenticationValue": { "type": "string" }, "broadInfo": { "type": "string" }, "cardholderInfo": { "type": "string" }, "dsReferenceNumber": { "type": "string" }, "dsTransId": { "type": "string" }, "eci": { "type": "string" }, "messageExtension": { "type": "string" }, "messageType": { "type": "string" }, "messageVersion": { "type": "string" }, "sdkTransId": { "type": "string" }, "transStatus": { "type": "string" }, "transStatusReason": { "type": "string" }, "whiteListStatus": { "type": "string" }, "whiteListStatusSource": { "type": "string" }, "challengeRequest": { "type": "object", "properties": { "threeDSServerTransId": { "type": "string" }, "acsTransId": { "type": "string" }, "challengeWindowSize": { "type": "string" }, "messageVersion": { "type": "string" }, "messageType": { "type": "string" } } }, "base64EncodedChallengeRequest": { "type": "string" }, "threeDSCompInd": { "type": "string" } } }, "cardDirectResponse": { "type": "object", "title": "card", "properties": { "cardHolderName": { "type": "string", "description": "The name of the cardholder as it appears on the payment card." }, "pseudoCardNumber": { "type": "string", "description": "Pseudo card number generated by Axepta Online, if the service is activated." }, "first6Digits": { "type": "string", "description": "First 6 digits of card." }, "last4Digits": { "type": "string", "description": "Last 4 digits of the card." }, "expiryDate": { "type": "string", "description": "The expiration date of the card in YYYYMM format." }, "brand": { "type": "string", "description": "The brand or network of the card, such as \"visa\", \"mastercard\"." }, "product": { "type": "string", "description": "Card product name (if available) (e.g. 'Business Premium Debit')." }, "source": { "type": "string", "description": "Card funding source (if available).", "enum": [ "DEBIT", "CREDIT", "DEFERRED_DEBIT", "PREPAID", "CHARGE" ] }, "type": { "type": "string", "description": "The card type specifies the program, application or card level attached to the card if any (e.g. Classic, Standard, Gold, Business etc.)." }, "issuer": { "type": "string", "description": "Card issuer (if available)." }, "country": { "type": "string", "description": "Country the card was issued in." }, "bin": { "$ref": "#/components/schemas/bin" }, "versioningData": { "$ref": "#/components/schemas/versioningDataObjectResponse" }, "fraudData": { "$ref": "#/components/schemas/fraudPreventionObjectResponse" }, "authenticationData": { "$ref": "#/components/schemas/authenticationResultObjectResponse" }, "schemeReferenceId": { "type": "string", "description": "Unique identifier assigned by card schemes that is required to be sent in subsequent credential on file transactions." }, "providerApprovalCode": { "type": "string", "description": "Approval code of the transaction." }, "providerResponseCode": { "type": "string", "description": "Provider response code." }, "providerResponseMessage": { "type": "string", "description": "Provider response text." }, "providerTransactionId": { "type": "string", "description": "Transaction ID assigned by the provider." }, "providerToken": { "type": "string", "description": "Provider's token." }, "providerMerchantId": { "type": "string", "description": "Provider Merchant ID." }, "providerTerminalId": { "type": "string", "description": "Provider Terminal ID." }, "providerOrderId": { "type": "string", "description": "Provider Order ID." }, "issuerResponseCode": { "type": "string", "description": "Issuer response code." }, "issuerResponseMessage": { "type": "string", "description": "Issuer response text." } } }, "googlePayDirectResponse": { "type": "object", "title": "googlePay", "properties": { "schemeReferenceId": { "type": "string", "description": "Unique identifier assigned by card schemes that is required to be sent in subsequent credential on file transactions." } } }, "klarnaDirectResponse": { "type": "object", "title": "klarna", "properties": { "accessToken": { "type": "string", "description": "Client token from Klarna. In order to be able to subsequently show the Klarna widgets, the Klarna JavaScript-API must be initialized with this token." }, "providerResponseCode": { "type": "string", "description": "Response code from Klarna." }, "provideResponseText": { "type": "string", "description": "Response description from Klarna." } } }, "payPalDirectResponse": { "type": "object", "title": "payPal", "properties": { "orderId": { "type": "string", "description": "Unique order identifier assigned by Paypal that should be used to construct the URL for the smart button\t." } } }, "allowedPaymentMethods": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Available payment method. Possible values: \"Invoice\", \"Account\", \"Installment\", \"Consolidatedinvoice\"." }, "account": { "type": "object", "properties": { "profileNo": { "type": "number", "description": "Account profile number." } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "campaignNo": { "type": "number", "description": "Campaign number." }, "description": { "type": "string", "description": "Campaign description." } } } }, "installment": { "type": "object", "properties": { "basketAmount": { "type": "string", "description": "Available payment method.", "enum": [ "INVOICE", "ACCOUNT", "INSTALLMENT", "CONSOLIDATED_INVOICE" ] }, "numberOfInstallments": { "type": "number", "description": "Number of installments." }, "installmentAmount": { "type": "string", "description": "Installment amount for each month." }, "firstInstallmentAmount": { "type": "string", "description": "First installment amount." }, "lastInstallmentAmount": { "type": "string", "description": "Final installment amount." }, "interestRate": { "type": "string", "description": "Interest rate." }, "effectiveInterestRate": { "type": "string", "description": "Effective interest rate." }, "effectiveAnnualPercentageRate": { "type": "string", "description": "Effective annual percentage." }, "totalInterestAmount": { "type": "string", "description": "Total interest rate." }, "startupFee": { "type": "string", "description": "Starting fee." }, "monthlyFee": { "type": "string", "description": "Monthly fee." }, "totalAmount": { "type": "string", "description": "Total amount." }, "installmentProfileNumber": { "type": "string", "description": "Installment profile number." }, "readMore": { "type": "string", "description": "Further information about the installment process." } } }, "legalInfo": { "type": "object", "properties": { "requiresCustomerConsent": { "type": "number", "description": "\"true\", if customer consent is required." }, "termsAndConditionsUrl": { "type": "string", "description": "URL to Terms and Conditions." }, "privacyStatementUrl": { "type": "string", "description": "URL to Privacy Statement." }, "bgb507Url": { "type": "string", "description": "URL to § 507 BGB." }, "text": { "type": "string", "description": "Legal text." } } } } } }, "billingAddressResponse": { "type": "object", "properties": { "country": { "type": "string", "description": "2 character ISO country code of billing address.", "enum": [ "NO", "SE", "FI", "DK", "DE", "AT", "CH", "NL", "BE" ] }, "postalCode": { "type": "string", "description": "Postal code of billing address." }, "city": { "type": "string", "description": "City of billing address." }, "streetName": { "type": "string", "description": "Street name of billing address." }, "streetNumber": { "type": "string", "description": "Street number of billing address." }, "addressLine2": { "type": "string", "description": "Street number addition." }, "addressLine3": { "type": "string", "description": "Responsible person for dispatch of shipment." } } }, "shippingAddressResponse": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Shipping country code." }, "postalCode": { "type": "string", "description": "Shipping postal code." }, "city": { "type": "string", "description": "Shipping city." }, "streetName": { "type": "string", "description": "Shipping street." }, "streetNumber": { "type": "string", "description": "Shipping street number." }, "addressLine2": { "type": "string", "description": "Street number addition." }, "addressLine3": { "type": "string", "description": "Responsible person for dispatch of shipment." } } }, "paymentDirectResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/order" }, "customerInfo": { "$ref": "#/components/schemas/getDetailsCustomerInfo" }, "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardDirectResponse" }, "googlePay": { "$ref": "#/components/schemas/googlePayDirectResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaDirectResponse" }, "payPal": { "$ref": "#/components/schemas/payPalDirectResponse" } } } } } ] }, "cardErrorResponse": { "type": "object", "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Provider response code." }, "providerResponseMessage": { "type": "string", "description": "Provider response text." }, "issuerResponseCode": { "type": "string", "description": "Issuer response code." }, "issuerResponseMessage": { "type": "string", "description": "Issuer response text." } } }, "klarnaErrorResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna\t." }, "providerResponseText": { "type": "string", "description": "Response description from Klarna\t." } } }, "paymentErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardErrorResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaErrorResponse" } } } } } ] }, "creditCardConfirm": { "type": "object", "title": "card", "properties": { "eventToken": { "type": "string", "description": "Defines specific use cases of card payments, if applicable.\n- DELAYED_SHIPMENT: Passed to confirm the payment after the shipment is sent.\n- ORDER: Pass this to confirm the payment if you created the payment previously purely for authentication. ", "enum": [ "DELAYED_SHIPMENT", "ORDER" ] } } }, "klarnaConfirm": { "type": "object", "title": "klarna", "required": [ "accessToken" ], "properties": { "accessToken": { "type": "string", "description": "Client token from Klarna received as a response to Create Payment request. Note: Access token is valid for 60 minutes. If you attempt to initiate confirm payment after 60 minutes, it will be rejected by Klarna." } } }, "paymentConfirm": { "title": "paymentMethods", "properties": { "card": { "$ref": "#/components/schemas/creditCardConfirm" }, "klarna": { "$ref": "#/components/schemas/klarnaConfirm" } } }, "confirmRequest": { "type": "object", "title": "ConfirmRequest", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "amount": { "$ref": "#/components/schemas/amount" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "order": { "$ref": "#/components/schemas/order" }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "paymentMethods": { "$ref": "#/components/schemas/paymentConfirm" } } }, "klarnaConfirmResponse": { "type": "object", "title": "klarna", "properties": { "providerTransactionId": { "type": "string", "description": "Transaction ID from Klarna." }, "billingAgreementId": { "type": "string", "description": "Consumer token from Klarna. This information is returned only when the initial request was sent with credentialOnFile.type as recurring and credentialOnFile.initialPayment as true." }, "redirectUrl": { "type": "string", "description": "The customer must be forwarded to this URL so that Klarna can place a Cookie." }, "providerResponseCode": { "type": "string", "description": "Response code from Klarna" }, "providerResponseText": { "type": "string", "description": "Response description from Klarna." } } }, "payPalConfirmResponse": { "type": "object", "title": "payPal", "properties": { "providerResponseCode": { "type": "number", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." } } }, "confirmResponse": { "title": "ConfirmResponse", "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/order" }, "customerInfo": { "$ref": "#/components/schemas/getDetailsCustomerInfo" }, "paymentMethods": { "properties": { "klarna": { "$ref": "#/components/schemas/klarnaConfirmResponse" }, "payPal": { "$ref": "#/components/schemas/payPalConfirmResponse" } } } } } ] }, "confirmErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "klarna": { "$ref": "#/components/schemas/klarnaErrorResponse" } } } } } ] }, "incrementalRequest": { "type": "object", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "amount": { "$ref": "#/components/schemas/amount" }, "duration": { "type": "number", "description": "Indicates the additional number of days to be added to the stay or rental. Valid only for merchants operating in specific industries like Hotel/Car rental." }, "order": { "$ref": "#/components/schemas/order" } } }, "incrementalResponse": { "title": "IncrementalResponse", "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Transaction ID provided by you in the request." }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "refNr": { "type": "string", "description": "Reference number provided by you in the request." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "paymentMethods": { "type": "object" } } }, "incrementalErrorResponse": { "title": "IncrementalResponse", "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Transaction ID provided by you in the request." }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "refNr": { "type": "string", "description": "Reference number provided by you in the request." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "paymentMethods": { "type": "object" } } }, "paymentReversal": { "title": "paymentMethods" }, "reversalRequest": { "type": "object", "title": "ReversalRequest", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "amount": { "$ref": "#/components/schemas/amount" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "order": { "$ref": "#/components/schemas/order" }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "paymentMethods": { "$ref": "#/components/schemas/paymentReversal" } } }, "cardReversalResponse": { "type": "object", "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay." }, "providerResponseText": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED." }, "providerTransactionId": { "type": "string", "description": "Provider transaction ID. Returned only when Acquirer is Clearhaus." }, "providerApprovalCode": { "type": "number", "description": "Approval Code returned by acquirer." } } }, "klarnaReversalResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna." }, "providerResponseText": { "type": "string", "description": "Response description from Klarna." } } }, "payPalReversalResponse": { "type": "object", "title": "payPal", "properties": { "providerResponseCode": { "type": "string", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." } } }, "reversalResponse": { "title": "ReversalResponse", "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardReversalResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaReversalResponse" }, "payPal": { "$ref": "#/components/schemas/payPalReversalResponse" } } } } } ] }, "cardErrorResponseObject": { "type": "object", "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay." }, "providerResponseText": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED." } } }, "reversalErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardErrorResponseObject" }, "klarna": { "$ref": "#/components/schemas/klarnaErrorResponse" } } } } } ] }, "captureMethodCapture": { "type": "object", "title": "captureMethod", "properties": { "manual": { "type": "object", "properties": { "currentSequence": { "type": "number", "description": "Represents the sequence number of the current manual capture in a series of captures for a single transaction. Relevant for multiple partial captures." }, "final": { "type": "boolean", "description": "Indicates whether the current manual capture is the final capture for the transaction. Relevant for multiple partial captures.True means final capture.False means not a final capture." }, "total": { "type": "number", "description": "Indicates the total number of partial captures will be sent." } } } } }, "amounts": { "type": "object", "properties": { "grossAmount": { "type": "integer" }, "netAmount": { "type": "integer" }, "taxAmount": { "type": "integer" } } }, "tax": { "type": "object", "properties": { "taxRate": { "type": "number" }, "taxTypeIndicator": { "type": "string", "enum": [ "ValueAddedTax", "SalesTax", "Other" ] } } }, "enhancedDataCommon": { "type": "object", "title": "common", "required": [ "amounts" ], "properties": { "amounts": { "$ref": "#/components/schemas/amounts" }, "tax": { "$ref": "#/components/schemas/tax" } } }, "enhancedDataAddress": { "type": "object", "title": "address", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" } } }, "rentalDetails": { "type": "object", "required": [ "salesIndicator", "folioNumber" ], "properties": { "salesIndicator": { "type": "string", "enum": [ "D", "F", "R" ] }, "rentalRate": { "type": "string" }, "orderNumber": { "type": "string" }, "folioNumber": { "type": "string" }, "serviceDescription": { "type": "string" }, "oneWayServiceCharge": { "type": "integer" } } }, "extraCharges": { "type": "object", "properties": { "amount": { "type": "integer" }, "reason": { "type": "string", "enum": [ "None", "Fuel", "ExtraMileage", "LateReturn", "OneWayService", "ParkingViolation" ] } } }, "pointOfSale": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "carRentalCommon": { "type": "object", "title": "common", "required": [ "rentalAgreementNumber", "rentalStartDate", "rentalStartTime", "pickupLocation", "returnDate", "returnTime", "dropOffLocation", "daysHired", "carClass", "carRegistrationNumber", "renterName", "reservationNumber", "rentalDetails" ], "properties": { "rentalAgreementNumber": { "type": "string" }, "rentalStart": { "type": "string", "format": "date", "description": "Date and Time are both passed." }, "pickupLocation": { "$ref": "#/components/schemas/enhancedDataAddress" }, "return": { "type": "string", "format": "date", "description": "Date and Time are both passed." }, "dropOffLocation": { "$ref": "#/components/schemas/enhancedDataAddress" }, "daysHired": { "type": "integer" }, "carClass": { "type": "string" }, "carRegistrationNumber": { "type": "string" }, "renterName": { "type": "string" }, "renterAddress": { "$ref": "#/components/schemas/enhancedDataAddress" }, "noShowIndicator": { "type": "boolean" }, "reservationNumber": { "type": "string" }, "rentalDetails": { "$ref": "#/components/schemas/rentalDetails" }, "extraCharges": { "$ref": "#/components/schemas/extraCharges" }, "pointOfSale": { "$ref": "#/components/schemas/pointOfSale" } } }, "person": { "type": "object", "properties": { "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" } } }, "rentalInformation": { "type": "object", "required": [ "carMake", "milesDriven", "driver", "carRentalCompanyId" ], "properties": { "carMake": { "type": "string" }, "departureDate": { "type": "string", "format": "date", "description": "In format: YYYY-MM-DD" }, "customerOrderNumber": { "type": "string" }, "costPerMile": { "type": "integer" }, "milesDriven": { "type": "integer" }, "driver": { "$ref": "#/components/schemas/person" }, "vehicleGroup": { "type": "string" }, "carRentalCompanyId": { "type": "string", "enum": [ "D", "F", "G", "H", "M", "O", "P", "T", "W", "Y", "Z" ] }, "fuelConsumption": { "type": "integer" } } }, "billingAndInvoiceInformation": { "type": "object", "required": [ "countryCode" ], "properties": { "accountingUnit": { "type": "string" }, "businessUnit": { "type": "string" }, "actionNumber": { "type": "string" }, "voucherNumber": { "type": "string" }, "department": { "type": "string" }, "discountNumber": { "type": "string" }, "internalAccountNumber": { "type": "string" }, "costCenter": { "type": "string" }, "customerNumber": { "type": "string" }, "customerReference": { "type": "string" }, "employeeNumber": { "type": "string" }, "projectNumber": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date", "description": "In format: YYYY-MM-DD" }, "invoiceNumber": { "type": "string" }, "destination": { "type": "string" }, "taxRegistrationNumber": { "type": "string" }, "comments": { "type": "string" }, "misc": { "type": "string" }, "countryCode": { "type": "string" } } }, "mileageUnit": { "type": "string", "enum": [ "Km", "Mi" ] }, "hotelBookingDetails": { "type": "object", "properties": { "name": { "type": "string" }, "checkInDate": { "type": "string", "format": "date", "description": "In format: YYYY-MM-DD" }, "locationCity": { "type": "string" }, "roomNights": { "type": "number" } } }, "carSharing": { "type": "object", "required": [ "amounts", "tax", "taxTypeIndicator", "documentNumber", "serviceDescription" ], "properties": { "amounts": { "$ref": "#/components/schemas/amounts" }, "nonVATableNetAmount": { "type": "integer" }, "tax": { "$ref": "#/components/schemas/tax" }, "taxTypeIndicator": { "type": "string", "enum": [ "NoVat", "NonDeductibleCityVAT", "NonDeductibleState", "DeductibleCityVAT", "DeductibleState", "DeductibleNationalVAT", "EUReverseCharge" ] }, "documentNumber": { "type": "string", "description": "Size: 10, internal document number of the related service as printed on the voucher, train-ticket, etc." }, "serviceDescription": { "type": "string", "description": "Size: 135, will be parsed into 3 sub-fields with 45 digits each" }, "serviceType": { "type": "string" }, "hotelBookingDetails": { "$ref": "#/components/schemas/hotelBookingDetails" } } }, "additionalAmount": { "type": "object", "required": [ "amountTypeCode", "transactionType", "amounts", "tax" ], "properties": { "amountTypeCode": { "type": "string" }, "transactionType": { "type": "string", "enum": [ "Debit", "Credit" ] }, "amounts": { "$ref": "#/components/schemas/amounts" }, "tax": { "$ref": "#/components/schemas/tax" } } }, "supplier": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "taxRegistrationNumber": { "type": "string" }, "matchCode": { "type": "string" }, "legalName": { "type": "string" }, "address": { "$ref": "#/components/schemas/enhancedDataAddress" } } }, "amexInvoice": { "type": "object", "title": "invoice", "properties": { "number": { "type": "string" }, "date": { "type": "string", "format": "date", "description": "In format: YYYY-MM-DD" }, "associatedNumber": { "type": "string" } } }, "provider": { "type": "object", "required": [ "travelAgencyCode", "travelOfficeCode", "transactionReference", "invoiceIndicator", "invoiceNumber", "invoiceDate" ], "properties": { "travelAgencyCode": { "type": "string" }, "travelOfficeCode": { "type": "string" }, "transactionReference": { "type": "string" }, "invoiceIndicator": { "type": "string", "enum": [ "N", "Y", "R" ] }, "invoice": { "$ref": "#/components/schemas/amexInvoice" }, "iataNumber": { "type": "integer" }, "serviceCentre": { "type": "string" }, "terminalId": { "type": "string" }, "providerReference": { "type": "string" }, "electronicInvoiceLocation": { "type": "string" } } }, "bookingSystem": { "type": "object", "properties": { "bookingSystemReference": { "type": "string" }, "invoice": { "$ref": "#/components/schemas/amexInvoice" } } }, "reference": { "type": "object", "required": [ "statementField", "typeCode", "data" ], "properties": { "statementField": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07" ], "description": "The number indicates which reference field on the statement that the customer wishes to see this data in" }, "typeCode": { "type": "string", "enum": [ "CostCentre", "EmployeeId", "TravelBookerName", "JobNumber", "ProjectCode", "BusinessUnit", "Other" ] }, "data": { "type": "string" } } }, "amexLineItem": { "type": "object", "title": "lineItem", "required": [ "number", "description", "reference", "statementIndicator", "grossAmount", "transactionType", "additionalAmounts" ], "properties": { "number": { "type": "integer" }, "description": { "type": "string" }, "reference": { "type": "string" }, "statementIndicator": { "type": "string", "enum": [ "N", "Y", "R" ] }, "grossAmount": { "type": "integer" }, "transactionType": { "type": "string", "enum": [ "Debit", "Credit" ] }, "additionalAmounts": { "type": "array", "items": { "$ref": "#/components/schemas/additionalAmount" } } } }, "amex": { "type": "object", "required": [ "additionalAmounts", "destination", "departureDate", "traveller", "supplier", "provider", "CustomerReference" ], "properties": { "cancellationReason": { "type": "string" }, "bookingSourceCode": { "type": "string", "enum": [ "OnlineBooking", "SelfBookingTool", "AfterHoursBooking", "PhoneBooking" ] }, "mediaCode": { "type": "string", "enum": [ "CardmemberSignatureOnFile", "PhoneOrder", "MailOrder", "InternetOrder", "RecurringBilling" ] }, "globalDistributionSystem": { "type": "string", "enum": [ "Amadeus", "Sabre", "Galileo" ] }, "originalAmount": { "type": "integer" }, "originalCurrencyCode": { "type": "string" }, "additionalAmounts": { "type": "array", "items": { "$ref": "#/components/schemas/additionalAmount" } }, "destination": { "type": "string" }, "departureDate": { "type": "string", "format": "date", "description": "In format: YYYY-MM-DD" }, "travellers": { "type": "array", "items": { "$ref": "#/components/schemas/person" } }, "consultant": { "type": "string" }, "mileageUnit": { "$ref": "#/components/schemas/mileageUnit" }, "milesDriven": { "type": "integer" }, "supplier": { "$ref": "#/components/schemas/supplier" }, "provider": { "$ref": "#/components/schemas/provider" }, "bookingSystem": { "$ref": "#/components/schemas/bookingSystem" }, "customerReference": { "type": "array", "items": { "$ref": "#/components/schemas/reference" } }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/amexLineItem" } } } }, "enhancedDataCarRental": { "type": "object", "title": "carRental", "properties": { "common": { "$ref": "#/components/schemas/carRentalCommon" }, "amex": { "$ref": "#/components/schemas/amex" } } }, "cardCapture": { "title": "card", "type": "object", "properties": { "finishAuth": { "type": "boolean", "description": "Transmit value in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Use this parameter only if you are using the additional function ETM (Extended Transactions Managament)." } } }, "shippingInfoMini": { "title": "shippingInfo", "type": "object", "description": "Delivery information (e.g. tracking data)", "properties": { "trackingId": { "type": "string", "description": "Tracking number for the shipment." }, "returnTrackingId": { "type": "string", "description": "Tracking number for the return shipment." }, "returnShippingCompany": { "type": "string", "description": "Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the Carrier list: https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/" } } }, "shippingInfo": { "allOf": [ { "$ref": "#/components/schemas/shippingInfoMini" }, { "type": "object", "description": "Delivery information (e.g. tracking data)", "properties": { "shippingCompany": { "type": "string", "description": "Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the Carrier list: https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/" }, "shippingMethod": { "type": "string", "description": "Shipping method.", "enum": [ "PICK_UP_STORE", "HOME", "BOX_REG", "BOX_UNREG", "PICK_UP_POINT", "OWN", "POSTAL", "DHL_PACKSTATION", "DIGITAL", "UNDEFINED", "PICK_UP_WAREHOUSE", "CLICK_COLLECT", "PALLET_DELIVERY_PICK_UP_POINT", "PALLET_DELIVERY" ] }, "trackingUrl": { "type": "string", "description": "URL where the customer can track their shipment." }, "returnTrackingUrl": { "type": "string", "description": "URL where the customer can track the return shipment." } } } ] }, "klarnaCapture": { "title": "klarna", "properties": { "completeType": { "type": "string", "description": "With this parameter during a partial capture it is possible to reverse the remaining amount simultaneously. Possible value \"YES\". If the order was processed completely this parameter will cause an error, because a remaining amount of 0 cannot be reversed." }, "shippingInfo": { "$ref": "#/components/schemas/shippingInfo" } } }, "payPalCapture": { "title": "payPal", "properties": { "completeType": { "type": "boolean", "description": "Defines the completeness of capture for an open Paypal order. If sent as true, order is closed for capture. Reason: a 115% capture is permissible on the part of PayPal. If a capture reached 100%, Axepta Online automatically sends a request to close the payment." } } }, "shippingInfoCapture": { "type": "object", "title": "shipping", "required": [ "type", "shippingCompany", "trackingId" ], "properties": { "type": { "type": "string", "description": "Dispatch type.", "enum": [ "SHIPMENT", "RETURN" ] }, "shippingCompany": { "type": "string", "description": "Shipping company" }, "trackingId": { "type": "string", "description": "Unique TrackingID" } } }, "paymentCapture": { "title": "paymentMethods", "properties": { "card": { "$ref": "#/components/schemas/cardCapture" }, "klarna": { "$ref": "#/components/schemas/klarnaCapture" }, "payPal": { "$ref": "#/components/schemas/payPalCapture" } }, "type": "object" }, "captureRequest": { "type": "object", "title": "CaptureRequest", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64, "example": "test-TransactionId01" }, "amount": { "$ref": "#/components/schemas/amount" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "order": { "$ref": "#/components/schemas/order" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "captureMethod": { "$ref": "#/components/schemas/captureMethodCapture" }, "enhancedData": { "type": "object", "required": [ "common" ], "properties": { "common": { "$ref": "#/components/schemas/enhancedDataCommon" }, "carRental": { "$ref": "#/components/schemas/enhancedDataCarRental" } } }, "paymentMethods": { "$ref": "#/components/schemas/paymentCapture" } } }, "cardCaptureResponse": { "type": "object", "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay." }, "providerResponseText": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED." }, "providerTransactionId": { "type": "string", "description": "Provider transaction ID. Returned only when Acquirer is Clearhaus." }, "providerApprovalCode": { "type": "number", "description": "Approval Code returned by acquirer." } } }, "klarnaCaptureResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna." }, "providerResponseText": { "type": "string", "description": "Response description from Klarna." }, "invoiceNumber": { "type": "string", "description": "Invoice/booking number from Klarna. This number is needed for example for resending the E-Mail with payment and order information." } } }, "payPalCaptureResponse": { "type": "object", "title": "payPal", "properties": { "providerResponseCode": { "type": "number", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." }, "providerTransactionId": { "type": "string", "description": "Unique PayPal-generated Capture ID. The value is required for a refund after several partial captures." } } }, "captureResponse": { "title": "CaptureResponse", "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardCaptureResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaCaptureResponse" }, "payPal": { "$ref": "#/components/schemas/payPalCaptureResponse" } } } } } ] }, "payPalErrorResponse": { "type": "object", "title": "payPal", "properties": { "providerDeclineCategory": { "type": "string", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." } } }, "captureErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardErrorResponseObject" }, "payPal": { "$ref": "#/components/schemas/payPalErrorResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaErrorResponse" } } } } } ] }, "cardCredit": { "title": "card", "properties": { "providerTransactionId": { "type": "string", "description": "Transaction ID returned by the provider in the capture response. This is needed for the use cases of multiple captures and if you want to refund a specific capture. If the parameter is not submitted then the last capture will be credited." } } }, "payPalCredit": { "title": "payPal", "properties": { "providerTransactionId": { "type": "string", "description": "Transaction ID returned by Paypal in the capture response. This is needed for the use cases of multiple captures and if you want to refund a specific capture." } } }, "paymentCredit": { "title": "paymentMethods", "properties": { "card": { "$ref": "#/components/schemas/cardCredit" }, "payPal": { "$ref": "#/components/schemas/payPalCredit" } } }, "refundRequest": { "type": "object", "title": "RefundRequest", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64, "example": "test-TransactionId01" }, "amount": { "$ref": "#/components/schemas/amount" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "order": { "$ref": "#/components/schemas/order" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "paymentMethods": { "$ref": "#/components/schemas/paymentCredit" } } }, "cardCreditResponse": { "type": "object", "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay." }, "providerResponseText": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED." }, "providerTransactionId": { "type": "string", "description": "Provider transaction ID. Returned only when Acquirer is Clearhaus." } } }, "klarnaCreditResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna." }, "providerResponseText": { "type": "string", "description": "Response description from Klarna." }, "invoiceNumber": { "type": "string", "description": "Invoice/booking number from Klarna. This number is needed for example for resending the E-Mail with payment and order information." } } }, "payPalCreditResponse": { "type": "object", "title": "payPal", "properties": { "providerResponseCode": { "type": "string", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." }, "feeRefundAmount": { "type": "number", "description": "The refunded amount of the PayPal transaction fees." }, "grossRefundAmount": { "type": "number", "description": "Amount refunded to the buyer in this refund transaction." }, "netRefundAmount": { "type": "number", "description": "Amount deducted from your PayPal account to make this refund." } } }, "baseRefundResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardCreditResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaCreditResponse" }, "payPal": { "$ref": "#/components/schemas/payPalCreditResponse" } } } } } ] }, "refundResponse": { "title": "RefundResponse", "allOf": [ { "$ref": "#/components/schemas/baseRefundResponse" }, { "type": "object" } ] }, "bizumErrorResponse": { "type": "object", "title": "bizum", "properties": { "providerResponseText": { "type": "string", "description": "Is returned only if Status=FAILED. Detailed PPRO error message." } } }, "epsErrorResponse": { "type": "object", "title": "eps", "properties": { "providerResponseText": { "type": "string", "description": "Is returned only if Status=FAILED. Detailed PPRO error message." } } }, "unionPayErrorResponse": { "type": "object", "title": "unionPay", "properties": { "providerResponseText": { "type": "string", "description": "Is returned only if Status=FAILED. Detailed PPRO error message." } } }, "weChatErrorResponse": { "type": "object", "title": "weChat", "properties": { "providerResponseText": { "type": "string", "description": "Is returned only if Status=FAILED. Detailed PPRO error message." } } }, "refundErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "bizum": { "$ref": "#/components/schemas/bizumErrorResponse" }, "card": { "$ref": "#/components/schemas/cardErrorResponseObject" }, "eps": { "$ref": "#/components/schemas/epsErrorResponse" }, "payPal": { "$ref": "#/components/schemas/payPalErrorResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaErrorResponse" }, "unionPay": { "$ref": "#/components/schemas/unionPayErrorResponse" }, "weChat": { "$ref": "#/components/schemas/weChatErrorResponse" } } } } } ] }, "billingAddressRefundPayment": { "title": "billingAddress", "allOf": [ { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of billing address." }, "lastName": { "type": "string", "description": "Last name of billing address." } } }, { "$ref": "#/components/schemas/billingAddress" } ] }, "phone": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Country code of the phone number." }, "number": { "type": "string", "description": "Phone number." } } }, "customerInfoCreditEx": { "type": "object", "title": "customerInfo", "required": [ "email" ], "properties": { "merchantCustomerId": { "type": "string", "description": "A unique identifier for the customer, assigned by the merchant's system." }, "customerType": { "type": "string", "description": "Specifies the type of customer, such as \"individual\" or \"business\"." }, "firstName": { "type": "string", "description": "First name of the customer." }, "lastName": { "type": "string", "description": "Last name (surname) of the customer." }, "email": { "type": "string", "description": "Email address of the customer." }, "phone": { "$ref": "#/components/schemas/phone" }, "birthDate": { "type": "string", "description": "Birth date of the customer in YYYY-MM-DD format." } } }, "browserInfoCreditEx": { "type": "object", "title": "browserInfo", "properties": { "acceptHeaders": { "type": "string", "description": "Exact content of the HTTP accept headers as sent from the customer’s browser." }, "ipAddres": { "type": "string", "description": "IP address of the browser as returned by the HTTP headers." }, "sessionId": { "type": "string", "description": "Customer´s Session ID." } } }, "cardRefund": { "title": "card", "required": [ "number", "cardholderName", "expiryDate", "brand" ], "properties": { "number": { "type": "string", "description": "The card number or the pseudo card number of the payment card." }, "cardholderName": { "type": "string", "description": "The name of the cardholder as it appears on the payment card." }, "expiryDate": { "type": "string", "description": "The expiration date of the card in YYYYMM format." }, "brand": { "type": "string", "description": "The brand or network of the card, such as \"visa\", \"mastercard\"." }, "securityCode": { "type": "string", "description": "The Card Security Code, also known as CVV or CVC." }, "paymentOfWinnings": { "type": "boolean", "description": "In the case of the acquirer EMS (Omnipay) the merchant can control CFT credit notes in this way.Transfer PaymentOfWinnings=True to credit a win rather than simply repaying a paid amount." }, "paymentData": { "type": "object", "description": "Additional data if PaymentOfWinnings=True.", "properties": { "senderData": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Contains the sender’s bank account number from which the funds are to be taken." }, "name": { "type": "string", "description": "Contains the name of the person or business for the account from which funds are to be taken." }, "address": { "type": "string", "description": "Contains the address of the person or business for the account from which funds are to be taken." }, "city": { "type": "string", "description": "Contains the city of the person or business for the account from which funds are to be taken." }, "countryCode": { "type": "string", "description": "Contains the country of the person or business’s account from which funds are to be taken. To be sent in number 3 Digit ISO standard." }, "transactionMethod": { "type": "string", "enum": [ "CREDIT", "DEBIT", "PREPAID", "CASH", "DEPOSIT_ACCOUNT", "MOBILE_MONEY_ACCOUNT" ], "description": "It indicates the method used by the sender to fund a Payment of winning transaction." }, "accountType": { "type": "string", "enum": [ "RTN_AND_BANK_ACCOUNT_NUMBER", "IBAN", "CARD_ACCOUNT", "IBAN_AND_BIC" ] } } }, "recipientData": { "type": "object", "properties": { "name": { "type": "string" } } } } } } }, "accountRefund": { "type": "object", "title": "account", "required": [ "number", "accountHolderName" ], "properties": { "number": { "type": "string", "description": "International Bank Account Number." }, "code": { "type": "string", "description": "Bank Identifier Code." }, "bankName": { "type": "string", "description": "Bank name." }, "accountHolderName": { "type": "string", "description": "Account holder name." } } }, "paymentMethods": { "properties": { "card": { "$ref": "#/components/schemas/cardRefund" } } }, "creditExRequest": { "type": "object", "title": "CreditExRequest", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64, "example": "test-TransactionId01" }, "amount": { "$ref": "#/components/schemas/amount" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "billingAddress": { "$ref": "#/components/schemas/billingAddressRefundPayment" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/customerInfoCreditEx" }, "browserInfo": { "$ref": "#/components/schemas/browserInfoCreditEx" }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by the merchant to store extra information about the transaction. This is a set of JSON key value pairs passed by the merchant. Axepta Online will return the data as it is in the response." }, "paymentMethods": { "$ref": "#/components/schemas/paymentMethods" } } }, "cardCreditExResponse": { "title": "card", "properties": { "providerResponseCode": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay." }, "providerResponseText": { "type": "string", "description": "Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED." }, "providerTransactionId": { "type": "string", "description": "Provider transaction ID. Returned only when Acquirer is Clearhaus." }, "providerApprovalCode": { "type": "number", "description": "Approval code returned by provider." } } }, "baseCreditExResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardCreditExResponse" } } } } } ] }, "creditExResponse": { "title": "CreditExResponse", "allOf": [ { "$ref": "#/components/schemas/baseCreditExResponse" }, { "type": "object" } ] }, "creditExErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/baseResponse" }, { "type": "object", "properties": { "paymentMethods": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/cardErrorResponseObject" } } } } } ] }, "baseDetailsResponse": { "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment." }, "externalIntegrationId": { "type": "string", "description": "External integration identifier" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." } } }, "amountPaymentDetails": { "title": "amount", "type": "object", "properties": { "value": { "type": "number", "description": "Total order amount in the smallest currency unit, including taxes, shipping costs, discounts, etc." }, "currency": { "type": "string", "description": "3-character ISO currency code." }, "taxTotal": { "type": "number", "description": "Total tax amount." }, "netItemTotal": { "type": "number", "description": "Total net amount of the products as part of the order, excluding shipping costs." }, "netShippingAmount": { "type": "number", "description": "Net shipping costs." }, "grossShippingAmount": { "type": "number", "description": "Gross shipping costs." }, "netDiscount": { "type": "number", "description": "Net discount amount." }, "grossDiscount": { "type": "number", "description": "Gross discount amount." }, "capturedValue": { "type": "number", "description": "Amount captured" }, "refundedValue": { "type": "number", "description": "Amount refunded" } } }, "urls": { "type": "object", "properties": { "return": { "type": "string", "format": "uri", "description": "The URL to which the customer is redirected after successfully completing the payment process." }, "cancel": { "type": "string", "format": "uri", "description": "The URL to which the customer is redirected if they cancel the payment process before completion." }, "webhook": { "type": "string", "format": "uri", "description": "The URL endpoint on the merchant's server that receives asynchronous notifications about the outcome of the payment." } } }, "schemas-billingAddress": { "title": "billingAddress", "type": "object", "properties": { "streetName": { "type": "string", "description": "Street name of billing address." }, "streetNumber": { "type": "string", "description": "Street number of billing address." }, "addressLine2": { "type": "string", "description": "Address line 2 of billing address." }, "addressLine3": { "type": "string", "description": "Address line 3 of billing address." }, "city": { "type": "string", "description": "City of billing address." }, "state": { "type": "string", "description": "State of billing address." }, "postalCode": { "type": "string", "description": "Postal code of billing address." }, "country": { "type": "string", "description": "2 character ISO country code of billing address." } } }, "schemas-shippingAddress": { "type": "object", "title": "address", "properties": { "firstName": { "type": "string", "description": "Shipping first name." }, "lastName": { "type": "string", "description": "Shipping last name." }, "streetName": { "type": "string", "description": "Shipping street." }, "streetNumber": { "type": "string", "description": "Shipping street number." }, "addressLine2": { "type": "string", "description": "Address line 2 of shipping address." }, "addressLine3": { "type": "string", "description": "Address line 3 of shipping address." }, "city": { "type": "string", "description": "Shipping city." }, "state": { "type": "string", "description": "State of shipping address." }, "country": { "type": "string", "description": "Shipping country code." }, "postalCode": { "type": "string", "description": "Shipping postal code." }, "phone": { "type": "object", "description": "Phone number associated with the shipping address.", "properties": { "countryCode": { "type": "string", "description": "Country Code/Area code of the phone number." }, "number": { "type": "string", "description": "Phone number associated with the shipping address." } } } } }, "schemas-shippingAddressCreatePayment": { "type": "object", "title": "shipping", "properties": { "address": { "allOf": [ { "$ref": "#/components/schemas/schemas-shippingAddress" }, { "type": "object" } ] }, "type": { "type": "string", "description": "Shipping method.", "enum": [ "CLICK_AND_COLLECT" ] } } }, "accountBancontactDetails": { "type": "object", "title": "account", "properties": { "paymentGuarantee": { "type": "string", "description": "NONE= no payment guarantee;VALIDATED= customer account valid, but no payment guarantee;FULL= payment guarantee" } } }, "bizumAccount": { "title": "account", "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder." }, "number": { "type": "string", "description": "International Bank Account Number." }, "code": { "type": "string", "description": "Bank Identifier Code." }, "accountHolderIdentification": { "type": "string", "description": "Identification of the financial institution of the account holder." }, "accountNumber": { "type": "string", "description": "Customer's account number." }, "bankName": { "type": "string", "description": "Bank name, Bank Code." } } }, "bizumDetailsResponse": { "title": "bizum", "type": "object", "properties": { "account": { "$ref": "#/components/schemas/bizumAccount" }, "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "paymentGuarantee": { "type": "string", "description": "This parameter is only returned if the Status=OK.\n- NONE= no payment guarantee\n- VALIDATED= customer account valid, but no payment guarantee\n- FULL= payment guarantee" }, "providerResponseText": { "type": "string", "description": " Is returned only if Status=FAILED. Detailed error PPRO message." }, "providerTransactionId": { "type": "string", "description": "Unique transaction number from PPRO." } } }, "cardRate": { "type": "object", "title": "rate", "properties": { "exchangeRate": { "type": "number", "description": "Applied exchange rate used for the DCC calculation." }, "markupPercentage": { "type": "number", "description": "Markup percentage applied on top of the base exchange rate." }, "timestamp": { "type": "string", "description": "Timestamp indicating when the DCC rate was generated." } } }, "cardMerchantAmount": { "type": "object", "title": "merchant", "properties": { "value": { "type": "number", "description": "Merchant transaction amount as provided in the request." }, "currency": { "type": "string", "description": "Merchant base currency as provided in the request." } } }, "cardholderAmount": { "type": "object", "title": "cardholder", "properties": { "value": { "type": "number", "description": "Cardholder amount converted from merchant amount, expressed as integer value." }, "currency": { "type": "string", "description": "Cardholder currency (ISO 4217 alphabetic code) determined based on the card BIN." }, "decimalValue": { "type": "number", "description": "Cardholder amount converted from merchant amount, expressed with decimal precision." } } }, "cardAmounts": { "type": "object", "title": "amounts", "properties": { "merchant": { "$ref": "#/components/schemas/cardMerchantAmount" }, "cardholder": { "$ref": "#/components/schemas/cardholderAmount" } } }, "cardDccInfo": { "type": "object", "title": "dccInfo", "properties": { "dccSelected": { "type": "boolean", "description": "Indicates the cardholder chose DCC and the transaction was processed in the cardholder currency." }, "provider": { "type": "string", "description": "DCC service provider identifier." }, "rate": { "$ref": "#/components/schemas/cardRate" }, "amounts": { "$ref": "#/components/schemas/cardAmounts" } } }, "cardDetailsResponse": { "type": "object", "title": "card", "properties": { "cardHolderName": { "type": "string", "description": "The name of the cardholder as it appears on the payment card." }, "pseudoCardNumber": { "type": "string", "description": "Pseudo card number generated by Axepta Online, if the service is activated." }, "first6Digits": { "type": "string", "description": "First 6 digits of card." }, "last4Digits": { "type": "string", "description": "Last 4 digits of the card." }, "expiryDate": { "type": "string", "description": "The expiration date of the card in YYYYMM format." }, "brand": { "type": "string", "description": "The brand or network of the card, such as \"visa\", \"mastercard\"." }, "product": { "type": "string", "description": "Card product name (if available) (e.g. 'Business Premium Debit')." }, "source": { "type": "string", "description": "Card funding source (if available).", "enum": [ "DEBIT", "CREDIT", "DEFERRED_DEBIT", "PREPAID", "CHARGE" ] }, "type": { "type": "string", "description": "The card type specifies the program, application or card level attached to the card if any (e.g. Classic, Standard, Gold, Business etc.)." }, "issuer": { "type": "string", "description": "Card issuer (if available)." }, "country": { "type": "string", "description": "Country the card was issued in." }, "cardholderConsentToStore": { "type": "boolean", "description": "Indicates that the customer explicitly opted in to store their card data for future purchases on the hosted credit card form." }, "bin": { "$ref": "#/components/schemas/bin" }, "versioningData": { "$ref": "#/components/schemas/versioningDataObjectResponse" }, "fraudData": { "$ref": "#/components/schemas/fraudPreventionObjectResponse" }, "authenticationData": { "$ref": "#/components/schemas/authenticationResultObjectResponse" }, "schemeReferenceId": { "type": "string", "description": "Unique identifier assigned by card schemes that is required to be sent in subsequent credential on file transactions." }, "providerApprovalCode": { "type": "string", "description": "Approval code of the transaction." }, "providerResponseCode": { "type": "string", "description": "Provider response code." }, "providerResponseMessage": { "type": "string", "description": "Provider response text." }, "providerTransactionId": { "type": "string", "description": "Transaction ID assigned by the provider." }, "providerToken": { "type": "string", "description": "Provider's token." }, "providerMerchantId": { "type": "string", "description": "Provider Merchant ID." }, "providerTerminalId": { "type": "string", "description": "Provider Terminal ID." }, "providerOrderId": { "type": "string", "description": "Provider Order ID." }, "issuerResponseCode": { "type": "string", "description": "Issuer response code." }, "issuerResponseMessage": { "type": "string", "description": "Issuer response text." }, "dccInfo": { "$ref": "#/components/schemas/cardDccInfo" } } }, "accountDirectDebitDetails": { "type": "object", "title": "account", "properties": { "code": { "type": "string", "description": "Bank identifier code." }, "number": { "type": "string", "description": "International bank account number." }, "pseudoBankNumber": { "type": "string", "description": "Pseudo bank number if the service is active." }, "accountHolderName": { "type": "string", "description": "Account holder name." }, "bankName": { "type": "string", "description": "Bank name." } } }, "accountDetails": { "type": "object", "title": "account", "properties": { "code": { "type": "string", "description": "Bank identifier code." }, "number": { "type": "string", "description": "International bank account number." }, "pseudoBankNumber": { "type": "string", "description": "Pseudo bank number if the service is active." }, "accountHolderName": { "type": "string", "description": "Account holder name." }, "bankName": { "type": "string", "description": "Bank name." } } }, "epsDetailsResponse": { "title": "eps", "type": "object", "properties": { "account": { "$ref": "#/components/schemas/epsAccount" }, "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "paymentGuarantee": { "type": "string", "description": "This parameter is only returned if the Status=OK.\n- NONE= no payment guarantee\n- VALIDATED= customer account valid, but no payment guarantee\n- FULL= payment guarantee" }, "providerResponseText": { "type": "string", "description": " Is returned only if Status=FAILED. Detailed error PPRO message." }, "providerTransactionId": { "type": "string", "description": "Unique transaction number from PPRO." } } }, "googlePayDetailsResponse": { "type": "object", "title": "googlePay", "properties": { "schemeReferenceId": { "type": "string", "description": "Unique identifier assigned by card schemes that is required to be sent in subsequent credential on file transactions" } } }, "accountIdealDetails": { "type": "object", "title": "account", "properties": { "bankName": { "type": "string", "description": "Bank name." }, "accountHolderName": { "type": "string", "description": "Account holder name." }, "number": { "type": "string", "description": "International Bank Account Number." }, "code": { "type": "string", "description": "Bank Identifier Code." }, "paymentGuarantee": { "type": "string", "description": "NONE= no payment guarantee;VALIDATED= customer account valid, but no payment guarantee;FULL= payment guarantee" } } }, "idealDetailsResponse": { "type": "object", "title": "ideal", "properties": { "account": { "$ref": "#/components/schemas/accountIdealDetails" }, "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "providerResponseText": { "type": "string", "description": "Provider response message." }, "providerTransactionId": { "type": "string", "description": "Provider transaction ID." } } }, "klarnaDetailsResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna" }, "provideResponseText": { "type": "string", "description": "Response description from Klarna." }, "billingAgreementId": { "type": "string", "description": "Billing Agreement ID from Klarna which must be additionally transferred for recurring payments. This information is returned only when the initial request was sent with credentialOnFile.type as recurring and credentialOnFile.initialPayment as true." }, "providerTransactionId": { "type": "string", "description": "Reference number from Klarna system." } } }, "mbWayDetailsResponse": { "title": "mbWay", "type": "object", "properties": { "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "paymentGuarantee": { "type": "string", "description": "This parameter is only returned if the Status=OK.\n- NONE= no payment guarantee\n- VALIDATED= customer account valid, but no payment guarantee\n- FULL= payment guarantee" }, "providerResponseText": { "type": "string", "description": " Is returned only if Status=FAILED. Detailed error PPRO message." }, "providerTransactionId": { "type": "string", "description": "Unique transaction number from PPRO." } } }, "payPalDetailsResponse": { "type": "object", "title": "payPal", "properties": { "orderId": { "type": "string", "description": "Unique order identifier assigned by Paypal that should be used to construct the URL for the smart button." }, "providerResponseCode": { "type": "string", "description": "Response code from Paypal." }, "payerStatus": { "type": "string", "description": "Status of buyer.", "enum": [ "VERIFIED", "UNVERIFIED" ] }, "infoText": { "type": "string", "description": "Response message to the merchant." }, "payerId": { "type": "string", "description": "Unique identification number of customer account at PayPal." }, "grossAmount": { "type": "string", "description": "Final amount charged, including any shipping and taxes from your Merchant profile." }, "feeAmount": { "type": "string", "description": "PayPal fee amount charged for the transaction." }, "settleAmount": { "type": "string", "description": "Amount deposited in your PayPal account after a currency conversion, if any." }, "taxAmount": { "type": "string", "description": "Tax charged on the transaction." }, "exchangeRate": { "type": "string", "description": "Exchange rate if a currency conversion occurred." }, "mcFee": { "type": "string", "description": "Transaction fee associated with the payment. mc_gross minus mc_fee equals the amount deposited into the receiver_email account. Equivalent to payment_fee for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction fee." }, "mcGross": { "type": "string", "description": "Full amount of the customer's payment before transaction fee is subtracted. Equivalent to payment_gross for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction." }, "providerCaptureId": { "type": "string", "description": "Unique PayPal-generated Capture ID. The value is required for a refund after several partial captures." } } }, "unionPayDetailsResponse": { "title": "unionPay", "type": "object", "properties": { "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "paymentGuarantee": { "type": "string", "description": "This parameter is only returned if the Status=OK.\n- NONE= no payment guarantee\n- VALIDATED= customer account valid, but no payment guarantee\n- FULL= payment guarantee" }, "providerResponseText": { "type": "string", "description": " Is returned only if Status=FAILED. Detailed error PPRO message." }, "providerTransactionId": { "type": "string", "description": "Unique transaction number from PPRO." } } }, "weroDetailsResponse": { "type": "object", "title": "wero", "properties": { "walletId": { "type": "string", "description": "EPI provided Wallet ID identifying the Consumer Wallet used during a Wero payment." }, "payplan": { "type": "string", "description": "Describes the payment type performed i.e SingleImmediate or Event Dependent etc." }, "consentId": { "type": "string", "description": "EPI assigned Consent ID." }, "paymentId": { "type": "string", "description": "EPI assigned Payment Request ID." }, "captureId": { "type": "string", "description": "EPI assigned Capture ID." }, "refundId": { "type": "string", "description": "EPI assigned Refund ID." } } }, "weChatDetailsResponse": { "title": "weChat", "type": "object", "properties": { "paymentPurpose": { "type": "string", "description": "Purpose of payment." }, "paymentGuarantee": { "type": "string", "description": "This parameter is only returned if the Status=OK.\n- NONE= no payment guarantee\n- VALIDATED= customer account valid, but no payment guarantee\n- FULL= payment guarantee" }, "providerResponseText": { "type": "string", "description": " Is returned only if Status=FAILED. Detailed error PPRO message." }, "providerTransactionId": { "type": "string", "description": "Unique transaction number from PPRO." } } }, "paymentDetails": { "title": "paymentMethods", "type": "object", "properties": { "type": { "type": "string", "description": "Indicates the payment method used for this transaction.", "enum": [ "ALIPAY", "AMAZONPAY", "APPLEPAY", "BANCONTACT", "BIZUM", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "FLOAPAY", "GOOGLEPAY", "IDEAL", "INSTANEA", "KLARNA", "MBWAY", "MOBILEPAY", "MULTIBANCO", "MYBANK", "PAYPAL", "PAYU", "PFCONNECT", "PRZELEWY24", "RATEPAY", "RIVERTY", "SWISH", "TWINT", "VIPPSMOBILEPAY", "UNIONPAY", "WECHAT", "WERO" ] }, "bizum": { "$ref": "#/components/schemas/bizumDetailsResponse" }, "card": { "$ref": "#/components/schemas/cardDetailsResponse" }, "eps": { "$ref": "#/components/schemas/epsDetailsResponse" }, "googlePay": { "$ref": "#/components/schemas/googlePayDetailsResponse" }, "ideal": { "$ref": "#/components/schemas/idealDetailsResponse" }, "klarna": { "$ref": "#/components/schemas/klarnaDetailsResponse" }, "mbWay": { "$ref": "#/components/schemas/mbWayDetailsResponse" }, "payPal": { "$ref": "#/components/schemas/payPalDetailsResponse" }, "unionPay": { "$ref": "#/components/schemas/unionPayDetailsResponse" }, "wero": { "$ref": "#/components/schemas/weroDetailsResponse" }, "weChat": { "$ref": "#/components/schemas/weChatDetailsResponse" } } }, "paymentDetailsResponse": { "title": "PaymentDetailsResponse", "allOf": [ { "$ref": "#/components/schemas/baseDetailsResponse" }, { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amountPaymentDetails" }, "language": { "type": "string", "description": "Language code to determine the language of the payment form and customer communication where applicable." }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "credentialOnFile": { "$ref": "#/components/schemas/credentialOnFile" }, "order": { "$ref": "#/components/schemas/order" }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "urls": { "$ref": "#/components/schemas/urls" }, "billingAddress": { "$ref": "#/components/schemas/schemas-billingAddress" }, "shipping": { "$ref": "#/components/schemas/schemas-shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/getDetailsCustomerInfo" }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "fraudData": { "$ref": "#/components/schemas/fraudData" }, "paymentFacilitator": { "$ref": "#/components/schemas/subMerchantPaymentFacilitator" }, "browserInfo": { "$ref": "#/components/schemas/browserInfo" }, "device": { "$ref": "#/components/schemas/device" }, "channel": { "type": "string", "description": "Specifies the sales or interaction channel through which the transaction is initiated.", "enum": [ "ECOM", "MOTO", "APP", "PAYBYLINK", "POS" ] }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "paymentMethods": { "$ref": "#/components/schemas/paymentDetails" } } } ] }, "paymentNotFoundResponse": { "title": "response", "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." } } }, "amountMini": { "title": "amount", "type": "object", "properties": { "value": { "type": "number" }, "currency": { "type": "string", "description": "3-character ISO currency code." } } }, "updateCustomerInfo": { "type": "object", "title": "customerInfo", "description": "Information about the customer.", "properties": { "title": { "type": "string", "description": "Any additional title or designation associated with the customer, such as \"Dr\", etc." }, "firstName": { "type": "string", "description": "First name of the customer." }, "lastName": { "type": "string", "description": "Last name (surname) of the customer." }, "companyName": { "type": "string", "description": "Name of the company if the customer is a business entity." }, "email": { "type": "string", "description": "Email address of the customer." }, "phone": { "type": "object", "description": "Phone number of the customer.", "properties": { "countryCode": { "type": "string", "description": "Country Code/Area code of the phone number." }, "number": { "type": "string", "description": "Phone number of the customer." } } } } }, "klarnaUpdate": { "type": "object", "title": "klarna", "properties": { "invoiceNumber": { "type": "string", "description": "Invoice/booking number from Klarna. This number is needed for example for resending the E-Mail with payment and order information." } } }, "updatePayment": { "title": "paymentMethods", "properties": { "klarna": { "$ref": "#/components/schemas/klarnaUpdate" } } }, "updateRequest": { "type": "object", "title": "PaymentDetailsRequest", "required": [ "eventToken" ], "properties": { "transId": { "type": "string", "description": "Transaction ID provided by you which should be unique for each payment.", "maxLength": 64 }, "amount": { "$ref": "#/components/schemas/amountMini" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "order": { "$ref": "#/components/schemas/order" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "customerInfo": { "$ref": "#/components/schemas/updateCustomerInfo" }, "eventToken": { "type": "string", "description": "Intent of the updating the payment details.Note: Not all event tokens are applicable for all payment method types. Refer payment method specific pages in our product guide to know the relevant event tokens for a specific payment method.", "enum": [ "UPDATE_ORDER_DETAILS", "UPDATE_ADDRESS", "UPDATE_REFERENCE", "RESEND_INVOICE" ] }, "paymentMethods": { "$ref": "#/components/schemas/updatePayment" } } }, "baseUpdateResponse": { "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Transaction ID provided by you in the request." }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "refNr": { "type": "string", "description": "Reference number provided by you in the request." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "responseCode": { "type": "number", "description": "Response code of the transaction." } } }, "klarnaUpdateResponse": { "type": "object", "title": "klarna", "properties": { "providerResponseCode": { "type": "string", "description": "Response code from Klarna." }, "providerResponseText": { "type": "string", "description": "Response description from Klarna." } } }, "payPalUpdateResponse": { "type": "object", "title": "payPal", "properties": { "providerResponseCode": { "type": "string", "description": "Error code from PayPal if agreed with Axepta Online Helpdesk." } } }, "paymentMethodsUpdateResponse": { "title": "paymentMethods", "properties": { "klarna": { "$ref": "#/components/schemas/klarnaUpdateResponse" }, "payPal": { "$ref": "#/components/schemas/payPalUpdateResponse" } } }, "updateResponse": { "title": "PaymentDetailsResponse", "allOf": [ { "$ref": "#/components/schemas/baseUpdateResponse" }, { "type": "object", "properties": { "paymentMethods": { "$ref": "#/components/schemas/paymentMethodsUpdateResponse" } } } ] }, "cardCreateLink": { "type": "object", "title": "card", "properties": { "eventToken": { "type": "string", "description": "Defines specific use cases of card payments, if applicable.\n- DELAYED_SHIPMENT: Passed in initial request, if you intend to capture the request after the shipment is sent.\n- PRE_AUTH: Passed in initial request, if the initial payment is a preauthorization.\n- PLBS: Passed in initial request, if the payment is related to rental of goods and services and is being initiated as a preauthorization.\n- ORDER: Pass if you want to perform authentication and payment in 2 steps. If you pass it, then the payment should be confirmed by calling the Confirm payment endpoint.\n- ACCOUNT_VERIFICATION: Pass this if you want to verify card account without initiating a payment transaction. Amount is optional when this value is sent.", "enum": [ "DELAYED_SHIPMENT", "PRE_AUTH", "PLBS", "ORDER", "ACCOUNT_VERIFICATION" ] }, "subType": { "type": "array", "description": "Used to define the card payment methods that needs to be shown on the payment form. The values here override your default configuration at merchant level.", "items": { "type": "string", "enum": [ "AIRPLUS", "AMEX", "ARGENCARD", "AURA", "BANCONTACT", "CABAL", "CARTESBANCAIRES", "CBN", "CENCOSUD", "COMFORTCARD", "CUP", "DANKORT", "DINERS", "DISCOVER", "ELO", "HIPERCARD", "JCB", "LASER", "MAESTRO", "MASTERCARD", "NARANJA", "RUPAY", "SHOPPING", "TOTAL", "VISA" ] } }, "threeDsPolicy": { "$ref": "#/components/schemas/threeDsPolicy" }, "template": { "$ref": "#/components/schemas/templateCard" }, "prefillInfo": { "$ref": "#/components/schemas/cardPrefillInfo" } } }, "multibancoLink": { "allOf": [ { "type": "object", "title": "multibanco", "properties": { "sellingPoint": { "type": "string", "description": "Selling point" }, "account": { "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Name of account holder" } } } } } ] }, "paymentLink": { "type": "object", "title": "paymentMethods", "properties": { "card": { "$ref": "#/components/schemas/cardCreateLink" }, "eps": { "$ref": "#/components/schemas/epsHosted" }, "ideal": { "$ref": "#/components/schemas/ideal" }, "klarna": { "$ref": "#/components/schemas/klarnaHosted" }, "multibanco": { "$ref": "#/components/schemas/multibancoLink" }, "paypal": { "$ref": "#/components/schemas/payPal" } } }, "createLinkRequest": { "title": "CreateLinkRequest", "type": "object", "required": [ "transId", "amount" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "externalIntegrationId": { "type": "string", "description": "External integration identifier" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "amount": { "$ref": "#/components/schemas/amount" }, "language": { "type": "string", "description": "Language code to determine the language of the payment form and customer communication where applicable." }, "template": { "$ref": "#/components/schemas/template" }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "credentialOnFile": { "$ref": "#/components/schemas/credentialOnFile" }, "order": { "$ref": "#/components/schemas/order" }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "urls": { "$ref": "#/components/schemas/urls" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/customerInfo" }, "partialPayment": { "type": "boolean", "description": "Defines if the payment is a partial payment. Possible values: true or false." }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "fraudData": { "$ref": "#/components/schemas/fraudData" }, "paymentFacilitator": { "$ref": "#/components/schemas/subMerchantPaymentFacilitator" }, "browserInfo": { "$ref": "#/components/schemas/browserInfo" }, "device": { "$ref": "#/components/schemas/device" }, "channel": { "type": "string", "description": "Specifies the sales or interaction channel through which the transaction is initiated.", "enum": [ "ECOM", "MOTO", "APP", "PAYBYLINK", "POS" ] }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "serviceType": { "type": "string", "enum": [ "LINK", "SMS", "EMAIL" ] }, "externalTemplate": { "type": "string" }, "customValue": { "type": "string" }, "lifetime": { "type": "number" }, "allowedPaymentMethods": { "type": "array", "description": "Indicates list of allowed payment methods that should be shown on the hosted payment page. If not passed default merchant level configuration is used to display the allowed payment methods.", "items": { "type": "string", "enum": [ "APPLEPAY", "BANCONTACT", "BOLETO", "CARDS", "DIRECTDEBIT", "EASYCOLLECT", "EPS", "FLOAPAY", "GOOGLEPAY", "IDEAL", "INSTANEA", "KLARNA", "MULTIBANCO", "MYBANK", "PAYPAL", "PRZELEWY24", "TRUSTLY", "TWINT", "VIPPSMOBILEPAY", "WERO" ] } }, "paymentMethods": { "$ref": "#/components/schemas/paymentLink" } } }, "createLinkResponse": { "title": "CreateLinkResponse", "allOf": [ { "$ref": "#/components/schemas/paymentHostedResponse" } ] }, "requestBasicWebhooks": { "type": "object", "title": "BasicWebhooksRequest", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment." } } }, "requestEnhancedWebhooks": { "type": "object", "required": [ "payId", "transId", "status", "responseCode", "responseDescription", "amount", "paymentMethods", "creationDate" ], "title": "EnhancedWebhooksResponse", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment." }, "transId": { "type": "string", "description": "Transaction ID created in your system; should be unique per payment." }, "refNr": { "type": "string", "description": "Your reference number for the specific operation; used for reconciliation." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "amount": { "type": "object", "properties": { "value": { "type": "number", "description": "Total order amount in the smallest currency unit." }, "currency": { "type": "string", "description": "3-character ISO currency code." } }, "required": [ "value", "currency" ] }, "paymentMethods": { "type": "array", "description": "Selected payment method(s).", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "APPLEPAY", "BANCONTACT", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "FLOAPAY", "GOOGLEPAY", "IDEAL", "INSTANEA", "KLARNA", "MOBILEPAY", "MULTIBANCO", "MYBANK", "PAYPAL", "PAYU", "PFCONNECT", "RATEPAY", "RIVERTY", "SWISH", "WERO" ], "description": "Payment method used for this transaction." } }, "required": [ "type" ] } }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and time when the order was created." } } }, "binLookupRequest": { "type": "object", "title": "binLookupRequest", "required": [ "bin" ], "properties": { "bin": { "type": "string", "description": "Card BIN (first digits of the card number) used to determine cardholder country and DCC eligibility." } } }, "binLookupResponse": { "type": "object", "title": "cardInfo", "properties": { "country": { "type": "string", "description": "Card country." } } }, "binLookup422Response": { "title": "binLookupErrorResponse", "type": "object", "properties": { "responseCode": { "type": "string", "example": "A specific identifier for the error cause" }, "responseDescription": { "type": "string", "example": "A brief message explaining the error" } } }, "amount-2": { "title": "amount", "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "Transaction amount in merchant base currency for which the DCC quote is requested." }, "currency": { "type": "string", "description": "Merchant base currency (ISO 4217 alphabetic code) of the transaction amount." } } }, "dccQuoteRequest": { "type": "object", "title": "DccQuoteRequest", "required": [ "bin", "amount" ], "properties": { "bin": { "type": "string", "description": "Card BIN (first digits of the card number) used to determine cardholder country and DCC eligibility." }, "amount": { "$ref": "#/components/schemas/amount-2" } } }, "dccQuoteResponse": { "type": "object", "title": "dccInfo", "properties": { "status": { "type": "string", "description": "Indicates whether DCC is available for the given BIN and transaction data.", "enum": [ "AVAILABLE", "NOT_AVAILABLE" ] }, "provider": { "type": "string", "description": "DCC service provider identifier." }, "dccRequestId": { "type": "string", "description": "Unique identifier of the DCC quote request." }, "rate": { "$ref": "#/components/schemas/cardRate" }, "amounts": { "$ref": "#/components/schemas/cardAmounts" } } }, "dccQuote422Response": { "type": "object", "title": "dccInfo", "properties": { "status": { "type": "string", "description": "Indicates whether DCC is available for the given BIN and transaction data.", "enum": [ "AVAILABLE", "NOT_AVAILABLE" ] } } }, "createPaymentIntentRequest": { "type": "object", "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment.", "maxLength": 64 }, "externalIntegrationId": { "type": "string", "description": "External integration identifier" }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. " }, "amount": { "$ref": "#/components/schemas/amount" }, "language": { "type": "string", "description": "Language code to determine the language of the payment form and customer communication where applicable." }, "captureMethod": { "$ref": "#/components/schemas/captureMethod" }, "order": { "$ref": "#/components/schemas/order" }, "simulationMode": { "type": "string", "description": "Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes." }, "urls": { "$ref": "#/components/schemas/urls" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "shipping": { "$ref": "#/components/schemas/shippingAddressCreatePayment" }, "statementDescriptor": { "type": "string", "description": "Short, clear description of the transaction that appears on the customer's statement." }, "customerInfo": { "$ref": "#/components/schemas/customerInfo" }, "partialPayment": { "type": "boolean", "description": "Defines if the payment is a partial payment. Possible values: true or false." }, "expirationTime": { "type": "string", "format": "date-time", "description": "Transaction expiry timestamp (UTC).", "example": "2025-02-07T16:00:00Z" }, "fraudData": { "$ref": "#/components/schemas/fraudData" }, "paymentFacilitator": { "$ref": "#/components/schemas/subMerchantPaymentFacilitator" }, "browserInfo": { "$ref": "#/components/schemas/browserInfo" }, "device": { "$ref": "#/components/schemas/device" }, "credentialOnFile": { "$ref": "#/components/schemas/credentialOnFile" }, "channel": { "type": "string", "description": "Specifies the sales or interaction channel through which the transaction is initiated. Examples include \"online\", \"in-store\", \"mobile app\".", "enum": [ "ECOM", "MOTO", "APP", "PAYBYLINK", "POS" ] }, "metadata": { "type": "object", "description": "A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response." }, "referencePayId": { "type": "string" } } }, "createPaymentIntentSuccessResponse": { "type": "object", "properties": { "id": { "type": "string" } } }, "createIntentErrorResponse": { "title": "IntentResponse", "type": "object", "properties": { "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Transaction ID provided by you in the request." }, "xId": { "type": "string", "description": "A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same." }, "refNr": { "type": "string", "description": "Reference number provided by you in the request." }, "status": { "type": "string", "description": "Status of the transaction." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." } } }, "baseCustomerDetailsResponse": { "type": "object", "title": "customerDetailsResponse", "properties": { "id": { "type": "string", "description": "Unique identifier of the customer assigned by Axepta Online." }, "merchantCustomerId": { "type": "string", "description": "Unique identifier of the customer assigned by merchant." }, "firstName": { "type": "string", "description": "First name of the customer. Present if passed by merchant in Payment." }, "lastName": { "type": "string", "description": "Last name of the customer. Present if passed by merchant in Payment." }, "companyName": { "type": "string", "description": "Last name of the customer. Present if passed by merchant in Payment." }, "email": { "type": "string", "description": "E-mail address of the customer. Present if passed by merchant in Payment." }, "phone": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Area or country code of the phone number of the customer. Present if passed by merchant in Payment." }, "number": { "type": "string", "description": "Phone number of the customer. Present if passed by merchant in Payment." } } }, "scope": { "type": "string", "description": "Scope of customer vault. Present if configured for the merchant in MAT." }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date and time in ISO 8601 format." }, "updatedAt": { "type": "string", "format": "date-time", "description": "Update date and time in ISO 8601 format." } } }, "customersDetailsResponse": { "type": "object", "properties": { "totalNumberOfPages": { "type": "number", "description": "Indicates total number of pages that exist." }, "totalNumberOfItems": { "type": "number", "description": "Indicates total number of items that exist." }, "page": { "type": "number", "description": "Indicates number of page that is retrieved." }, "pageSize": { "type": "number", "description": "Indicates max number of items on page." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/baseCustomerDetailsResponse" } } } }, "customerDetailsResponse": { "allOf": [ { "$ref": "#/components/schemas/baseCustomerDetailsResponse" }, { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "streetName": { "type": "string", "description": "Street name of billing address. Present if passed by merchant in Payment." }, "streetNumber": { "type": "string", "description": "Street number of billing address. Present if passed by merchant in Payment." }, "city": { "type": "string", "description": "City of billing address. Present if passed by merchant in Payment." }, "postalCode": { "type": "string", "description": "Postal code of billing address. Present if passed by merchant in Payment." }, "state": { "type": "string", "description": "State of billing address. Present if passed by merchant in Payment." }, "country": { "type": "string", "description": "Country of billing address. Present if passed by merchant in Payment." } } }, "lastUsedAt": { "type": "string", "format": "date-time", "description": "Last used date and time in ISO 8601 format." } } } ] }, "updateCustomerRequest": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the customer. Must be present if companyName is not present." }, "lastName": { "type": "string", "description": "Last name of the customer. Must be present if companyName is not present." }, "companyName": { "type": "string", "description": "Company name of the customer. Must be present if firstName and lastName are not present." }, "email": { "type": "string", "description": "E-mail address of the customer." }, "phone": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Area or country code of the phone number of the customer." }, "number": { "type": "string", "description": "Phone number of the customer." } } }, "billingAddress": { "type": "object", "properties": { "streetName": { "type": "string", "maxLength": 50, "description": "Street name of billing address." }, "streetNumber": { "type": "string", "description": "Street number of billing address." }, "city": { "type": "string", "maxLength": 50, "description": "City of billing address." }, "postalCode": { "type": "string", "maxLength": 16, "description": "Postal code of billing address." }, "state": { "type": "string", "minLength": 2, "maxLength": 2, "description": "State of billing address." }, "country": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Country of billing address." } } } } }, "deleteCustomerResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the customer assigned by Axepta Online." }, "deleted": { "type": "boolean", "description": "Indicates if the payment method record was deleted or not." } } }, "paymentMethodsResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID assigned by Axepta Online for the payment method record." }, "type": { "type": "string", "description": "Determines type of payment method. CARD, SEPA_DD. For now only CARD is in scope." }, "last4Digits": { "type": "string" }, "pseudoCardNumber": { "type": "string" }, "cardHolderName": { "type": "string" }, "brand": { "type": "string" }, "expiryDate": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date and time in ISO 8601 format." }, "updatedAt": { "type": "string", "format": "date-time", "description": "Update date and time in ISO 8601 format." }, "lastUsedAt": { "type": "string", "format": "date-time", "description": "Last used date and time in ISO 8601 format." } } }, "customersPaymentMethodsResponse": { "type": "object", "properties": { "gatewayCustomerId": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/paymentMethodsResponse" } } } }, "deletePaymentMethodResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID assigned by Axepta Online for the payment method record." }, "deleted": { "type": "boolean", "description": "Indicates if the payment method record was deleted or not." } } }, "cloudPosCredentialOnFile": { "title": "credentialOnFile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECURRING", "UNSCHEDULED" ], "description": "Indicates the type of credential-on-file transaction." }, "initialPayment": { "type": "boolean", "description": "Specifies whether the transaction is the initial payment in a credential-on-file setup." }, "unscheduled": { "type": "object", "properties": { "subType": { "type": "string", "description": "Specifies the sub-type of an unscheduled credential-on-file transaction.", "enum": [ "CIT" ] } } } } }, "cloudPOSRequest": { "type": "object", "title": "CloudPosRequest", "required": [ "messageType", "transId", "posTerminalId", "isPrinterReady", "amount", "localDateTime" ], "properties": { "transId": { "type": "string", "description": "Transaction ID created in your system. It should be unique for each payment." }, "messageType": { "type": "string", "description": "Defines the type of payment: Supported values are: 01 - Sale; 02 - Reverse; 03 - Credit; 05 - Authorization/Reservation; 0B - Capture; 0C - Card Read; 0D - Diagnose; A1 - Terminal Startup.", "enum": [ "SALE", "REVERSE", "CREDIT", "AUTHORISATION_OR_RESERVATION", "CAPTURE", "CARD_READ", "DIAGNOSE", "TERMINAL_STARTUP" ] }, "refNr": { "type": "string", "description": "Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually." }, "amount": { "$ref": "#/components/schemas/amountMini" }, "posTerminalId": { "type": "string", "description": "TerminalID of PIN entry device." }, "cardReadMode": { "type": "string", "description": "Defines the technology to be used to read the card. Valid values are: msr.", "enum": [ "MSR" ] }, "localDateTime": { "type": "string", "format": "date-time", "description": "Transaction date and time." }, "traceNr": { "type": "string", "description": "Mandatory for subsequent functions Reversal or Capture (MessageType=02/08). It must be equal to the value traceNr received from the original authorization response. Merchant POS system must provide this in the request." }, "approvalCode": { "type": "string", "description": "Mandatory for subsequent function Capture (MessageType=08). It must be equal to the value approvalCode received from the original authorization response. Merchant POS system must provide this in the request." }, "credentialOnFile": { "$ref": "#/components/schemas/cloudPosCredentialOnFile" }, "contractId": { "type": "string", "description": "Special merchant ID at the acquirer to overrule the default merchant ID." } } }, "receipt": { "type": "object", "description": "Data containing the receipt information which can be printed out by the merchant system.", "properties": { "receiptNr": { "type": "string", "description": "Receipt number." }, "receiptCopies": { "type": "number", "description": "Number of receipt copies to be printed." }, "receiptCustomer": { "type": "string", "description": "Customer Receipt data." }, "receiptMerchant": { "type": "string", "description": "Merchant Receipt data." }, "receiptsNumber": { "type": "number", "description": "Receipts number." } } }, "dcc": { "type": "object", "properties": { "foreignAmount": { "type": "number", "description": "Applicable for DCC transactions." }, "foreignCurrencyCode": { "type": "string", "description": "Applicable for DCC transactions." }, "commission": { "type": "string", "description": "Applicable for DCC transactions." }, "margin": { "type": "string", "description": "Applicable for DCC transactions." }, "rateValue": { "type": "string", "description": "Applicable for DCC transactions." }, "source": { "type": "string", "description": "Applicable for DCC transactions." }, "timestamp": { "type": "string", "description": "Applicable for DCC transactions." }, "disclaimerText": { "type": "string", "description": "Applicable for DCC transactions." } } }, "paymentMethodsCloudPOS": { "title": "paymentMethod", "type": "object", "properties": { "card": { "type": "object", "properties": { "fist6Digits": { "type": "string", "description": "First 6 digits of card. Present only for successful transactions." }, "last4Digits": { "type": "string", "description": "Last 4 digits of card. Present only for successful transactions." }, "brand": { "type": "string", "description": "Brand: VISA, MASTERCARD, MAESTRO, AMEX, DINERS, JCB, CUP." }, "expiryDate": { "type": "string", "description": "Expiry date of the card in YYYYMM format." }, "cardSequenceNumber": { "type": "string", "description": "Card sequence number." }, "pseudoCardNumber": { "type": "string", "description": "Pseudo Card Number." }, "schemeReferenceId": { "type": "string", "description": "Identifier assigned by schemes to the transaction." } } } } }, "cloudPOSResponse": { "type": "object", "title": "CloudPosResponse", "properties": { "merchantId": { "type": "string", "description": "Merchant ID assigned by Axepta Online." }, "transId": { "type": "string", "description": "Your own transaction ID, which must be unique for each payment." }, "payId": { "type": "string", "description": "A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation." }, "refNr": { "type": "string", "description": "Dealer reference number." }, "posTerminalId": { "type": "string", "description": "Echoed from the request parameter." }, "terminalId": { "type": "string", "description": "Terminal ID which is forwarded towards acquirer authorization host." }, "status": { "type": "string", "description": "OK (URLSuccess) or FAILED (URLFailure)." }, "additionalResponseData": { "type": "string", "description": "Additional text which the operator’s processing system can send optionally in replies to payment/cutover requests." }, "approvalCode": { "type": "string", "description": "Approval code from authorization host in the response message to the client. Only in case of successful credit card transactions. Merchant must save this value form the response and use it when referencing Capture subsequent action." }, "traceNr": { "type": "string", "description": "Trace number. Merchant must save this value form the response and use it when referencing subsequent actions i.e Reverse, Capture." }, "responseCode": { "type": "string", "description": "Response code of the transaction." }, "responseDescription": { "type": "string", "description": "Response description associated with the response code." }, "providerResponseCode": { "type": "string", "description": "Financial transaction Authorization Host response code (Payment)." }, "vuNr": { "type": "string", "description": "Acquirer Contract ID number on which the transaction was processed." }, "receipt": { "$ref": "#/components/schemas/receipt" }, "dcc": { "$ref": "#/components/schemas/dcc" }, "aidParameters": { "type": "string", "description": "Authorisation parameters: if these are present, the authorisation parameters must be printed out on the terminal receipt in unpacked form as 10 hexadecimal numbers. Aid-parameters can contain up to 130 characters for electronic cash payments." }, "localDateTime": { "type": "string", "format": "date-time", "description": "Transaction date and time." }, "verificationCode": { "type": "string", "description": "Used authentication mode. Possible values: Signature; PIN; On consumer device; NoAuth." }, "credentialOnFile": { "$ref": "#/components/schemas/cloudPosCredentialOnFile" }, "contractId": { "type": "string", "description": "Echoed from the request parameter." }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodsCloudPOS" } } } } } }