Enkash Developer Portal
Home
Home
Login
  1. Payment
  • Back to home
  • Vendor Payment
  • APIs
    • Business Onboarding
      • Initiate Entity Check
      • Register Entity
      • Bharat Connect B2B ID Registration
      • Search Entity
    • Invoice
      • Create Invoice
      • Confirm Invoice
      • Change Invoice Status
      • Edit Invoice
    • Payment
      • Pay Invoice
      • Payment Confirmation
    • Purchase Order
      • Send Purchase Order Request
      • Confirm Purchase Order
      • Edit Purchase Order
      • Change Purchase Order Status
    • Credit Note
      • Send C/N Request
      • Confirm C/N Request
      • Status Change C/N Request
    • Financing
      • Request Financing
      • Share Bid
      • Respond To Bid
  • Webhook
    • Business Onboarding
      • Check Entity Webhook
      • Entity Registration Response Webhook
      • Search Entity Response Webhook
      • Registration ID Response Webhook
    • Invoice
      • Create Invoice Request Webhook
      • Create Invoice Response Webhook
      • Confirm Invoice Request Webhook
      • Confirm Invoice Response Webhook
      • Status Change Invoice Request
      • Status Change Invoice Response Webhook
      • Edit Invoice Request Webhook
      • Edit Invoice Response Webhook
    • Payment
      • Payment Response Webhook
        POST
      • Payment Confirmation Response Webhook
        POST
      • Payment Request Webhook
        POST
      • Payment Confirmation Request Webhook
        POST
    • Credit Note
      • Send C/N RequestWebhook
      • Send C/N Response Webhook
      • Confirm C/N Request Webhook
      • Confirm C/N Response Webhook
      • Status Change C/N Request Webhook
      • Status Change C/N Response Webhook
    • Purchase Order
      • Send Purchase Order Request Webhook
      • Send Purchase Order Response Webhook
      • Confirm Purchase Order Request Webhook
      • Confirm Purchase Order Response Webhook
      • Edit Purchase Order Request Webhook
      • Edit Purchase Order Response Webhook
      • Status Change Purchase Order Request Webhook
      • Status Change Purchase Order Response Webhook
    • Financing
      • Financing Response Webhook
      • Respond Bid Response Webhook
      • Share Bid Request Webhook
  1. Payment

Payment Request Webhook

POST
api/v0/payment/req-pay

Request

Body Params application/json
device
object 
required
tag
object 
required
b2bIds
object 
required
buyerB2BId
string 
required
Match pattern:
^([^\\\"]){1,100}$
supplierB2BId
string 
required
Match pattern:
^([^\\\"]){1,100}$
payment
object 
required
objectId
string 
required
Match pattern:
^[PMT]{3}[A-Za-z0-9]{32,32}$
ts
string 
required
type
enum<string> 
required
Allowed values:
ONPLATFORMOFFPLATFORM
mode
enum<string> 
required
Allowed values:
INTERNET BANKINGDEBIT CARDCREDIT CARDIMPSCASHUPIWALLETNEFTPREPAID CARDACCOUNT TRANSFERCHEQUE
utr
string 
required
Match pattern:
^([^\\\"]){1,50}$
currency
enum<string> 
required
Allowed value:
INR
paymentAmount
object 
required
invoicesPayInfos
array [object {7}] 
required
additionalInfos
array [object {2}] 
optional
name
string 
optional
value
string 
optional
Example
{
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "b2bIds": {
        "buyerB2BId": "string",
        "supplierB2BId": "string"
    },
    "payment": {
        "objectId": "string",
        "ts": "string",
        "type": "ONPLATFORM",
        "mode": "INTERNET BANKING",
        "utr": "string",
        "currency": "INR",
        "paymentAmount": {
            "netPaidAmount": 0,
            "netAdjustmentAmount": 0,
            "totalAmount": 0,
            "currency": "INR"
        },
        "invoicesPayInfos": [
            {
                "objectId": "string",
                "supplierInvoiceNumber": "string",
                "objectVersion": {
                    "currentVersion": 1,
                    "newVersion": 1
                },
                "statusTransition": {
                    "currentStatus": "CREATED",
                    "newStatus": "CREATED"
                },
                "invoiceAmount": {
                    "dueAmount": 0,
                    "totalAmount": 0,
                    "currency": "INR"
                },
                "invoicePaymentAmount": {
                    "netPaidAmount": 0,
                    "netAdjustmentAmount": 0,
                    "totalAmount": 0,
                    "currency": "INR",
                    "splits": [
                        {
                            "name": "string",
                            "value": 0,
                            "refNo": "string"
                        }
                    ]
                },
                "supplierBankAccountDetails": {
                    "maskedAccountNumber": "string",
                    "ifsc": "string",
                    "beneficiaryName": "string",
                    "businessVPA": "string"
                }
            }
        ]
    },
    "additionalInfos": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'api/v0/payment/req-pay' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "b2bIds": {
        "buyerB2BId": "string",
        "supplierB2BId": "string"
    },
    "payment": {
        "objectId": "string",
        "ts": "string",
        "type": "ONPLATFORM",
        "mode": "INTERNET BANKING",
        "utr": "string",
        "currency": "INR",
        "paymentAmount": {
            "netPaidAmount": 0,
            "netAdjustmentAmount": 0,
            "totalAmount": 0,
            "currency": "INR"
        },
        "invoicesPayInfos": [
            {
                "objectId": "string",
                "supplierInvoiceNumber": "string",
                "objectVersion": {
                    "currentVersion": 1,
                    "newVersion": 1
                },
                "statusTransition": {
                    "currentStatus": "CREATED",
                    "newStatus": "CREATED"
                },
                "invoiceAmount": {
                    "dueAmount": 0,
                    "totalAmount": 0,
                    "currency": "INR"
                },
                "invoicePaymentAmount": {
                    "netPaidAmount": 0,
                    "netAdjustmentAmount": 0,
                    "totalAmount": 0,
                    "currency": "INR",
                    "splits": [
                        {
                            "name": "string",
                            "value": 0,
                            "refNo": "string"
                        }
                    ]
                },
                "supplierBankAccountDetails": {
                    "maskedAccountNumber": "string",
                    "ifsc": "string",
                    "beneficiaryName": "string",
                    "businessVPA": "string"
                }
            }
        ]
    },
    "additionalInfos": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}'

Responses

🟢200Success
application/json
Body
response_code
integer 
required
response_message
string 
required
payload
object (PaymentResponse) 
required
resp
object 
required
b2bIds
object 
required
payment
object 
required
additionalInfos
array [object {2}] 
required
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "resp": {
            "reqMsgId": "string",
            "result": "string",
            "errorCd": "string",
            "errorDtl": "string",
            "errorField": "string"
        },
        "b2bIds": {
            "buyerB2BId": "string",
            "supplierB2BId": "string"
        },
        "payment": {
            "objectId": "string",
            "ts": "string",
            "type": "string",
            "mode": "string",
            "utr": "string",
            "currency": "string",
            "paymentAmount": {
                "netPaidAmount": 0,
                "netAdjustmentAmount": 0,
                "totalAmount": 0,
                "currency": "string"
            },
            "invoicesPayInfos": [
                {
                    "objectId": "string",
                    "supplierInvoiceNumber": "string",
                    "objectVersion": {
                        "currentVersion": 0,
                        "newVersion": 0
                    },
                    "statusTransition": {
                        "currentStatus": "string",
                        "newStatus": "string"
                    },
                    "invoiceAmount": {
                        "dueAmount": 0,
                        "totalAmount": 0,
                        "currency": "string"
                    },
                    "invoicePaymentAmount": {
                        "netPaidAmount": 0,
                        "netAdjustmentAmount": 0,
                        "totalAmount": 0,
                        "currency": "string",
                        "splits": [
                            {
                                "name": "string",
                                "value": 0,
                                "refNo": "string"
                            }
                        ]
                    },
                    "supplierBankAccountDetails": {
                        "maskedAccountNumber": "string",
                        "ifsc": "string",
                        "beneficiaryName": "string",
                        "businessVPA": "string"
                    }
                }
            ]
        },
        "additionalInfos": [
            {
                "name": "string",
                "value": "string"
            }
        ]
    }
}
Modified at 2025-07-06 06:23:32
Previous
Payment Confirmation Response Webhook
Next
Payment Confirmation Request Webhook
Built with