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.
Before you begin
These instructions explain how to add GoPay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your GoPay integration:
- Make sure that you have set up your back end implementation.
- Add GoPay in your 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. 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
The first time your shopper makes a payment, you need to create a token. For following payments, make a payment with a token.
Create a token
-
In your initial /payments request, create a token by including:
-
paymentMethod
: Thestate.data.paymentMethod
from theonSubmit
event from your front end. -
returnUrl
: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol:http://
orhttps://
. For example,https://your-company.com/checkout/
. -
storePaymentMethod
: true. -
shopperReference
: Your unique identifier for the shopper (minimum length three characters). -
shopperInteraction
: "Ecommerce".
curl https://checkout-test.adyen.com/v66/payments \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "amount": { "currency": "IDR", "value": 10000 }, "merchantAccount": "YOUR_MERCHANT_ACCOUNT", "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{ "type":"gopay_wallet" }, "reference": "YOUR_ORDER_REFERENCE", "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..", "shopperLocale" : "ID", "storePaymentMethod": true, "shopperReference": "YOUR_UNIQUE_SHOPPER_ID", "shopperInteraction": "Ecommerce" }'
# Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen::Client.new adyen.api_key = "YOUR_X-API-KEY" response = adyen.checkout.payments({ :amount => { :currency => "IDR", :value => 1000 }, :reference => "YOUR_ORDER_NUMBER", :paymentMethod => { :type => "gopay_wallet" }, :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..", :merchantAccount => "YOUR_MERCHANT_ACCOUNT", :shopperLocale => "ID", :storePaymentMethod => true, :shopperReference => "YOUR_UNIQUE_SHOPPER_ID", :shopperInteraction => "Ecommerce" })
// Set YOUR_X-API-KEY with the API key from the Customer Area. // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments. Client client = new Client("YOUR_X-API-KEY", Environment.TEST); Checkout checkout = new Checkout(client); PaymentsRequest paymentsRequest = new PaymentsRequest(); String merchantAccount = "YOUR_MERCHANT_ACCOUNT"; paymentsRequest.setMerchantAccount(merchantAccount); Amount amount = new Amount(); amount.setCurrency("IDR"); amount.setValue(10000); paymentsRequest.setAmount(amount); DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails(); paymentMethodDetails.setType("gopay_wallet"); paymentsRequest.setPaymentMethod(paymentMethodDetails); paymentsRequest.setReference("YOUR_ORDER_NUMBER"); paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy.."); paymentsRequest.setShopperLocale("ID"); paymentsRequest.setStorePaymentMethod(true); paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID"); paymentsRequest.setShopperInteraction("Ecommerce"); PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. $client = new \Adyen\Client(); $client->setXApiKey("YOUR_X-API-KEY"); $service = new \Adyen\Service\Checkout($client); $params = array( "amount" => array( "currency" => "IDR", "value" => 10000 ), "reference" => "YOUR_ORDER_NUMBER", "paymentMethod" => array( "type" => "gopay_wallet" ), "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..", "merchantAccount" => "YOUR_MERCHANT_ACCOUNT", "shopperLocale" => "ID", "storePaymentMethod" => true, "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID", "shopperInteraction" => "Ecommerce" ); $result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen.Adyen() adyen.client.xapikey = 'YOUR_X-API-KEY' result = adyen.checkout.payments({ 'amount': { 'value': 10000, 'currency': 'IDR' }, 'reference': 'YOUR_ORDER_NUMBER', 'paymentMethod': { 'type': 'gopay_wallet' }, 'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..', 'merchantAccount': 'YOUR_MERCHANT_ACCOUNT', 'shopperLocale' : 'ID', 'storePaymentMethod': true, 'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID', 'shopperInteraction': 'Ecommerce' })
// Set your X-API-KEY with the API key from the Customer Area. var client = new Client ("YOUR_X-API-KEY", Environment.Test); var checkout = new Checkout(client); var amount = new Model.Checkout.Amount("IDR", 10000); var details = new Model.Checkout.DefaultPaymentMethodDetails{ Type = "gopay_wallet" }; var paymentsRequest = new Model.Checkout.PaymentRequest { Reference = "YOUR_ORDER_NUMBER", Amount = amount, ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..", MerchantAccount = "YOUR_MERCHANT_ACCOUNT", PaymentMethod = details, ShopperLocale ="ID", StorePaymentMethod = true, ShopperReference = "YOUR_UNIQUE_SHOPPER_ID", ShopperInteraction = "Ecommerce" }; var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. const {Client, Config, CheckoutAPI} = require('@adyen/api-library'); const config = new Config(); // Set your X-API-KEY with the API key from the Customer Area. config.apiKey = '[API_KEY]'; config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]'; const client = new Client({ config }); client.setEnvironment("TEST"); const checkout = new CheckoutAPI(client); checkout.payments({ amount: { currency: "IDR", value: 10000 }, paymentMethod: { type: 'gopay_wallet' }, reference: "YOUR_ORDER_NUMBER", merchantAccount: config.merchantAccount, returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..", shopperLocale : "ID", storePaymentMethod: true, shopperReference: "YOUR_UNIQUE_SHOPPER_ID", shopperInteraction: "Ecommerce" }).then(res => res);
-
-
Handle the redirect. Redirect the shopper to the
action.url
from the response:{ "resultCode": "RedirectShopper", "action": { "paymentData": "Ab02b4c0!BQABAgCSZT7t...", "paymentMethodType": "gopay_wallet", "method": "GET", "type": "redirect", "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=X6XtfGC3%21eyJHbHV..." }, "details": [ { "key": "redirectResult", "type": "text" } ], "paymentData": "Ab02b4c0!BQABAgCSZT7t...", "redirect": { "method": "GET", "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=X6XtfGC3%21eyJHbHV..." } }
-
When the shopper is redirected back to your website, make a /payments/details request including:
-
details
: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your website or app.
-
-
The /payments/details response contains the
recurring.recurringDetailReference
. This is the shopper's payment token.{ "additionalData" : { "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "requestAmount" : "10000", "GoPay.gopayAccountId" : "GOPAY_ACCOUNT_ID", "recurring.recurringDetailReference" : "SHOPPER_PAYMENT_TOKEN", "requestCurrencyCode" : "IDR" }, "pspReference" : "88154795347618C", "resultCode" : "Authorised", "amount" : { "currency" : "IDR", "value" : 10000 }, "merchantReference" : "YOUR_ORDER_NUMBER" }
-
eventCode
: RECURRING_CONTRACT -
originalReference
: 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 notifications. If you have not requested for this additional configuration yet, contact our Support Team.Continue to Present the payment result. -
Make a payment with a token
-
Make a subsequent recurring payment by making a /payments request and include:
-
paymentMethod.storedPaymentMethodId
: The shopper's payment token. -
shopperReference
: Your unique identifier for the shopper (minimum length three characters). -
shopperInteraction
: "ContAuth". -
recurringProcessingModel
: "Subscription".
curl https://checkout-test.adyen.com/v66/payments \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "amount":{ "value":10000, "currency":"IDR" }, "paymentMethod":{ "type":"gopay_wallet", "storedPaymentMethodId":"7219687191761347" }, "reference":"YOUR_ORDER_NUMBER", "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "shopperReference":"YOUR_UNIQUE_SHOPPER_ID", "shopperInteraction":"ContAuth", "recurringProcessingModel": "Subscription", "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy.." }'
# Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen::Client.new adyen.api_key = "YOUR_X-API-KEY" response = adyen.checkout.payments({ :amount => { :currency => "IDR", :value => 10000 }, :reference => "YOUR_ORDER_NUMBER", :paymentMethod => { :type => "gopay_wallet", :storedPaymentMethodId => "7219687191761347" }, :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..", :shopperReference => "YOUR_UNIQUE_SHOPPER_ID", :merchantAccount => "YOUR_MERCHANT_ACCOUNT", :shopperInteraction => "ContAuth", :recurringProcessingModel => "Subscription" })
// Set YOUR_X-API-KEY with the API key from the Customer Area. // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments. Client client = new Client("YOUR_X-API-KEY", Environment.TEST); Checkout checkout = new Checkout(client); PaymentsRequest paymentsRequest = new PaymentsRequest(); String merchantAccount = "YOUR_MERCHANT_ACCOUNT"; paymentsRequest.setMerchantAccount(merchantAccount); Amount amount = new Amount(); amount.setCurrency("IDR"); amount.setValue(10000); paymentsRequest.setAmount(amount); DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails(); paymentMethodDetails.storedPaymentMethodId("7219687191761347"); paymentMethodDetails.setType("gopay_wallet"); paymentsRequest.setPaymentMethod(paymentMethodDetails); paymentsRequest.setReference("YOUR_ORDER_NUMBER"); paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy.."); paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID"); paymentsRequest.setShopperInteraction("ContAuth"); paymentsRequest.setRecurringProcessingModel("Subscription"); PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. $client = new \Adyen\Client(); $client->setXApiKey("YOUR_X-API-KEY"); $service = new \Adyen\Service\Checkout($client); $params = array( "amount" => array( "currency" => "IDR", "value" => 10000 ), "reference" => "YOUR_ORDER_NUMBER", "paymentMethod" => array( "type" => "gopay_wallet", "storedPaymentMethodId" => "7219687191761347" ), "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..", "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID", "recurringProcessingModel" => "Subscription", "shopperInteraction" => "ContAuth", "merchantAccount" => "YOUR_MERCHANT_ACCOUNT" ); $result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen.Adyen() adyen.client.xapikey = 'YOUR_X-API-KEY' result = adyen.checkout.payments({ 'amount': { 'value': 10000, 'currency': 'IDR' }, 'reference': 'YOUR_ORDER_NUMBER', 'paymentMethod': { 'type': 'gopay_wallet', 'storedPaymentMethodId': '7219687191761347' }, 'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..', 'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID' 'merchantAccount': 'YOUR_MERCHANT_ACCOUNT', 'shopperInteraction':'ContAuth', 'recurringProcessingModel': 'Subscription' })
// Set your X-API-KEY with the API key from the Customer Area. var client = new Client ("YOUR_X-API-KEY", Environment.Test); var checkout = new Checkout(client); var amount = new Model.Checkout.Amount("IDR", 10000); var details = new Model.Checkout.DefaultPaymentMethodDetails{ Type = "gopay_wallet", StoredPaymentMethodId = "7219687191761347" }; var paymentsRequest = new Model.Checkout.PaymentRequest { Reference = "YOUR_ORDER_NUMBER", Amount = amount, ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..", MerchantAccount = "YOUR_MERCHANT_ACCOUNT", ShopperReference = "YOUR_UNIQUE_SHOPPER_ID", RecurringProcessingModel = "Subscription", ShopperInteraction = "ContAuth", PaymentMethod = details }; var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. const {Client, Config, CheckoutAPI} = require('@adyen/api-library'); const config = new Config(); // Set your X-API-KEY with the API key from the Customer Area. config.apiKey = '[API_KEY]'; config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]'; const client = new Client({ config }); client.setEnvironment("TEST"); const checkout = new CheckoutAPI(client); checkout.payments({ amount: { currency: "IDR", value: 10000 }, paymentMethod: { type: 'gopay_wallet', storedPaymentMethodId: "7219687191761347" }, reference: "YOUR_ORDER_NUMBER", merchantAccount: config.merchantAccount, shopperReference: "YOUR_UNIQUE_SHOPPER_ID", returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..", shopperInteraction: "ContAuth", recurringProcessingModel: "Subscription" }).then(res => res);
-
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 notification 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 notification webhooks to know the outcome of the payment. The notification 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. |
Test and go live
Use the following credentials to test GoPay :
Phone number | PIN | One-time password |
---|---|---|
6211295671000 | 246802 | 123456 |
6511220000 | 246802 | 123456 |
913129567100 | 246802 | 123456 |
Check the status of GoPay test payments in your Customer Area > Transactions > Payments.
Before you can accept live GoPay payments, you need to submit a request for GoPay in your live Customer Area.