No momento, esta página não está disponível em português
Payment-method icon

GoPay Drop-in integration

Add GoPay to an existing Drop-in integration.

Our Android Drop-in renders GoPay in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to check the payment result after the shopper returns to your app.

GoPay is supported starting with Android Drop-in 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 Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your GoPay integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
  2. Add GoPay in your Customer Area.

Show GoPay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show GoPay in your payment form, specify in your /paymentMethods request:

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

  1. Pass the paymentComponentData.paymentMethod to your server.

  2. From your server, make a /payments request, specifying:

    • paymentMethod: The paymentComponentData.paymentMethod from your client app.
    • returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
    • channel: Android.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

If your integration is set up correctly, the action object is passed from your server to the client.

Check the payment result

Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

From your server, make a POST /payments/details request providing:

  • details: The actionComponentData.details object from Drop-in.

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

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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 refusalReason, indicating the cause of the error.
Pending or
Received
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.

If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment. The webhooks you can receive for GoPay are:

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 payments

GoPay supports recurring transactions. To make recurring transactions, you need to:
  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

When the payment has been settled, you receive a webhook containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of 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 using the /listRecurringDetails endpoint.

  • shopperReference: Your unique identifier for the shopper.

  • shopperInteraction: ContAuth.

  • recurringProcessingModel: Subscription.

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.

See also