Skip to main content

Returning your customer to you

Data we'll return#

Usually, we'll be able to redirect your customer back to your website or mobile app, using the appropriate return URL. We will always send a parameter called volt in the query string when we return the customer to you.

This field contains a Json string comprising 3 fields. The volt parameter will be sent base64 encoded so you'll need to base64 decode it before processing.

https://success.customer.com?volt=eyJpZCI6ICJ7Vm9sdCdzIHBheW1lbnQgVVVJRH0iLCJ1bmlxdWVSZWZlcmVuY2UiOiAie3lvdXIgaWQgZm9yIHRoZSBwYXltZW50fSIsInN0YXR1cyI6ICJ7Q09NUExFVEVEfEZBSUxFRHxQRU5ESU5HfSJ9
{
"id": "{Volt's payment UUID}",
"uniqueReference": "{your id for the payment}",
"status": "{COMPLETED|FAILED|PENDING}"
}

Additional parameters#

In addition to the volt parameter, we'll also append any custom parameters you requested to be passed back in the return URL. These parameters will not be additionally encoded by Volt, but passed back exactly as requested.

If these parameters contain sensitive information we suggest that you encrypt them before sending them in your intial payment request.

Where we'll return your customer to#

On successful payment initiation#

Once the customer has confirmed the payment and it's been successfully initiated, Volt will show your customer a quick confirmation and redirect them back to the success URL you defined here.

Notification#

At this point we'll also send a payment notification POST with a status of COMPLETED to your previously configured URL. You can see more details about this process here.

Important

The success notification is only a confirmation that the payment was successfully initiated at the bank. Some banks allow payments to be cancelled after they are initiated so this is not a guarantee that the funds will arrive in your account.

Other outcomes#

Not all requests will result in an instantly successful payment initiation. Some may be delayed, some may be unsuccessful due to different circumstances.

Pending#

There could be a number of reasons that the payment initiation has a status of PENDING.

  • For corporate accounts, it's typical that the payment needs to be authorised by another person before being sent.
  • For higher-value payments or where it's the first payment to a new beneficiary, banks sometimes do additional checks before releasing the payment.

At this point we'll also send a POST with a status of PENDING to your notification URL and then redirect your customer back to your website or application (to the pending URL you defined defined here)

If a payment is in a pending state, it will eventually be successful or fail. We'll send an updated payment notification to you with any new status updates. You should never release goods or services until you receive the funds into your bank account.

Cancelled, abandoned, failed#

The payment could also fail for any number of reasons, some of these being :-

  • The payment was not authorised due to insufficient funds
  • The customer cancelled the payment
  • There was an error at the bank
  • The payment was refused by the bank
  • The customer simply abandoned the payment process

If a payment could not be completed, we'll send a POST with a status of FAILED to your notification URL and then redirect your customer back to your website or application (to the failure URL you defined here)

Detailed information as to why a payment failed can be found in Fuzebox.