API Reference
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_1626945143520"
  }'
{
    "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"
    }
}
NameTypeDescriptionExample
order_idstring, requiredOrder identifier for your system.order_6765
order_amountfloat, required
(provide in two decimal places)
Order amount.12.70
order_currencystring, requiredValid order currency. We use the ISO 4217 currency list.INR
order_notestring, requiredOrder related extra detailPayment for web host
service_typestring, requiredOrder service type
DIGITAL {for digital services}
PHYSICAL_GOODS {for shipable goods}
DIGITAL
customer_namestring, requiredName of your customer.John Deo
customer_emailstring, requiredEmail of your customer.[email protected]
customer_phonestring, requiredContact details of your customer.9896989698
customer_address_line1string, requiredAddress of your customer.Capital Office, Kemp House, 152
customer_address_line2string, optionalExtra details about address of your customer.
customer_address_citystring, requiredCity of your customer.152 - 160 City Road
customer_address_statestring, requiredState of your customer.London
customer_address_countrystring, requiredCountry of your customer.UK
customer_address_postal_codestring, requiredPostal code of your customer.EC1V 2NX
order_checksumhash, requiredGenerated Checksumdg65sdg41d6f5g4dfg4fg4df6gdg==
return_urlurl, requiredReturn on merchant website from Payarise checkout page to pass transation status NOTE - also include order_id parameter with order_id valueshttps://merchant.in/process_return.php?order_id={order_id}
Error CodeMessage
200API authentication successful!
400Missing authentication parameters
401Unauthorized - API authentication failed
405Unauthorized - Passed method not allowed
409Request is not unique or correct
422Missing required fields in body data or invalid JSON data
500Server Error