If you are using Android Drop-in v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Drop-in integration guide.
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 Drop-in version 3.7.3. For more information, refer to Release notes.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have built an Advanced flow Android Drop-in integration. |
Setup steps | Before you begin, 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:
- countryCode: Any supported country/region. For example, ID.
- amount.currency: Any supported currency. For example, IDR.
- amount.value: The value of the payment, in minor units. For example, submit a value of 1000 IDR as 1000.
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod
.
-
Pass the
paymentComponentData.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
paymentMethod
: ThepaymentComponentData.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 theRedirectComponent.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
: TheactionComponentData.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 have 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 payments. The first time your shopper makes a payment, you need to create a token, which you can use later to make Subscription
or CardOnFile
payments. Note that the flows for Subscription
and CardOnFile
payments are different.
Create a token
To create a token, include in your /payments request:
storePaymentMethod
: true- shopperReference: Your unique identifier for the shopper (minimum length three characters).
- recurringProcessingModel: The recurring payment type.
When the payment has been settled, you receive a webhook containing:
eventCode
: RECURRING_CONTRACToriginalReference
: ThepspReference
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 Subscription payment with a token
To make a recurring Subscription
payment 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
The /payments response contains:
resultCode
: Use this to show your shopper the payment result.
When the payment is processed, you receive the final status of the payment in a webhook containing:
eventCode
: AUTHORISATIONsuccess
: true
Make a recurring CardOnFile payment with a token
Recurring CardOnFile
payments with GoPay go through a challenge flow to reduce the likelihood of fraudulent transactions. You must redirect the shopper to GoPay so they can enter their PIN.
To make a recurring CardOnFile
payment 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
: CardOnFile
The /payments response contains:
resultCode
: RedirectShopper
action
: Contains the url
to redirect the shopper to.
When the shopper is redirected back to your page, call /payments/details with the redirectResult
to complete the flow and get the status of the payment.
When the payment is processed, you receive a webhook containing the final status of the payment:
eventCode
: AUTHORISATIONsuccess
: true
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.