GO Web Integration

Know how to install the GO server-side SDK to interact with the Razorpay API and start accepting payments.


You can use the Razorpay Payment Gateway to accept payments via debit card, credit card, netbanking (supports 3D Secure), UPI or through any of our supported wallets.

GO Client API🔗

The API follows the following practices:

  • This will require a GitHub Package.
  • The GO client throws exceptions instead of returning errors.
  • Options are passed as an array instead of multiple arguments, wherever possible.
  • All requests and responses are mapped to a string.

Video Tutorial🔗

Watch this video to learn how to integrate Razorpay Payment Gateway with your GO website using our payment extension.

Integration Steps🔗

  1. Create a GO Directory.
  2. Integrate Orders API.
  3. Add Checkout Options.
  4. Store Fields in Server.

Step 1: Create a GO Directory🔗

Create a GO project directory with the following files - main.go, app.html and go.mod files.

Step 2: Integrate Orders API🔗

Razorpay enables you to create orders and link them to payments. Order creation is an essential step as it helps you associate every payment with an order, thus preventing multiple payments.

Orders and payments go hand-in-hand. Once the payment is captured, the order is marked paid.

Orders is a mandatory step if you want to automatically capture payments. Know more about payment capture.

Create a file, for example, main.go and add the API code given below:

Copyclient := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data := map[string]interface{}{ "amount": 50000, "currency": "INR", "receipt": "some_receipt_id", "payment_capture": 1, } body, err := client.Order.Create(data, nil)
Copy{ "id": "order_EKwxwAgItmmXdp", "entity": "order", "amount": 50000, "amount_paid": 0, "amount_due": 50000, "currency": "INR", "receipt": "receipt#1", "offer_id": null, "status": "created", "attempts": 0, "notes": [], "created_at": 1582628071 }

Parameters🔗

Here is the list of parameters for creating the order:

amount mandatory
integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.
currency mandatory
string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.
receipt optional
string Pass the receipt id created for this order. Maximum length 40 characters.
payment_capture optional
string 1 if payment capture should be done automatically or else 0.
notes optional
json object Optional notes for order. Key-value pair used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
partial_payment optional
boolean Indicates whether the customer can make a partial payment. Possible values:
  • true: - The customer can make partial payments.
  • false: (default) - The customer cannot make partial payments.

When the order is created successfully, an order_id is returned in the response. You need to store against the order defined in your system.

Payment Capture Settings🔗

After payment is authorized, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.

  • Auto-capture payments (recommended)
    Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard. Watch Out!
    Payment capture settings work only if you have integrated with Orders API in your server side. Know more about the Orders API.
  • Manually capture payments
    Each authorized payment can also be captured individually. You can manually capture payments:

Know more about Capture Settings for payments.

Step 3: Add Checkout Options🔗

Add the checkout options in your project. This is done in two steps:

  1. Create a file, for example, app.html in you folder and add the following code:
Copy<button id="rzp-button1">Pay</button> <script src="https://checkout.razorpay.com/v1/checkout.js"></script> <script> var options = { "key": "YOUR_KEY_ID", // Enter the Key ID generated from the Dashboard "amount": "50000", // Amount is in currency subunits. Default currency is INR. Hence, 50000 refers to 50000 paise "currency": "INR", "name": "Acme Corp", "description": "Test Transaction", "image": "https://example.com/your_logo", "order_id": "order_9A33XWu170gUtm", //This is a sample Order ID. Pass the `id` obtained in the response of Step 1 "handler": function (response){ alert(response.razorpay_payment_id); alert(response.razorpay_order_id); alert(response.razorpay_signature) }, "prefill": { "name": "Gaurav Kumar", "email": "gaurav.kumar@example.com", "contact": "9999999999" }, "notes": { "address": "Razorpay Corporate Office" }, "theme": { "color": "#3399cc" } }; var rzp1 = new Razorpay(options); rzp1.on('payment.failed', function (response){ alert(response.error.code); alert(response.error.description); alert(response.error.source); alert(response.error.step); alert(response.error.reason); alert(response.error.metadata.order_id); alert(response.error.metadata.payment_id); }); document.getElementById('rzp-button1').onclick = function(e){ rzp1.open(); e.preventDefault(); } </script>

The checkout parameters are given below:

key mandatory

string API Key ID that must generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100, enter 10000.

currency mandatory

string The currency in which the payment should be made by the customer. See the list of supported currencies.

name mandatory

string The merchant/company name shown on the Checkout form.

description optional

string Description of the purchase item shown on the Checkout form. Must start with an alphanumeric character.

image optional

string Link to an image (usually your business logo) shown on the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.

order_id mandatory

string Order ID generated via Razorpay Orders API.

prefill

object You can prefill the following details at Checkout.

name optional
string Cardholder's name to be pre-filled if customer is to make card payments on Checkout.
email optional
string Email address of the customer.
contact optional
string Phone number of the customer. The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside India. Examples:
  • +14155552671 (a valid non-Indian number)
  • +919977665544 (a valid Indian number).
    If 9977665544 is entered, +91 is added to it as +919977665544.
method optional
string Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values
  • card
  • netbanking
  • wallet
  • emi
  • upi
notes optional

object Set of key-value pairs that can be used to store additional information about the payment. It can hold a maximum of 15 key-value pairs, each 256 characters long (maximum).

theme

object Thematic options to modify the appearance of Checkout.

hide_topbar optional
boolean Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values are:
  • true: Hides the top bar.
  • false (default): Displays the top bar.
color optional
string Enter your brand colour's HEX code to alter the appearance of Checkout form.
backdrop_color optional
string Enter a HEX code to change the Checkout page's backdrop colour.
modal

object Options to handle the Checkout pop-up page.

backdropclose optional
boolean Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values are:
  • true: Closes the form when your customer clicks outside the checkout form.
  • false (default): Does not close the form when customer clicks outside the checkout form.
escape optional
boolean Indicates whether pressing the escape key should close the Checkout form. Possible values are:
  • true (default): Closes the form when the customer presses the escape key.
  • false: Does not close the form when the customer presses the escape key.
handleback optional
boolean Determines whether Checkout must behave similar to the browser when back button is pressed. Possible values:
  • true (default): Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout pop-up page is open.
  • false: Checkout does not simulate a back press when browser's back button is pressed.
confirm_close optional
boolean Determines whether a confirmation dialog box should be shown when customers attempt to close Checkout. Possible values:
  • true: A confirmation dialog box is shown.
  • false (default): No confirmation dialog box is displayed.
ondismiss optional
function Used to track the status of Checkout. You can pass a modal object with ondismiss: function(){} as options. This function is called when the modal is closed by the user.
animation optional
boolean Show an animation before loading of Checkout.
  • true(default): An animation appears before loading the Checkout page.
  • false: No animation appears before loading the Checkout page.
subscription_id optional

string If you are accepting recurring payments using Razorpay Checkout, you should pass the relevant subscription_id to the Checkout. Know more about Subscriptions at Checkout.

subscription_card_change optional

boolean Permit or restrict customer from changing the card linked to the subscription. You can also do this from the hosted page. Possible values:

  • true: Allow the customer to change the card from Checkout.
  • false (default): Do not allow the customer to change the card from Checkout.
recurring optional

boolean Determines if you are accepting recurring (charge-at-will) payments on Checkout via instruments such as emandate, paper NACH and so on. Possible values:

  • true: You are accepting recurring payments.
  • false (default): You are not accepting recurring payments.
callback_url optional

string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted.

redirect optional

boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url must be passed while using this parameter. Possible values:

  • true: Customer is redirected to the specified callback URL in case of payment failure.
  • false (default): Customer is shown the Checkout pop-up to retry the payment.
customer_id optional

string Unique identifier of customer. Used for:

timeout optional

integer Sets a timeout on Checkout, in seconds. After the specified time limit, the customer will not be able to use Checkout.

remember_customer optional

boolean Determines whether to allow saving of cards. It can also be configured via the Razorpay Dashboard. Possible values:

  • true: Enables card saving feature.
  • false (default): Disables card saving feature.
readonly

object Marks fields as read-only.

contact optional
boolean Used to set the contact field as readonly. Possible values: - true: Customer will not be able to edit this field. - false (default): Customer will be able to edit this field.
email optional
boolean Used to set the email field as readonly. Possible values: - true: Customer will not be able to edit this field. - false (default): Customer will be able to edit this field.
name optional
boolean Used to set the name field as readonly. Possible values: - true: Customer will not be able to edit this field. - false (default): Customer will be able to edit this field.
send_sms_hash optional

boolean Used to auto-read OTP for cards and net banking pages. Applicable from Android SDK version 1.5.9 and above. Possible values:

  • true: OTP is auto-read.
  • false (default): OTP is not auto-read.
allow_rotation optional

boolean Used to rotate payment page as per screen orientation. Applicable from Android SDK version 1.6.4 and above. Possible values:

  • true: Payment page can be rotated.
  • false (default): Payment page cannot be rotated.

Step 4: Store Fields in Server🔗

A successful payment returns the following fields to the Checkout form.

  • You need to store these fields in your server.

  • You can confirm the authenticity of these details by verifying the signature in the next step.

Copy{ "razorpay_payment_id": "pay_29QQoUBi66xm2f", "razorpay_order_id": "order_9A33XWu170gUtm", "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d" }
razorpay_payment_id
string Unique identifier for the payment returned by Checkout only for successful payments.
razorpay_order_id
string Unique identifier for the order returned by Checkout.
razorpay_signature
string Signature returned by the Checkout. This is used to verify the payment.

Address Verification System🔗

If you are accepting international payments, you can use Razorpay's Address Verification System (AVS). AVS verifies if a customer's billing address (postal code and the billing street address) matches the billing address on file with the card issuer. Based on the response from the issuer, Razorpay will accept or cancel the transaction. This helps in the prevention of fraud in international payments.

Know more about Address Verification System.

Test Integration🔗

After the integration is complete, you need to test the integration to ensure that it is working as expected. You can make a test transaction using the test cards, verify the payment status from the Razorpay Dashboard, APIs or subscribe to related Webhook events to take appropriate actions at your end. After testing the integration in test mode, you can start accepting payments from your customers in real-time.

Test Payments🔗

You can make test payments using any of the payment methods available at the checkout. No money is deducted from the customer's account as this is a simulated transaction. In the checkout code, ensure that you have entered the API keys generated in the test mode.

Test Cards🔗

You can use any of the test cards to make transactions in the test mode. Use any valid expiration date in the future and any random CVV to create a successful payment.

Card Network

Domestic / International

Card Number

Mastercard

Domestic

5104 0600 0000 0008

Visa

Domestic

4111 1111 1111 1111

Mastercard

International

5555 5555 5555 4444
5105 1051 0510 5100

Visa

International

4012 8888 8888 1881
4000 1841 8621 8826

Accept Live Payments🔗

Once you have tested the end-to-end flow of funds in test mode and are confident that the integration is working as expected, switch to the live mode to accept payments from customers. However, make sure that you swap the test API keys with the live keys.

To generate the API key in live mode:

  1. Log into Razorpay Dashboard and switch to Live mode on the menu.
  2. Navigate to Settings → API Keys → Generate Key to generate the API key for live mode.
  3. Download the keys and save them securely.
  4. Replace the test API key with the Live Key in the checkout code to accept real-time payments.
×