GoPay Redirect Component

If you have an existing iOS 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.

Before you begin

This page explains how to add GoPay to your existing iOS Components integration. The iOS 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:

1. Make sure that you have set up your back end implementation for making API requests.
2. 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.

1. Specify in your /paymentMethods request:
   • 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.

The response contains paymentMethod.type: gopay_wallet.

Make a payment

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

   • paymentMethod.type: Set this to gopay_wallet.
   • returnUrl: The URL where the shopper will be redirected back to after completing the payment. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
   • channel: iOS.
   curl Ruby Java PHP Python C# NodeJS

   curl Ruby Java PHP Python C# NodeJS

   curl https://checkout-test.adyen.com/v68/payments \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
     "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
     "reference":"YOUR_ORDER_NUMBER",
     "amount":{
       "currency":"IDR",
       "value":1000
     },
     "{hint:data.paymentMethod from didSubmit}paymentMethod{/hint}":{
       "type":"gopay_wallet"
     },
     "channel":"iOS",
     "returnUrl":"my-app://"
   }'

   # 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"
     },
     :channel => "iOS",
     :returnUrl => "my-app://",
     :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
   })

   // 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(15000L);
       paymentsRequest.setAmount(amount);
   
       DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
       paymentMethodDetails.setType("gopay_wallet");
       paymentsRequest.setPaymentMethod(paymentMethodDetails);
       paymentsRequest.setChannel("iOS");
       paymentsRequest.setReference("YOUR_ORDER_NUMBER");
       paymentsRequest.setReturnUrl("my-app://");
   
       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" => 1000
     ),
     "reference" => "YOUR_ORDER_NUMBER",
     "paymentMethod" => array(
       "type" => "gopay_wallet"
     ),
     "channel" => "iOS",
     "returnUrl" => "my-app://",
     "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': 1000,
         'currency': 'IDR'
      },
      'reference': 'YOUR_ORDER_NUMBER',
      'paymentMethod': {
         'type': 'gopay_wallet'
      },
      'channel': 'iOS',
      'returnUrl': 'my-app://',
      'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
   })

   // 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", 1000);
   var details = new Model.Checkout.DefaultPaymentMethodDetails{
     Type = "gopay_wallet"
   };
   var paymentsRequest = new Model.Checkout.PaymentRequest
   {
     Reference = "YOUR_ORDER_NUMBER",
     Amount = amount,
     ReturnUrl = @"my-app://",
     MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
     PaymentMethod = details,
     Channel = "iOS"
   };
   
   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: 1000 },
       paymentMethod: {
           type: 'gopay_wallet'
       },
       channel: 'iOS',
       reference: "YOUR_ORDER_NUMBER",
       merchantAccount: config.merchantAccount,
       returnUrl: "my-app://"
   }).then(res => res);

   https://docs.adyen.com/payment-methods/gopay/ios-component#ios-payments

   The /payments response contains an action object with the information needed to redirect the shopper.
   

   /payments response

   {
   "resultCode":"RedirectShopper",
   "action":{
     "paymentMethodType":"gopay_wallet",
     "method":"GET",
     "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
     "type":"redirect"
   }
   }

   https://docs.adyen.com/payment-methods/paytm/api-only#-payments-response

2. Pass the action object to your client app.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to GoPay.

2. After the shopper returns to your app, make a POST /payments/details request from your server and provide the data from the didProvide method from your client app.
   

   /payments/details request

     curl https://checkout-test.adyen.com/v68/payments/details \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
      "details": {
        "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
    }
   }'

   https://docs.adyen.com/payment-methods/paytm/ios-component#-payments-details-request

You receive a response containing:

• resultCode: Use this to present the result to your shopper.
• pspReference: Our unique identifier for the transaction.

{
   "resultCode": "Authorised",
   "pspReference": "88154795347618C"
}

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:

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:

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:

• storePaymentMethod: true
• shopperReference: Your unique identifier for the shopper (minimum length three characters).

When the payment has been settled, you receive a notification 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 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.
• shopperInteraction: ContAuth.
• recurringProcessingModel: Subscription.
  curl Ruby Java PHP Python C# NodeJS

  curl Ruby Java PHP Python C# NodeJS

  curl https://checkout-test.adyen.com/v68/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": "my-app://"
  }'

  # 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 => "my-app://",
    :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("my-app://");
  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" => "my-app://",
    "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': 'my-app://',
     '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 = @"my-app://",
    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: "my-app://",
      shopperInteraction: "ContAuth",
      recurringProcessingModel: "Subscription"
  }).then(res => res);

  https://docs.adyen.com/payment-methods/gopay/api-only#recurring-gopay

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