Server response
If the request registering a new order is successful, the server will respond with HTTP status 200 and information about the newly created transaction:
{
"status": "SUCCESS",
"data": {
"transaction": {
"id": "21090680-8938-467b-a53e-a68862356e2e",
"type": "sale",
"status": "pending",
"source": "api",
"createdAt": 1688379004,
"modifiedAt": 1688379004,
"notificationUrl": "https://1234.requestcatcher.com/",
"serviceId": "3283bb82-1203-4064-86ad-27868f985769",
"amount": 10000,
"currency": "PLN",
"orderId": "1",
"paymentMethod": "pbl",
"paymentMethodChannel": "ing",
"payment": {
"id": "8254d179-9063-47a2-adb4-5d8322679378",
"status": "new"
}
},
"action": {
"type": "redirect",
"url": "https://paywall.sandbox.axepta.pl/sandbox/8254d179-9063-47a2-
adb4-5d8322679378/21090680-8938-467b-a53e-a68862356e2e",
"method": "GET",
"contentType": "",
"contentBodyRaw": ""
},
"omG": "G9q"
}
}
The response includes the following objects: transaction and action.
The transaction object is identical to the one sent in the order registration request and contains several additional parameters:
| Parameter | Type | Description |
|---|---|---|
id |
string | Transaction identifier in UUID v4 format. Unique for each order. |
status |
string | Order status. |
source |
string | Order source. It can have the following values: api or web. |
createdAt |
integer | Order creation date in UNIX TIMESTAMP UTC format. |
notificationUrl |
string | Notification address |
modifiedAt |
integer | Date of the last transaction status change in UNIX TIMESTAMP UTC format. |
payment |
object | Payment data to which the transaction is assigned |
The second additional object is action. This object appears only if the payer must be redirected to an external page, as in the case of a Pay-By-Link payment.
This object contains additional fields whose meaning is described below:
| Parameter | Type | Description |
|---|---|---|
type |
string | Action type. |
url |
string | URL address in the event that the payer must be redirected to another page (e.g. a bank page). |
method |
string | POST or GET method. |
contentType |
string | Entry in the bank request header specifying the payload type. |
contentBodyRaw |
string | Request payload. |
HTTP statuses
| HTTP Code | Meaning |
|---|---|
200 |
Request completed successfully. Transaction created |
400 |
Bad request, invalid request payload. |
401 |
Unauthorized access. Request for a resource that requires authentication. |
403 |
No permission to perform the request. |
404 |
Unknown resource. |
422 |
Payload is correct but does not contain the required parameters. |
500 |
Server error. |
503 |
System unavailable. |