> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Alipay - Ecommerce S2S Integration
> Secure Server-to-Server (S2S) integration that enables seamless and reliable processing and a smooth payment experience for your customers.
**Feature Request**
This is an on-demand feature. Please raise a request with our [Support team](https://razorpay.com/support/#request) to get this feature activated on your Razorpay account.
to get this feature activated on your account.
## Prerequisites
[Sign up](https://dashboard.razorpay.com/#/access/signup) for a Razorpay account.
Generate API Keys.
Follow the [Razorpay S2S Integration documentation](/payments/payment-gateway/s2s-integration).
## Integrate Alipay on S2S
Create an Order and a Payment. And pass `method` and `wallet` parameters in the create an 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:
* Making a single API call to Razorpay, combining order and payment creation.
* 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:
#### API Sample Code
The following is a sample API request and response for creating an order and payment:
/orders
````curl: Request theme={null}
curl -X POST https://api.razorpay.com/v1/orders
-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
"amount": 50000,
"currency": "INR",
"receipt": "receipt#1111",
"partial_payment": true,
"customer_details": {
"name": "Gaurav Kumar",
"contact": "+919000090000",
"email": "gauravkumar@example.com",
"insights": {
"order_count": "22",
"chargeback_count": "4",
"tier": "gold",
"booking_channel": "agent",
"has_account": true,
"registered_at": 1234567890
},
"shipping_address": {
"line1": "Mantri apartment",
"line2": "Koramangala",
"city": "Bengaluru",
"country": "IND",
"state": "Karnataka",
"zipcode": "560032",
"latitude": null,
"longitude": null
},
"billing_address": {
"line1": "Mantri apartment",
"line2": "Koramangala",
"city": "Bengaluru",
"country": "IND",
"state": "Karnataka",
"zipcode": "560032",
"latitude": null,
"longitude": null
}
},
"shipping_details": {
"method": "sameday",
"gift_wrap": false
},
"line_items_total": 5000,
"line_items": [
{
"type": "e_commerce",
"sku": "1gr367",
"name": "TEST",
"description": "TEST",
"quantity": 1,
"image_url": "http://url",
"product_url": "http://url",
"price": 5000,
"offer_price": 5000,
"tax_amount": 0,
"e_commerce": {
"other_product_codes": {
"upc": "12r34",
"ean": "123r4",
"unspsc": "123s4"
}
}
}
],
"payment_config": {
"capture": "automatic",
"capture_options": {
"automatic_expiry_period": 12,
"manual_expiry_period": 7200,
"refund_speed": "optimum"
}
},
"refund_allowed": "full",
"campaign": {
"external_campaign_id": "PQR1234",
"name": "",
"description": "",
"channel": "",
"source": "website",
"medium": ""
},
"notes": {
"key1": "value3",
"key2": "value2"
},
"payment": {
"contact": "9000090000",
"email": "gaurav.kumar@example.com",
"method": "wallet",
"wallet": "alipay"
}
}'
```json: Success
{
"amount": 50000,
"amount_due": 50000,
"amount_paid": 0,
"attempts": 10,
"created_at": 1706507580,
"currency": "INR",
"entity": "order",
"id": "order_NUJs9C1Luflzts",
"notes": {
"key1": "value3",
"key2": "value2"
},
"offer_id": null,
"payment_workflow": {
"next": [
{
"action": "redirect",
"url": "https://api.razorpay.com/v1/payments/O0NSBQgY0BbC4b/authenticate"
}
],
"razorpay_payment_id": "pay_O0NSBQgY0BbC4b"
},
"receipt": "receipt#1111",
"status": "attempted"
}
````
### 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](/payments/international-payments#supported-currencies). The length must be 3 characters.
**Handy Tips**
Razorpay 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](/payments/international-payments/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 merchant. For example, 1234567890.
`shipping_address` *optional*
: `Json object` This will have details about the order's shipping address.
`line1` *optional*
: `string` Address Line 1 of the address
`line2` *optional*
: `string` Address Line 2 of the address
`city` *optional*
: `string` city of the address. For example, `Bengaluru`.
`country` *optional*
: `string` ISO3 country code of the billing address. For example, `IND`.
`state` *optional*
: `string` name of the state. For example, `KA`.
`zipcode` *optional*
: `string` Zipcode of the state. For example, `560068`.
`latitude` *optional*
: `float` Latitude of the position expressed in decimal degrees (WSG 84), e.g. 6.244203. A positive value denotes the northern hemisphere or the equator, and a negative value denotes the southern hemisphere. The number of digits represents the precision of the coordinate.
`longitude` *optional*
: `float` Longitude of the position expressed in decimal degrees (WSG 84), e.g. -75.581211. A positive value denotes east longitude or the prime meridian, and a negative value denotes west longitude. The number of digits represents the precision of the coordinate.
`billing_address` *mandatory*
: `Json object` This will have details about the billing address of the customer/user.
`line1` *optional*
: `string` Address Line 1 of the address
`line2` *optional*
: `string` Address Line 2 of the address
`city` *optional*
: `string` city of the address. For example, `Bengaluru`.
`country` *optional*
: `string` ISO3 country code of the billing address. For example, `IND`.
`state` *optional*
: `string` name of the state. For example, `KA`.
`zipcode` *optional*
: `string` Zipcode of the state. For example, `560001`.
`latitude` *optional*
: `float` Latitude of the position expressed in decimal degrees (WSG 84), e.g. 6.244203. A positive value denotes the northern hemisphere or the equator, and a negative value denotes the southern hemisphere. The number of digits represents the precision of the coordinate.
`longitude` *optional*
: `float` Longitude of the position expressed in decimal degrees (WSG 84), e.g. -75.581211. A positive value denotes east longitude or the prime meridian, and a negative value denotes west longitude. The number of digits represents the precision of the coordinate.
`shipping_details` *optional*
: `Json object` This will have the order's shipping details.
`method` *optional*
: `enum` Shipping method for the product. Possible values:
* `lowcost`: Lowest-cost service.
* `sameday`: Courier or same-day service.
* `oneday`: Next-day or overnight service.
* `twoday`: Two-day service.
* `threeday`: Three-day service.
* `pickup`: Store pick-up.
* `other`: Other shipping method.
* `none`: No shipping method because the product is a service or subscription.
`gift_wrap` *optional*
: `boolean` Indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values:
* `true`: The customer requested gift wrapping.
* `false`: The customer did not request gift wrapping.
`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.
`type` *mandatory*
: `string` Defines the category type. Possible values:
* `travel`
* `hotel`
* `e_commerce`
* `mutual_fund`
`sku` *optional*
: `string` The unique product id defined by the business.
`name` *optional*
: `string` The name of the product.
`description` *optional*
: `string` Description of the product.
`quantity` *optional*
: `integer` Number of tickets/items/quantity to be purchased.
`image_url` *optional*
: `string` URL of the product image.
`product_url` *optional*
: `string` URL of the product’s listing page.
`price` *optional*
: `integer` Unit price of the product in paisa. (needs to be inclusive of tax)
`offer_price` *optional*
: `integer` Offer price of the product. The offer price can be lower than the price if the business runs a discount on the product.
`tax_amount` *optional*
: `integer` Tax amount that needs to be added to the product. In case the **offer\_price** is tax-inclusive, keep it blank.
`e_commerce` *optional*
: `json object` Details about the type-specific data points. Will vary based on the type selected.
`other_product_codes` *optional*
: `object` Array to collect different codes that can identify the item type. Possible values:
`upc`
: `string` Universal Product Code (UPC; redundantly: UPC code) is a barcode symbology used worldwide to track trade items in stores. UPC consists of 12 numeric digits that are uniquely assigned to each trade item
`ean`
: `string` European Article Numbers (EAN) is a type of barcode that encodes an article number. Contains 8 (EAN-8) or 13 (EAN-13) numerical digits.
`unspsc`
: `string` The United Nations Standard Products and Services Code (UNSPSC) is a taxonomy of products and services used in eCommerce. It is a four-level hierarchy coded as an eight-digit number, with an optional fifth level adding two more digits.
`payment_config` *optional*
: `array` Payment capture settings for the payment. The options sent here override the [account level auto-capture settings](/payments/payments/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](/api/payments/capture) or from the [Dashboard](/payments/payments/dashboard#manually-capture-payments).
`capture_options` *optional*
: `array` Use this array to determine the expiry period for automatic and [manual capture](/payments/payments/capture-settings/api) 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 `authorized` state should be auto-captured.
Minimum value `12` minutes. This parameter is mandatory only if the value of `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](/payments/refunds#how-instant-refunds-work).
* `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](/payments/refunds#setting-the-default-speed-of-refunds).
`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 and so on.
`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](/payments/international-payments#supported-currencies). Length must 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](/api/orders/create).