Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API Explorer API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

en

pl default
en

Topics

Introduction
Servers
Authentication
1.1. Transaction statuses (transaction).
1.2. Payment link order statuses - (payment).
1.3. Authorization methods.
1.4. Transaction processing methods and channels
1.4.1. Pay By Link online transfer
1.4.2. Card payment.
1.4.3. BLIK payment.
2. RESTful API methods
3. Creating a new transaction via API
3.1. HTTP Request transaction API
3.2. Browser data
3.3. HTTP Response
3.4 Multipayouts
4. Performing a refund
4.1 HTTP Request for performing a refund
4.2 HTTP Response
5. Creating a new payment link via API
5.1. HTTP Request
5.2. HTTP Response
5.3. Payment method visibility
5.4. Multipayouts
5.6. Cancelling a payment link
6. Notifications
6.1. Notification BODY content
6.2. Notification headers content
6.3. Notification signature verification method
7. Retrieving transaction data
7.1. HTTP Request
7.2. HTTP Response
8. OneClick and recurring payments
8.1 Registering a new profile
8.2. Charging an existing profile
8.3 Managing an existing profile
8.3.1 Multipayout
8.3.2 Retrieve profile by `cid`
8.3.3 Retrieve card profile by `id`
8.3.4 Deactivate card profile by `id`
9. Retrieving payment data
9.1 HTTP Request
9.2 HTTP Response
10. Reports - API Report Documentation
10.1. Reports - Authorization
10.2. Report Types
10.2.1 Transaction Report (CSV)
10.2.2. Transaction Report by Payout (CSV)
10.2.3. Transaction Settlement Report (CSV)
10.3. Report - Enums
10.4. Webhook
11. Sandbox
11.1. Cards in the sandbox environment.
11.1. PBL transactions in the sandbox environment.
11.2. BLIK in the sandbox environment.
12. Minimum and maximum values for transaction and refund amounts.
Postman Collection

Endpoints

transaction
- Create a transaction POST
- Retrieve transaction data GET
payment-link
refund
- Perform a payment refund POST
profile

Powered by Bump.sh

API Explorer API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Servers

Base URL	Description
https://api.axepta.pl/v1	Production server.
https://api.sandbox.axepta.pl/v1	Sandbox - test server.