Nevope UAT

Intent / Seamless

Payment Request API:

This API enables money transfers to and from your customers' linked bank accounts directly within your application.

Method	Environment	Url
POST	Production	https://pg.nevope.com/api/v1/payment
POST	UAT/Staging	https://uat.nevope.com/api/v1/payment

Header Parameter:

x-merchant-id	Provide By Nevope
x-api-key	Provide By Nevope
Content-Type	application/json

Note: API Key & Merchant ID will be shared by Nevope.

For UAT :

Api Key : C32D36F8C31EF86E77810DC1229F1045993A4D1912C7410B287159288D999D6D

Merchant Id : fc2510fa-ace0-4821-a331-cbc71cccd763

Request paramenter description :

Key

Type / Mandatory

Length

Description

Possible values/Example

order_id

Alphanumeric (required)

40

Merchant Unique Transaction Id

ORD_123456777

payment_amount

Numeric (12,2) (required)

12,2

Payment Amount in rupees

200

payment_method

Alphanumeric (required)

10

Payment Method
Value: UPI

UPI

checkout_type

Alphanumeric (required)

10

Use value DIRECT to skip UPI intent flow

DIRECT

return_url

Alphanumeric (required)

100

Redirecting to URL with POST params:
transaction_id, order_id

https://secure.nevope.com

customer_id

Alphanumeric (required)

50

Unique ID for Customer/Player

CST_11111

customer_name

Alphanumeric (required)

60

Customer/Player Name

CST_11111

customer_phone

Numeric(required)

20

Customer/Player Phone

9888774455

customer_email

Alphanumeric (required)

70

Customer/Player Email

test@gmail.com

additional_field_1

Alphanumeric (optional)

80

parameter can be used for sending additional information about the transaction.

additional_field_2

Alphanumeric (optional)

80

parameter can be used for sending additional information about the transaction.

additional_field_3

Alphanumeric (optional)

80

parameter can be used for sending additional information about the transaction.

additional_field_4

Alphanumeric (optional)

80

parameter can be used for sending additional information about the transaction.

additional_field_5

Alphanumeric (optional)

80

parameter can be used for sending additional information about the transaction.

Sample Request Body :

{
    "order_id": "142ZA87",
    "payment_amount": 1400,
    "payment_method": "UPI",
    "return_url": "https://example.com",
    "customer_id": "124A552",
    "customer_name": "",
    "customer_phone": "",
    "customer_email": "",
    "additional_field_1": "",
    "additional_field_2": "",
    "additional_field_3": "",
    "additional_field_4": "",
    "additional_field_5": ""
}

Payout Response:

BODY PARAMS:

order id *
payment amount *
payment method *
checkout type *
return url *
customer id *
customer name *
customer phone *
customer_email
additional_field_1
additional_field_2
additional_field_3
additional_field_4
additional_field_5

Response Parameter

Sr. No	Fields	Description	Mandatory
1	status	Boolean	Yes
2	message	Alphanumeric	Yes
3	data	Object
4	data.intent	UPI Intent	Conditional (Only 200 Http Status Code)
5	data.gpay	GPay Specific UPI Intent	Conditional (Only 200 Http Status Code)
6	data.phonepe	PhonPe Specific UPI Intent	Conditional (Only 200 Http Status Code)
7	data.paytm	Paytm Specific UPI Intent	Conditional (Only 200 Http Status Code)
8	data.payment_status	Transaction Payment Status	Conditional (Only 200 Http Status Code)

Sample Response (200)

{
  "status": true,
  "message": "Transaction Created",
  "data": {
    "transaction_id": "*********",
    "order_id": "ORD_123****79",
    "merchant_id": "***********",
    "intent":"gpay://upi/pay?pa=scountoshop.QR.payu@indus&pn=ZENEX%20E %20COMME%20PRIVAT&cuast=INR&tid=PPPL
               DYQ219639197992024 14441119547eaaaef&mc=5331&tr=DYQ21963919799&am=1.00&QRexpire= 2024-12-26T
               12:04:54+05:30",
    "gpay":"gpay://upi/pay?pa=scountoshop.QR.payu@indus&pn=ZENEX%20E %20COMM%20PRIVAT&cuast=INR&tid=PPPL
            DYQ219639197992024 14441119547eaaaef&mc=5331&tr=DYQ21963919799&am=1.00&QRexpire= 2024-12-26T
            12:04:54+05:30",
    "phonepe":"phonepe://upi/pay?pa=scountoshop.QR.payu@indus&pn=ZENEX%20E %20COMM%20PRIVAT&cuast=INR&tid=PPPL
            DYQ219639197992024 14441119547eaaaef&mc=5331&tr=DYQ21963919799&am=1.00&QRexpire= 2024-12-26T
            12:04:54+05:30",
    "paytm":"paytmmp://upi/pay?pa=scountoshop.QR.payu@indus&pn=ZENEX%20E %20COMM%20PRIVAT&cuast=INR&tid=PPPL
            DYQ219639197992024 14441119547eaaaef&mc =5331&tr=DYQ21963919799&am=1.00&QRexpire= 2024-12-26T
            12:04:54+05:30",
    "payment_status": "INITIALIZED",
  }
}

Response (Failed) (400) :

{ 
    "status": false,
    "status":  "Error_Message" 
}

Payment Query :

Payment Query API Endpoint :

Method	Environment	Url
POST	Production	https://pg.nevope.com/api/v1/payment/query
POST	UAT/Staging	https://uat.nevope.com/api/v1/payment/query

Header Parameter:

x-merchant-id	Provide By Nevope
x-api-key	Provide By Nevope
Content-Type	application/json

Request Parameter :

Fields	Description	Data Type	Mandatory
order_id	Merchant Order Id	Alphanumeric	Yes

Sample Request Body :

{
     "order_id": "142ZA85"
}

Response Parameter

Sr. No	Fields	Description	Data Type	Mandatory
1	status	API Status	Boolean	Yes
2	message	API Response Message	Alphanumeric	Yes
3	data	API Response	Object	Conditional
4	data.merchant_id	Merchant Id	UUID
5	data.order_id	Merchant Order Id	Alphanumeric
6	data.transaction_id	Nevope Transaction Id	UUID
7	data.amount	Payment Amount	Numeric
8	data.fees	Payment Fees	Numeric
9	data.status	Payment Status (INITIALIZED, PENDING,SUCCESS, FAILED)	Alphabet
10	data.method	Payment Method	Alphabet
11	data.customer	Merchant Customer Details	Object
12	data.customer.id	Merchant Customer/Player Id	Alphanumeric
13	data.customer.name	Merchant Customer/Player Name	Alphabet
14	data.customer.phone	Merchant Customer/Player Phone	Numeric
15	data.customer.email	Merchant Customer/Player Email	Alphanumeric
16	data.additional_field_1	This parameter can be used for sending additional information about the transaction.	Alphanumeric
17	data.additional_field_2	This parameter can be used for sending additional information about the transaction.	Alphanumeric
18	data.additional_field_3	This parameter can be used for sending additional information about the transaction.	Alphanumeric
19	data.additional_field_4	This parameter can be used for sending additional information about the transaction.	Alphanumeric
20	data.additional_field_5	This parameter can be used for sending additional information about the transaction.	Alphanumeric
21	data.bank_response	This parameter can be used for sending additional information about the transaction.	Alphanumeric
22	data.bank_reference_no	Bank Unique Reference Number	Alphanumeric
23	data.user_input_utr	User Input Bank Unit Reference Number	Alphanumeric
24	data.payment_date	Payment Date	Date (YYYY-MM-DD HH:MM:SS)Indian Timezone

Sample Response (200)

{
     "status": true,
     "message": "Payment Details Fetched Successfully",
     "data":  {
         "merchant_id": "**************",
         "order_id": "142ZA85",
         "transaction_id": "**************",
         "amount": 1400,
         "fees": 1.4,
         "status": SUCCESS,
         "method": UPI,
         "customer":  {
             "id": 124As52,
             "name": John Doe,
             "phone": 9876543210,
             "email": john@doe.com, 
        },
         "additional_field_1": null,
         "additional_field_2": null,
         "additional_field_3": null,
         "additional_field_4": null,
         "additional_field_5": null,
         "bank_response": "Transaction Successful",
         "bank_reference_no": "321025426532",
         "user_input_utr": "321025426532",
         "payment_date": "2023-06-01 16:17:12",
        }
}

Sample Payment Response (400)

{
    "status": false,
    "message": "Error_Message",
}

Checksum Generation for Payin

Checksum Fields: payment_id : order_id :merchant_id : payment_status : payment_amount : payment_date

Algorithm:

$checksum = crc32("payment_id:order_id:merchant_id:payment_status:payment_amount:payment_date");


$checksumStr = $transactionId . ':' . $orderId . ':' . $merchantId . ':' . $paymentStatus . ':' . $paymentAmount . ':' . $paymentDate;
$checksum = crc32($checksumStr);

Payment Callback/Webhook Example

Method: POST

Headers: No request header

Expected response code: 200

Content Type: application/json

Payment Callback/Webhook Response :

{
  "event_type": "PAYIN",
  "event": "PAYIN.SUCCESS", // PAYIN.FAILED
  "checksum": 3899009463,
  "payload": {
      "transaction_id": "TRANSACTION ID",
      "order_id": "ORDER ID",
      "merchant_id": "MERCHANT ID",
      "status": "PAYMENT STATUS",
      "amount": "PAYMENT AMOUNT",
      "fees": "FEES",
      "method": "PAYMENT METHOD",
      "message": "DESCRIPTION",
      "customer": {
            "id": "CUSTOMER ID",
            "name": "CUSTOMER NAME",
            "phone": "CUSTOMER PHONE",
            "email": "CUSTOMER EMAIL"
    },
    "additional_field_1": "ADDITIONAL FIELD",
    "additional_field_2": "ADDITIONAL FIELD",
    "additional_field_3": "ADDITIONAL FIELD",
    "additional_field_4": "ADDITIONAL FIELD",
    "additional_field_5": "ADDITIONAL FIELD",
    "bank_reference_no": "BANK REFERENCE NUMBER (UTR)",
    "user_input_utr": "USER INPUT BANK REFERENCE NUMBER (UTR)",
    "transaction_date": "TRANSACTION DATE"
  }
}

Callback URL

Callback Response:

Transaction Response: