Return URL
Location the Payer is sent to after a transaction on the TGU
After the payer has completed the transaction process, we redirect them back to your platform. This redirection is done using the returnUrl. You can configure the returnUrl either through the Global Management System or as a parameter within the Order:Create API on a Transaction Gateway Unit.
Exchange
After the transaction process is completed, we exchange the transaction status with your platform to ensure that your platform is aware of the status before the payer is redirected. However, in the event of a technical failure or a slow exchange call, there is a possibility that the payer may return to your system before the status is successfully exchanged.
If you encounter any status mismatches between the URL and your platform, and if the transaction status is crucial to you, you can retrieve the status of the transaction by using the Order:Status endpoint. This will ensure that you have the most accurate and up-to-date information.
ReturnURL version NEW
Starting with the Order:Create API on a TGU the parameters that we append to the returnUrl will be as follows:
| Field | Description | Value |
|---|---|---|
| id | The ID of the property in our system | UUID / INT / String |
| reference | Your reference of the order (formerly orderNumber) | String (32) |
| statusAction | Text version of the status | String (32) |
| statusCode | Numeric detail code of the status | INT |
utm-nooverride (Google Field)
If you activate google sync via PAY, we will add this field on the exchange URL on both versions. To prevent duplicate tracking.
| Field | Description | Value | Options |
|---|---|---|---|
| &utm_nooverride | If the merchant has enabled Google Tracking, we send this field to work with the Google Analytics platform | Boolean | 0 or 1 |
ticket
Can be added to the result URL on a SOFTPOS transaction that is inject from a website or APP
| Field | Description | Value |
|---|---|---|
| &ticket | Base64 encoded version of plain text ticketData, that can be used to print a reciept for the cardholder. | Base64 |
Return URL as APP Deligate
It's allowed to use an APP Deligate name if the application is installed on the users device. PAYCPOC:// will open the PAY app. Please be aware, we append the same querystring as on a https:// location
| Field | Description | Value |
|---|---|---|
| id | The ID of the property in our system | UUID |
| reference | Your reference of the order (formaly orderNumber) | String (32) |
| status | Text version of the status | String (32) |
YOURAPP://?id=TRANSACTIONID&status=PAID&reference=YYYYYYY&ticket=BASE64_DATA_STRING
ReturnURL version legacy
This version is used if you are on the older version of the Transaction API (transaction:create).
If you use the old intergration and the old Exchanges, we send the payer also to the ReturnURL with the old legacy parameters.
| Field | Description | Value |
|---|---|---|
| orderId | The PAY. indicator of the Transaction, received via the transaction:create. | String (32) |
| orderStatusId | Nummeric value of the detailed status | INT (6) |
| paymentSessionId | Nummeric value of the payers attempt | INT (11) |
| transactionId | Coded version of the transaction. For human communication with Support and Dashboard | String (32) |
Updated 3 months ago