curl --request POST \
--url {api_base_url}/order \
--header 'Content-Type: application/json' \
--header 'x-client-id: <App ID>' \
--header 'x-client-secret: <Secret Key>' \
--header 'order-source: reset-api' \
--data '{
"order_id": "order_1626945143520",
"order_amount": 10.12,
"order_currency": "INR",
"order_note": "Additional order info",
"service_type": "DIGITAL || PHYSICAL_GOODS",
"customer_name": "name",
"customer_email": "[email protected]",
"customer_phone": "9816512345",
"customer_address_line1": "Capital Office, Kemp House",
"customer_address_line2": "152 - 160 City Road",
"customer_address_city": "London",
"customer_address_state": "London",
"customer_address_country": "UK",
"customer_address_postal_code": "EC1V 2NX",
"order_checksum": "dg65sdg41d6f5g4dfg4fg4df6gdg==",
"return_url": "https://merchant.in/process_return.php?order_id={order_id}"
}'
{
"code": "200",
"status": "success",
"message": "API authentication successful!",
"return_data": {
"kwikX_order_id": "OD_85454d2998c3a59ceb7d99ca1",
"created_at": "31-07-2023 11:24 AM",
"order_id": "order_16sdd26ddds9564ddf5f143520",
"order_status": "UN_PAID",
"order_token": "toc_de1aae3c6739e170b92a3427efedc19bfd510a9c29eca8ce9bf6b30f6800acb2",
"payment_link": "https://uat.api.kwikpaisa.com/payment?payload=2d93f418c43767a0a1e6ef6cf9ea7dcf14c17885a0b7348e6be4ae7ff647fb2e"
}
}
{
"code": "401",
"status": "failed",
"message": "API authentication failed!",
"return_data": {
"description": "Unauthorized - API authentication failed"
}
}
| Name | Type | Description | Example |
|---|---|---|---|
| order_id | string, required | Order identifier for your system. | order_6765 |
| order_amount | float, required (provide in two decimal places) | Order amount. | 12.70 |
| order_currency | string, required | Valid order currency. We use the ISO 4217 currency list. | INR |
| order_note | string, required | Order related extra detail | Payment for web host |
| service_type | string, required | Order service type DIGITAL {for digital services} PHYSICAL_GOODS {for shipable goods} | DIGITAL |
| customer_name | string, required | Name of your customer. | John Deo |
| customer_email | string, required | Email of your customer. | [email protected] |
| customer_phone | string, required | Contact details of your customer. | 9896989698 |
| customer_address_line1 | string, required | Address of your customer. | Capital Office, Kemp House, 152 |
| customer_address_line2 | string, optional | Extra details about address of your customer. | |
| customer_address_city | string, required | City of your customer. | 152 - 160 City Road |
| customer_address_state | string, required | State of your customer. | London |
| customer_address_country | string, required | Country of your customer. | UK |
| customer_address_postal_code | string, required | Postal code of your customer. | EC1V 2NX |
| order_checksum | hash, required | Generated Checksum | dg65sdg41d6f5g4dfg4fg4df6gdg== |
| return_url | url, required | Return on merchant website from Payarise checkout page to pass transation status NOTE - also include order_id parameter with value {order_id} | https://merchant.in/process_return.php?order_id={order_id} |
| Error Code | Message |
|---|---|
| 200 | API authentication successful! |
| 400 | Missing authentication parameters |
| 401 | Unauthorized - API authentication failed |
| 405 | Unauthorized - Passed method not allowed |
| 409 | Request is not unique or correct |
| 422 | Missing required fields in body data or invalid JSON data |
| 500 | Server Error |