# Axepta Online API 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. **Security** The 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. **Test Before You Go Live** Use 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.6.0 ## Servers Test ``` https://test.paymentpage.axepta.bnpparibas/api/v2 ``` Production ``` https://paymentpage.axepta.bnpparibas/api/v2 ``` ## Security ### bearer [object Object] Type: http Scheme: bearer Bearer Format: JWT ### basic Basic Authentication using username and password Type: http Scheme: basic ### apiKey API Key authentication using X-API-Key header Type: apiKey In: header Name: X-API-Key ## Download OpenAPI description - [Axepta Online API](https://axeptabnpparibas-docs.redocly.app/_bundle/index.yaml) ## Guide ## Authentication - [POST /authorization/oauth/token](https://axeptabnpparibas-docs.redocly.app/authentication/authorizationservice.md): This endpoint is to generate a short-lived JSON Web token (JWT) ## Payments - [POST /payments/sessions](https://axeptabnpparibas-docs.redocly.app/payments/createsession.md): This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction. - [POST /payments](https://axeptabnpparibas-docs.redocly.app/payments/createpayment.md): This endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types: HOSTED: Returns a URL for a payment method-specific hosted form, where the - [POST /payments/{id}/confirms](https://axeptabnpparibas-docs.redocly.app/payments/confirmpayment.md): 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 - [POST /payments/{id}/incrementals](https://axeptabnpparibas-docs.redocly.app/payments/incrementauthorization.md): 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 authorizat - [POST /payments/{id}/reversals](https://axeptabnpparibas-docs.redocly.app/payments/reversepayment.md): This endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization. - [POST /payments/{id}/captures](https://axeptabnpparibas-docs.redocly.app/payments/capturepayment.md): This endpoint is used to capture an existing authorized payment. - [POST /payments/{id}/refunds](https://axeptabnpparibas-docs.redocly.app/payments/refundpayment.md): This endpoint is used to refund a captured payment. - [POST /payments/refunds](https://axeptabnpparibas-docs.redocly.app/payments/refundexternalpayment.md): This endpoint is used to refund a payment without reference. - [GET /payments/getByTransId/{id}](https://axeptabnpparibas-docs.redocly.app/payments/getpaymentdetailsbytransactionid.md): This endpoint is used to retrieve payment details with the Transaction ID (transId). - [GET /payments/getByPayId/{id}](https://axeptabnpparibas-docs.redocly.app/payments/getpaymentdetailsbypaymentid.md): Returns all details about existing payment. - [PATCH /payments/{id}](https://axeptabnpparibas-docs.redocly.app/payments/updatepaymentdetails.md): Update details about existing payment. - [POST /payments/links](https://axeptabnpparibas-docs.redocly.app/payments/createpaymentlink.md): 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 whe ## Webhooks - [POST /{merchantEnhancedWebhookUrl}](https://axeptabnpparibas-docs.redocly.app/webhooks/paths/~1%7Bmerchantenhancedwebhookurl%7D/post.md): The Enhanced Webhook includes detailed transaction data in the payload and is signed with an HMAC signature to ensure authenticity and integrity. - [POST /{merchantBasicWebhookUrl}](https://axeptabnpparibas-docs.redocly.app/webhooks/paths/~1%7Bmerchantbasicwebhookurl%7D/post.md): 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. Since no se ## PaymentPlans - [POST /payment-plans/{paymentPlanId}/charge](https://axeptabnpparibas-docs.redocly.app/paymentplans/chargepaymentplan.md): Create payment within payment plan - [POST /payment-plans/{paymentPlanId}/cancel](https://axeptabnpparibas-docs.redocly.app/paymentplans/cancelpaymentplan.md): Cancel payment plan - [GET /payment-plans](https://axeptabnpparibas-docs.redocly.app/paymentplans/getpaymentplans.md): Get list of payment plans - [GET /payment-plans/{paymentPlanId}](https://axeptabnpparibas-docs.redocly.app/paymentplans/getpaymentplanbyid.md): Get payment plan by id - [GET /payment-plans/{paymentPlanId}/payments](https://axeptabnpparibas-docs.redocly.app/paymentplans/listpaymentswithinpaymentplan.md): Returns a paginated list of payments that belong to the given payment plan. - [POST /payment-plans/unscheduled-mit](https://axeptabnpparibas-docs.redocly.app/paymentplans/createunscheduledmit.md) ## Mobile SDK ## Customers - [GET /customers](https://axeptabnpparibas-docs.redocly.app/customers/getcustomers.md): Get list of customers - [GET /customers/{id}](https://axeptabnpparibas-docs.redocly.app/customers/getcustomer.md): Get customer details - [PATCH /customers/{id}](https://axeptabnpparibas-docs.redocly.app/customers/updatecustomer.md): Updates details about customer - [DELETE /customers/{id}](https://axeptabnpparibas-docs.redocly.app/customers/deletecustomer.md): Delete customer details - [GET /customers/{id}/paymentMethods](https://axeptabnpparibas-docs.redocly.app/customers/getpaymentmethods.md): Get list of payment methods for customer - [GET /customers/{customerId}/paymentMethods/{paymentMethodId}](https://axeptabnpparibas-docs.redocly.app/customers/getpaymentmethod.md): Get payment method details - [DELETE /customers/{customerId}/paymentMethods/{paymentMethodId}](https://axeptabnpparibas-docs.redocly.app/customers/deletepaymentmethod.md): Delete payment method details - [GET /customers/{customerId}/payment-plans](https://axeptabnpparibas-docs.redocly.app/customers/getcustomerpaymentplans.md): Get list of payment plans for customer ## CloudPos ## Services - [POST /services/duplicationCheck](https://axeptabnpparibas-docs.redocly.app/services/duplicationcheck.md): This endpoint is used to detect duplicate submissions before initiating a new payment, preventing customers from being charged more than once for the same transaction. - [POST /services/accountUpdater](https://axeptabnpparibas-docs.redocly.app/services/accountupdater.md): This endpoint is used to check updates and sends updated credit card data back in response. ## Change log