Skip to main content
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.

​
Prerequisites

1

Step 1

Sign up for a Razorpay account.
2

Step 2

Generate API Keys.
3

Step 3

Follow the Razorpay S2S Integration documentation.

​
Integrate Alipay on S2S

  • Create an Order and a Payment.
  • Pass method and provider parameters in create an the order and a payment API.

​
Create an Order and a Payment

Create an order along with payment using the consolidated order and payment API. This single API call combines order and payment creation, resulting in a more efficient and faster transaction process. Create an order along with payment by:
  • Authenticating using the provided credentials, ensuring access to the consolidated payment API.
  • Manually integrating the API sample codes on your server.
The following API will create an order along with payment with wallet as the payment method: /orders
Request

​
Request Parameters

amount mandatory : integer Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is 299, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
Watch Out!As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to charge a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.currency mandatory : string The currency in which the transaction should be made. View the list of supported currencies. The length must be 3 characters.
Handy TipsRazorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about Currency Conversion (May 2024).receipt optional : string Your receipt id for this order should be passed here. Maximum length is 40 characters.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.
customer_details mandatory : json object Details about the customer/user.name mandatory : string The customer’s name. For example, Gaurav Kumar.contact mandatory : string The customer’s phone number. A maximum length of 15 characters, including country code. For example, +919000090000.email mandatory : string The customer’s email address. For example, gaurav.kumar@example.com.insights optional : json object Additional details of the customer, including past transaction data.order_count optional : integer Total orders placed by the account so far on the business platform. For example, 22.chargeback_count optional : integer Total chargeback received for the customer account on the business platform. For example, 4.tier optional : string Your company’s passenger classification, such as with a frequent flyer program. In this case, you might use values such as:
  • standard
  • gold
  • platinum
booking_channel optional : string To share if the user is an agent, corporate, or individual. Possible values:
  • agent
  • corporate
  • individual
has_account optional : boolean To denote if the buyer is on guest checkout or has logged into the account. Possible values:
  • true: If the user is logged into the account.
  • false: If the user is on guest checkout.
registered_at optional : integer UNIX timestamp when the customer account was created with the business. For example, 1234567890.line_items_total optional : integer Total sum of the cart value.line_items mandatory : json object Details about the specific items added to the cart.sku mandatory : string Unique product id defined by the business. It should contain 6 digit booking reference number.name mandatory : string The name of the product.description optional : string Description of the product.quantity mandatory : integer Number of tickets/items/quantity to be purchased.type mandatory : string Defines the category type. Here it is travel. Possible values:
  • travel
  • hotel
  • e_commerce
  • mutual_fund
image_url optional : string URL of the product image.product_url optional : string URL of the product’s listing page.price mandatory : integer Unit price of the product in sub unit (needs to be inclusive of tax).offer_price mandatory : integer Offer price of the product. The offer price can be lower than the price if the business is running any discount on the product.tax_amount mandatory : integer Tax amount that needs to be added to the product. In case the offer_price is tax-inclusive, keep it blank.travel mandatory : json object Details about the type-specific data points. Will vary based on the type selected.mode mandatory : string The mode of travel. Possible values:
  • flight
  • train
  • bus
  • cab
  • others
sub_type mandatory : string The subtype of the line item. Possible values:
  • ticket
  • meal
  • insurance
  • preferred_seat
  • others
carrier_code mandatory : string International Air Transport Association (IATA) code for the carrier for this leg of the trip.departure_city mandatory : string 3 letter IATA airport code, also known as an IATA location identifier, IATA station code. For example, CPH for Copenhagen.departure_timestamp mandatory : integer UNIX timestamp. For example, 1234567890.arrival_city mandatory : string 3 letter IATA airport code, also known as an IATA location identifier, IATA station code. For example, CPH for Copenhagen.travellers mandatory : json object Details associated with passengers/travellers/beneficiaries.name mandatory : string Name of the passenger/traveler/beneficiary.email optional : string Email address of the passenger/traveler/beneficiary.age optional : integer UNIX timestamp of the date of birth of the individual. For example, 1234567890.nationality optional : string ISO3 country code to share the nationality of the individual. For example, IND.class optional : string Type of the flight ticket. Possible values:
  • economy
  • premium_economy
  • business
  • SL
  • 3A
  • 2A
  • 1A
  • CC
  • others
identity optional : json object Identity details of the passenger/beneficiary.tax_id optional : string Tax id number. For example, PAN number for India.unique_national_id optional : string National identification number. For example, Adhaar number for India.payment_config optional : array Payment capture settings for the payment. The options sent here override the account level auto-capture settings configured using the Dashboard.capture mandatory : string Option to automatically capture payment. Possible values:
  • automatic: Payments are auto-captured according to the configurations specified in the capture_options array.
  • manual: You have to manually capture payments using our Capture API or from the Dashboard.
capture_options optional : array Use this array to determine the expiry period for automatic and manual capture of payments and the refund speed in the case of non-capture.automatic_expiry_period mandatory if capture = automatic : integer Time in minutes till when payments in the authorised state should be auto-captured. Minimum value 12 minutes. This parameter is mandatory only if the value of the capture parameter is automatic.manual_expiry_period optional : integer Time in minutes till when you can manually capture payments in the authorized state.
  • Must be equal to or greater than the automatic_expiry_period value.
  • Default value 7200 minutes.
  • Maximum value 7200 minutes.
  • Payments in the authorized state after the manual_expiry_period are auto-refunded.
refund_speed mandatory : string Refund speed for payments that were not captured (automatically or manually). Possible values:
  • optimum: We try to process the refund instantly. We charge a small fee for this. If it is not possible to process an instant refund, we will process a normal refund in 5-7 working days. Learn more about instant refunds.
  • normal: The refund is processed in 5-7 working days.
If no value is passed, the refund is processed using the default speed set on the Dashboard.refund_allowed optional : string Denotes if the cart items are refundable or not. Possible values:
  • full
  • partial
  • not_allowed
campaign optional : json object Details of the campaign. Can be extended to share UTM parameters.external_campaign_id optional : string Unique identifier of the campaign. For example, PQR12453.name optional : string Name of the campaign.description optional : string A human-readable description of the campaign.channel optional : string The marketing channel used.source optional : string The referrer of the marketing event. Possible values:
  • google
  • newsletter
medium optional : string The medium that the campaign is using. Example values:
  • cpc
  • banner
notes optional : json object Key-value pair that can be 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”.payment mandatory : json object Details about the payment.contact mandatory : string Phone number of the customer. The maximum length supported is 15 characters, inclusive of country code.email mandatory : string Email address of the customer. The maximum length supported is 40 characters.method mandatory : string The method used to make the payment. Here, it should be wallet.wallet mandatory : string The wallet provider. Here, it should be alipay.

​
Response Parameters

amount : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of 299.35, the value of this field should be 29935. amount_due : integer The amount pending against the order. amount_paid : integer The amount paid against the order. attempts : integer The number of payment attempts, successful and failed, that have been made against this order. created_at : integer The UNIX timestamp at which the order is created. currency : string The currency in which the transaction should be made. View the list of supported currencies. Length should be of 3 characters. entity : string Name of the entity. Here, it is order. id : string The unique identifier of the order. notes : json object Key-value pair that can be 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”. offer_id : string The unique identifier of the offer. next : array A list of action objects available to continue the payment process. Present when the payment requires further processing. action : string indicates the next step to continue the payment process. Possible values:
  • otp_generate: Use this URL to allow the customer to generate OTP and complete the payment on your webpage.
  • redirect: Use this URL to redirect the customer to submit the OTP on the provider page.
url : string URL to be used for the action indicated. razorpay_payment_id : string Unique identifier of the payment. Present for all responses. receipt : string Your receipt id for this order should be passed here. Maximum length is 40 characters. status : string The status of the order. Possible values:
  • created: When you create an order, it is in the created state. It stays in this state till a payment is attempted on it.
  • attempted: An order moves from created to attempted state when a payment is first attempted on it. It remains in the attempted state till one payment associated with that order is captured.
  • paid: After the successful capture of the payment, the order moves to the paid state. No further payment requests are permitted once the order moves to the paid state. The order stays in the paid state even if the payment associated with the order is refunded.

​
Error Response Parameters

The error response parameters are available in the API Reference Guide.