If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to complete the payment. As with other redirect payment methods, you need to handle the redirect after the shopper returns to your app.
GoPay is supported starting with Android Component version 3.7.3. For more information, refer to Release notes.
Before you begin
This page explains how to add GoPay to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.
Before starting your GoPay integration:
- Make sure that you have set up your back end implementation for making API requests.
- Add GoPay in your Customer Area.
Show GoPay in your payment form
Include GoPay in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
- Specify in your /paymentMethods request:
The response contains
We provide logos for GoPay which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
When the shopper proceeds to pay, you need to:
From your server, make a /payments request, specifying:
paymentMethod.type: Set this to gopay_wallet.
returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the
The /payments response contains an
actionobject with the information needed to redirect the shopper.
- Pass the
actionobject to your client app.
Handle the redirect
Use the Redirect Component to redirect the shopper to GoPay.
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
actionComponentData.detailsobject from the Redirect Component.
You receive a response containing:
resultCode: Use this to present the payment result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for GoPay are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.|
|Cancelled||The shopper cancelled the payment while on GoPay's website.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed.||Inform the shopper that there was an error processing their payment. The response contains a
|The shopper has completed the payment but the final result is not yet known.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by GoPay.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
|OFFER_CLOSED||true||The shopper did not complete the payment.||Cancel the order and inform the shopper that the payment timed out.|
Recurring paymentsGoPay supports recurring transactions. To make recurring transactions, you need to:
Create a token
To create a token, include in your /payments request:
- shopperReference: Your unique identifier for the shopper (minimum length three characters).
When the payment has been settled, you receive a webhook containing:
pspReferenceof the initial payment.
pspReference: This is the token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.
Make a payment with a token
To make a recurring with a token, make a /payments request and include:
paymentMethod.storedPaymentMethodId: The shopper's payment token.
You can also get this value by using the /listRecurringDetails endpoint.
shopperReference: Your unique identifier for the shopper.
Test and go live
When you want to test GoPay, contact our Support Team.
Refer to GoPay's knowledge base for more information about testing GoPay payments.
Before you can accept live GoPay payments, you need to submit a request for GoPay in your live Customer Area.