Return to returnURL
Location the payer is sent to when the payment reaches a final state
After the payer has completed the payment we redirect them back to your platform. This redirection is done using the returnUrl which is supplied as parameter within the Order:Create API .
Exchange
After the payment is completed, we exchange the payment 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 status is crucial to you, you can retrieve the status of the payment by using the Order:Status endpoint. This will ensure that you have the most accurate and up-to-date information.
More information regarding exchanges can be found here.
ReturnURL
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 return 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 return URL on a SoftPos transaction that is injected from a website or app.
| Field | Description | Value |
|---|---|---|
| &ticket | Base64 encoded version of plain text ticketData, this can be used to print a receipt for the cardholder. | Base64 |
Return URL as app delegate
It's allowed to use an app delegate name if the application is installed on the users device. PAYCPOC:// will open the PAY.POS app. Please be aware, we append the same query-string 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
Updated 3 months ago