Webhooks Return
After a successful deposit, the customer is shown a deposit summary page.
At the bottom of this page, a “Continue” button appears. When clicked, the customer is redirected to the specified return URL.
{danger.fa-exclamation} IMPORTANT 1:
By default, the return URL is accessed using the HTTP POST method.
If your callback expects a GET request, you must include at least one query string parameter.
If no parameters are needed, you can still include a dummy one, e.g.,?get=1.
{danger.fa-exclamation} IMPORTANT 2:
In some cases, the customer may be offered additional actions after a transaction:
- "Try Again" button after a decline
- "Make Another Payment" option after a successful deposit
These allow the customer to retry within the same Cashier session, which could lead to reuse of the same
order_id.
To mitigate this risk:
- Use Validation, or
- Enable the setting that restricts single attempt per
order_idfor your application.
{danger.fa-exclamation} IMPORTANT 3:
The return URL accessed method can be configured manually in the Back Office application settings.
For additional security,signatureandtimestampvalues can be sent to your CRM along with the return URL (only available when method is manually set). See the basic signature algorithm here.
Available customer data conditions:
| Condition | Description | Example |
|---|---|---|
{{customer.pin}} |
Unique customer id in your system | https://yoursite.com/success/{{customer.pin}} |
{{customer.first_name}} |
The name of the user who conducted the transaction | https://yoursite.com/success/{{customer.first_name}} |
{{customer.last_name}} |
Last name of the user who conducted the transaction | https://yoursite.com/success/{{customer.last_name}} |
{{customer.dob}} |
DOB of the user who conducted the transaction | https://yoursite.com/success/{{customer.dob}} |
User data is taken from the data that is sent to us when initializing init methods (API 1.2).
Available transaction data conditions:
| Condition | Description | Example |
|---|---|---|
{{transaction.transaction_type}} |
Transaction Type. . Please refer to Transaction Object Definition specification for possible values. | https://yoursite.com/success/ {{transaction.transaction_type}} |
{{transaction.transaction_status}} |
Current Transaction Status. Please refer to Transaction Flow specification for possible values. | https://yoursite.com/success/ {{transaction.transaction_status}} |
{{transaction.transaction_id}} |
Transaction ID in your CRM | https://yoursite.com/success/ {{transaction.transaction_id}} |
{{transaction.trace_id}} |
Transaction ID in our system | https://yoursite.com/success/ {{transaction.trace_id}} |
{{transaction.order_id}} |
A value referencing a unique order id within your shopping cart system. This value will be referenced within the cashier for payment attempts. ( init-checkout, init-pay-out-order) |
https://yoursite.com/success/ {{transaction.order_id}} |
{{transaction.amount}} |
Amount of funds | https://yoursite.com/success/ {{transaction.amount}} |
{{transaction.currency}} |
Transaction currency | https://yoursite.com/success/ {{transaction.currency}} |
{{transaction.payment_method}} |
Payment Method Transactions (Visa, MasterCard, Skrill ...) | https://yoursite.com/success/ {{transaction.payment_method}} |
{{transaction.payment_processor}} |
Payment processor that processes the transaction | https://yoursite.com/success/ {{transaction.payment_processor}} |
{{transaction.auth_token}} |
Token that you get when initializing init methods |
https://yoursite.com/success/ {{transaction.auth_token}} |
You can also combine conditions.
HTTP POST Example:
https://yoursite.com/return_after_transaction/{{transaction.transaction_status}}/{{transaction.trace_id}}
HTTP GET Example:
https://yoursite.com/return_after_transaction?transaction_status={{transaction.transaction_status}}&tid={{transaction.trace_id}}