Payout Docs

Initiate Payout:

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/payout
POST UAT/Staging
https://uat.nevope.com/api/v1/payout
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 Parameters:

Key Type / Mandatory Length Description Possible values/Example
order_id Alphanumeric (required) 40 Merchant Unique Transaction/Order Id ORD_1122334455
payout_amount Numeric(12,2) (required) 12,2 Payout Amount in rupees 500
account_number Alphanumeric (required) 30 Bank account number 1234567890
ifsc Alphanumeric (required) 15 Bank IFSC code ICIC0000459
customer_id Alphanumeric (required) 50 Unique ID for Customer/Player CST8563210
customer_name Alphabets (required) 60 Customer/Player Name DK Patil
customer_phone Numeric (required) 20 Customer/Player Phone 9888776655
customer_email Alphanumeric (required) 70 Customer/Player Email test@gmail.com
additional_field_1 Alphanumeric (optional) 80 Additional info about the transaction
additional_field_2 Alphanumeric (optional) 80 Additional info about the transaction
additional_field_3 Alphanumeric (optional) 80 Additional info about the transaction
additional_field_4 Alphanumeric (optional) 80 Additional info about the transaction
additional_field_5 Alphanumeric (optional) 80 Additional info about the transaction

Sample Request:

Sample Request Body :

{
    "order_id": "*********",
    "payout_amount": "*********",
    "account_number": "*********",
    "customer_id": "*********",
    "customer_name": "*********",
    "customer_phone": "*********",
    "customer_email": "*********",
    "ifsc": "*********",
    "payout_amount": 100,
    "additional_field_1": "",
    "additional_field_2": "",
    "additional_field_3": "",
    "additional_field_4": "",
    "additional_field_5": ""
}

Note

For Uat Integretion use these Account Number and IFSC Code

Details IFSC Code Account Number
Success ICIC0002549 1234567890
Pending ICIC0004321 1112223333
Failure ICIC0001234 9876543210
Payout Response:
BODY PARAMS:

Response (Success)

Response Parameter

Sr. No Fields Description Mandatory
1 status Boolean Yes
2 message Alphanumeric Yes
3 data Object Conditional
4 data.payout_id Nevope Payout Id Conditional (Only 200 Http Status Code)
5 data.order_id Merchant Order Id Conditional (Only 200 Http Status Code)

Sample Response (200)

{
     "status": true
     "message": "Payout Request Received"
     "data": {
        "payout_id": "PAY123456"
        "order_id": PO123456
    }
}

Response (Failed) (400)

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

Payout Query :

Payout Query API Endpoint :
Method Environment Url
POST Production
https://pg.nevope.com/api/v1/payout/query
POST UAT/Staging
https://uat.nevope.com/api/v1/payout/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 Unique Transaction/Order Id Alphanumeric Yes

Payout Request Body : 

{
    "order_id": "ORD_123322323"
}

Response Parameters

Sr. No Fields Description Mandatory
1 status Boolean Yes
2 message Alphanumeric Yes
3 data Object Conditional (Only 200 Http Status Code)
4 data.payout_id Nevope Payout ID
5 data.order_id Merchant Order ID
6 data.merchant_id Merchant ID
7 data.amount Payout Amount
8 data.fees Payout Fees/Charge
9 data.status Payout Status (INITIALIZED, PENDING, SUCCESS, FAILED)
10 data.method Payout Method
11 data.customer Object
12 data.customer.name Customer/Player Name
13 data.customer.id Customer/Player ID
14 data.customer.phone Customer/Player Phone
15 data.customer.email Customer/Player Email
16 data.customer.account Customer/Player Bank Account Number
17 data.customer.ifsc Customer/Player Bank IFSC Code
18 data.additional_field_1 Additional Field
19 data.additional_field_2 Additional Field
20 data.additional_field_3 Additional Field
21 data.additional_field_4 Additional Field
22 data.additional_field_5 Additional Field
23 data.bank_response Response Message
24 data.bank_reference_no Bank UTR Number
25 data.payout_date Payout Date

Sample Response (200) :

{
  "status": true,
  "message": "Payout Details Fetched Successfully",
  "data": {
      "merchant_id": "************",
      "order_id": "**********",
      "payout_id": "**********",
      "amount": 100,
      "fees": 0,
      "status": "FAILED",
      "method": "IMPS",
      "customer": {
           "id": "*******",
           "name": "**********",
           "phone": "**********",
           "email": "demo@example.com",
           "account": "***********",
           "ifsc": "***********"
    },
      "additional_field_1": "",
      "additional_field_2": "",
      "additional_field_3": "",
      "additional_field_4": "",
      "additional_field_5": "",
      "bank_response": "",
      "bank_reference_no": "",
      "payout_date": "2023-07-19 05:30:56"
  }
}

Response (Failed) (400) :

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

Payout Wallet balance:

Payout Wallet balance API Endpoint :
Method Environment Url
GET Production
https://pg.nevope.com/api/v1/payout/balance
GET UAT/Staging
https://uat.nevope.com/api/v1/payout/balance
Header Parameter:
x-merchant-id
Provide By Nevope
x-api-key
Provide By Nevope
Content-Type
application/json

Response Parameters

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.available_balance Available Payout Wallet Balance Numeric Conditional
5 data.merchant_id Merchant ID UUID Conditional

Sample Response (200) :

{
     "status": true,
     "message": "Payout Balance Fetched Successfully",
     "data":  {
         "merchant_id": "MERCH123",
         "available_balance": 5**99.00,
    }
}

Response (Failed) (400) :

{
    "status": false,
    "message": "Error_Message",
}
  • Checksum Generation for Payout
    • Checksum Fields: payout_id : order_id : merchant_id : payout_status : payout_amount : payout_date
    Algorithm :
    $checksum = crc32("payout_id:order_id:merchant_id:payout_status:payout_amount:payout_date"); 
    
$checksumStr = $payoutId . ':' . $orderId . ':' . $merchantId . ':' . $payoutStatus . ':' . $payoutAmount . ':' . $payoutDate;
$checksum = crc32($checksumStr);
  • payout Callback/Webhook Example

    • Method: POST

    Headers: No request header

    Expected response code: 200

    Content Type: application/json

    Payout Callback/Webhook Response : 

    {
  "event_type": "PAYOUT",
  "event": "PAYOUT.SUCCESS", // PAYOUT.FAILED
  "checksum": 3899009463,
  "payload": {
      "payout_id": "PAYOUT ID",
      "order_id": "ORDER ID",
      "merchant_id": "MERCHANT ID",
      "status": "PAYOUT STATUS",
      "amount": "PAYOUT AMOUNT",
      "fees": "FEES",
      "method": "PAYOUT METHOD",
      "message": "DESCRIPTION",
      "customer": {
            "id": "CUSTOMER ID",
            "name": "CUSTOMER NAME",
            "phone": "CUSTOMER PHONE",
            "email": "CUSTOMER EMAIL"
            "bank_account": "CUSTOMER BANK ACCOUNT"
            "ifsc_code": "CUSTOMER IFSC CODE"
    },
    "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)",
  }
}

    Payout Callback URL

    Callback Response:
    
                                    
    
                                
    
                            
    


                        
    
                    
    
                
    
            
    



            
            
    
                
    
                    
    
                        
    

                            
    
                                
                                
                            
    
                            
                        
                  
    
                            
    Payout Response: