# Technical documentation for integration with the Axepta transactional system.

OpenAPI file: https://bump.sh/pgw/doc/axepta-api/en.yaml

## Description

This is version `1.0.1` of this API documentation. Last update on May 7, 2026.
# The documentation contains information about the RESTful API of the Axepta payment system.
<br>
Communication is carried out by exchanging information saved in JSON format.
<br>
Each request should include an appropriate authorization method.
<br>
Each valid address consists of three parts:
  - the base request address `https://api.axepta.pl/v1`,
  - the client identifier `/merchant/{merchantId}`,
  - a function that uniquely defines the scope of data the request concerns (e.g. `/transaction` or `/payment`).

Each request to the server should include authorization data in the headers (**Authorization token**).
> Integration data is available in the [Axepta administration panel](https://axepta.bnpparibas.pl/)


## Servers

- Production server.: https://api.axepta.pl/v1 (Production server.)

- Sandbox - test server.: https://api.sandbox.axepta.pl/v1 (Sandbox - test server.)

## Authentication


## Topics

- [1.1. Transaction statuses (transaction).](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-1-transaction-statuses-transaction.md)

- [1.2. Payment link order statuses - (payment).](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-2-payment-link-order-statuses-payment.md)

- [1.3. Authorization methods.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-3-authorization-methods.md)

- [1.4. Transaction processing methods and channels](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-4-transaction-processing-methods-and-channels.md)

- [1.4.1. Pay By Link online transfer](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-4-1-pay-by-link-online-transfer.md)

- [1.4.2. Card payment.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-4-2-card-payment.md)

- [1.4.3. BLIK payment.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-1-4-3-blik-payment.md)

- [2. RESTful API methods](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-2-restful-api-methods.md)

- [3. Creating a new transaction via API](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-3-creating-a-new-transaction-via-api.md)

- [3.1. HTTP Request transaction API](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-3-1-http-request-transaction-api.md)

- [3.2. Browser data](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-3-2-browser-data.md)

- [3.3. HTTP Response](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-3-3-http-response.md)

- [3.4 Multipayouts](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-3-4-multipayouts.md)

- [4. Performing a refund](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-4-performing-a-refund.md)

- [4.1 HTTP Request for performing a refund](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-4-1-http-request-for-performing-a-refund.md)

- [4.2 HTTP Response](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-4-2-http-response.md)

- [5. Creating a new payment link via API](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-creating-a-new-payment-link-via-api.md)

- [5.1. HTTP Request](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-1-http-request.md)

- [5.2. HTTP Response](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-2-http-response.md)

- [5.3. Payment method visibility](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-3-payment-method-visibility.md)

- [5.4. Multipayouts](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-4-multipayouts.md)

- [5.6. Cancelling a payment link](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-5-6-cancelling-a-payment-link.md)

- [6. Notifications](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-6-notifications.md)

- [6.1. Notification BODY content](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-6-1-notification-body-content.md)

- [6.2. Notification headers content](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-6-2-notification-headers-content.md)

- [6.3. Notification signature verification method](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-6-3-notification-signature-verification-method.md)

- [7. Retrieving transaction data](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-7-retrieving-transaction-data.md)

- [7.1. HTTP Request](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-7-1-http-request.md)

- [7.2. HTTP Response](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-7-2-http-response.md)

- [8. OneClick and recurring payments](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-oneclick-and-recurring-payments.md)

- [8.1 Registering a new profile](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-1-registering-a-new-profile.md)

- [8.2. Charging an existing profile](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-2-charging-an-existing-profile.md)

- [8.3 Managing an existing profile](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-3-managing-an-existing-profile.md)

- [8.3.1 Multipayout](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-3-1-multipayout.md)

- [8.3.2 Retrieve profile by `cid`](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-3-2-retrieve-profile-by-cid.md)

- [8.3.3 Retrieve card profile by `id`](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-3-3-retrieve-card-profile-by-id.md)

- [8.3.4 Deactivate card profile by `id`](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-8-3-4-deactivate-card-profile-by-id.md)

- [9. Retrieving payment data](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-9-retrieving-payment-data.md)

- [9.1 HTTP Request](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-9-1-http-request.md)

- [9.2 HTTP Response](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-9-2-http-response.md)

- [10. Reports - API Report Documentation](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-reports-api-report-documentation.md)

- [10.1. Reports - Authorization](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-1-reports-authorization.md)

- [10.2. Report Types](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-2-report-types.md)

- [10.2.1 Transaction Report (CSV)](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-2-1-transaction-report-csv.md)

- [10.2.2. Transaction Report by Payout (CSV)](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-2-2-transaction-report-by-payout-csv.md)

- [10.2.3. Transaction Settlement Report (CSV)](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-2-3-transaction-settlement-report-csv.md)

- [10.3. Report - Enums](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-3-report-enums.md)

- [10.4. Webhook](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-10-4-webhook.md)

- [11. Sandbox](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-11-sandbox.md)

- [11.1. Cards in the sandbox environment.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-11-1-cards-in-the-sandbox-environment.md)

- [11.1. PBL transactions in the sandbox environment.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-11-1-pbl-transactions-in-the-sandbox-environment.md)

- [11.2. BLIK in the sandbox environment.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-11-2-blik-in-the-sandbox-environment.md)

- [12. Minimum and maximum values for transaction and refund amounts.](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-12-minimum-and-maximum-values-for-transaction-and-refund-amounts.md)

- [Postman Collection](https://bump.sh/pgw/doc/axepta-api/en/topic/topic-postman-collection.md)


## Groups and operations

### [transaction](https://bump.sh/pgw/doc/axepta-api/en/group/endpoint-transaction.md)

- [Create a transaction](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-post-merchant-parameter-transaction.md)

- [Retrieve transaction data](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-get-merchant-parameter-transaction-parameter.md)

### [payment-link](https://bump.sh/pgw/doc/axepta-api/en/group/endpoint-payment-link.md)

- [Create a payment link order](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-post-merchant-parameter-payment-link.md)

- [Retrieve payment data](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-get-merchant-parameter-payment-parameter.md)

- [Cancel a payment link](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-post-merchant-parameter-payment-cancel.md)

### [refund](https://bump.sh/pgw/doc/axepta-api/en/group/endpoint-refund.md)

- [Perform a payment refund](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-post-merchant-parameter-payment-parameter-refund.md)

### [profile](https://bump.sh/pgw/doc/axepta-api/en/group/endpoint-profile.md)

- [Retrieve profile by cid](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-get-merchant-parameter-profile-cid-parameter.md)

- [Retrieve card profile by id](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-get-merchant-parameter-profile-id-parameter.md)

- [Deactivate card profile by id.](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-delete-merchant-parameter-profile-id-parameter.md)

- [Deactivates the profile with the identifier provided in the request](https://bump.sh/pgw/doc/axepta-api/en/operation/operation-post-merchant-parameter-profile-deactivate.md)



[Powered by Bump.sh](https://bump.sh)