Responses
The Payment Response
The payment response must implement ResponseInterface. There are two main types of response:
- Payment was successful (standard response)
- Website requires redirect to off-site payment form (redirect response)
Successful Response
For a successful responses, a reference will normally be generated, which can be used to capture or refund the transaction at a later date. The following methods are always available:
$response = $gateway->purchase(['amount' => '10.00', 'card' => $card])->send();
$response->isSuccessful(); // is the response successful?
$response->isRedirect(); // is the response a redirect?
$response->getTransactionReference(); // a reference generated by the payment gateway
$response->getMessage(); // a message generated by the payment gateway
In addition, most gateways will override the response object, and provide access to any extra fields returned by the gateway.
Redirect Response
The redirect response is further broken down by whether the customer’s browser must redirect using GET (RedirectResponse object), or
POST (FormRedirectResponse). These could potentially be combined into a single response class, with a getRedirectMethod().
After processing a payment, the cart should check whether the response requires a redirect, and if so, redirect accordingly:
$response = $gateway->purchase(['amount' => '10.00', 'card' => $card])->send();
if ($response->isSuccessful()) {
// payment is complete
} elseif ($response->isRedirect()) {
$response->redirect(); // this will automatically forward the customer
} else {
// not successful
}
The customer isn’t automatically forwarded on, because often the cart or developer will want to customize the redirect method (or if payment processing is happening inside an AJAX call they will want to return JS to the browser instead).
To display your own redirect page, simply call getRedirectUrl() on the response, then display it accordingly:
$url = $response->getRedirectUrl();
// for a form redirect, you can also call the following method:
$data = $response->getRedirectData(); // associative array of fields which must be posted to the redirectUrl