GoPay for API-only

Add GoPay to an existing API-only integration.

Accept GoPay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Requirement	Description
Integration type	Make sure that you have an existing API-only integration.
Setup steps	Before you begin, add GoPay in your test Customer Area.

Build your payment form for GoPay

Include GoPay in the list of available payment methods.

We provide logos for GoPay which you can use on your payment form. For more information, refer to Downloading logos.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

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.
channel: Specify Web, iOS, or Android.

The response contains paymentMethod.type: gopay_wallet.

Make a payment

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

paymentMethod.type: gopay_wallet

Additionally, you must include either of the following:

browserInfo: Information about the shopper's browser.
channel: Web.

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

Handle the redirect

To complete a GoPay payment, you need to redirect the shopper to the GoPay website or app.

To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:
- When using the HTTP GET method:
  For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
- Redirection for mobile integrations:
  For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
- details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.
In the response note the following:
- resultCode: use this to present the 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_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 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: AUTHORISATION
success: 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: AUTHORISATION
success: 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.