Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Bharat Connect (BBPS)
  2. B2B Invoicing
  3. webhook-payments
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
        POST
    • Orders
      • About Order
      • Create Order
        POST
      • Get Order Status
        GET
      • Get BNPL Payment Modes
        GET
      • Get Dynamic QR Code
        GET
      • UPI Intent Links
        GET
    • Payments
      • About Payment
      • Submit Payment Detail
        POST
      • Get Transaction Status
        GET
      • Validate OTP
        POST
      • Resend OTP
        GET
      • Payment Notify Request
        POST
    • Refunds
      • About Refund
      • Refund
        POST
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
        GET
      • Search Settlement Payouts
        POST
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
        POST
      • Update Split Settlement Account
        POST
      • Get All Split Settlement Account
        GET
      • Deactivate Split Settlement Account
        PATCH
      • Activate Split Settlement Account
        PATCH
      • Submit Payment with Split Details
        POST
      • Edit/Deferred Split Settlement
        POST
    • E-Commerce Plugins
    • Payment Links
    • Payment Button
    • Qr Code
      • Create Qr Code
        POST
      • Get QR Code
        GET
      • Search QR Code
        POST
      • createCustomer
        POST
      • searchCustomer
        POST
      • Cancel QR Code
        PATCH
    • UPI Mandate
      • Create UPI Mandate
        POST
      • Update UPI Mandate
        PATCH
      • Revoke UPI Mandate
        PATCH
      • Get UPI Mandate
        GET
      • UPI mandate create callback
        POST
      • Mandate Pre-debit Notification
        POST
      • Execute mandate debit
        POST
      • Mandate Debit callback
        POST
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
        POST
      • Get Payment Link Details
        GET
      • Delete Payment Link
        DELETE
    • Payment Link Webhook
      • Payment Link Webhook Request
        POST
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
          POST
        • Confirm Invoice
          POST
        • Status Change Invoice
          POST
        • Edit Invoice
          POST
      • Payment
        • Pay Invoices
          POST
        • Payment Confirmation
          POST
      • Financing
        • Request Financing
          POST
        • Share Bid
          POST
        • Respond Bid
          POST
      • Onboarding
        • Register Check Entity
          POST
        • Search Entity
          POST
        • Register Entity
          POST
        • Registration Id
          POST
      • cdNote
        • Send CdNote Request
          POST
        • Confirm CdNote Request
          POST
        • Status Change CdNote Request
          POST
      • Purchase Order
        • Send Purchase Order Request
          POST
        • Confirm Purchase Order Request
          POST
        • Edit Purchase Order Request
          POST
        • Status Change Purchase Order Request
          POST
      • webhook-invoice
        • Webhook Create Invoice Request
          POST
        • Webhook Create Invoice Response
          POST
        • Webhook Confirm Invoice Request
          POST
        • Webhook Confirm Invoice Response
          POST
        • Webhook Status Change Invoice Request
          POST
        • Webhook Status Change Invoice Response
          POST
        • Webhook Edit Invoice Request
          POST
        • Webhook Edit Invoice Response
          POST
      • webhook-payments
        • Webhook Payment Request
          POST
        • Webhook Payment Confirmation Request
          POST
        • Webhook Payment Response
          POST
        • Webhook Payment Confirmation Response
          POST
      • webhook-business-onboarding
        • Webhook Check Entity Response
          POST
        • Webhook Register Entity Response
          POST
        • Webhook Search Entity Response
          POST
        • Webhook Registration Id Response
          POST
      • webhook-financing
        • Webhook Financing Response
          POST
        • Webhook Respond Bid Response
          POST
        • Webhook Share Bid Request
          POST
      • webhook-cdNote
        • Webhook Send CdNote Request
          POST
        • Webhook Send CdNote Response
          POST
        • Webhook Confirm CdNote Request
          POST
        • Webhook Confirm CdNote Response
          POST
        • Webhook Status Change CdNote Request
          POST
        • Webhook Status Change CdNote Response
          POST
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
          POST
        • Webhook Send Purchase Order Response
          POST
        • Webhook Confirm Purchase Order Request
          POST
        • Webhook Confirm Purchase Order Response
          POST
        • Webhook Edit Purchase Order Request
          POST
        • Webhook Edit Purchase Order Response
          POST
        • Webhook Status Change Purchase Order Request
          POST
        • Webhook Status Change Purchase Order Response
          POST
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
        POST
      • Get BillerTypes
        GET
      • Get Billers
        GET
      • Fetch Bill
        POST
      • Create Bill API
        POST
      • Create Bill Without Bill Fetch
        POST
      • Bill Payment
        POST
      • Utility Bill Approval API
        PUT
      • Get Utility Bill Status
        GET
      • Get Utility Bill by Reference Id
        GET
      • Get Utility Bills Detail
        POST
      • Bill Payment Webhook
        POST
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payout API Response Codes
    • Payouts Integration Steps
    • Encrypting and Decrypting Payload
    • Payouts Status Codes
    • Get Authentication Token
      • Get Authentication Token
        POST
    • Beneficiary Apis
      • Create Beneficiary
        POST
      • Search Beneficiary
        POST
      • Delete Beneficiary
        DELETE
    • Transfer Apis
      • Create Payout
        POST
      • Search Payouts
        POST
      • Create Batch Payout
        POST
    • Payout Account Apis
      • Get Balance
        GET
      • Get Source Bank Account Details
        GET
      • Add Source Bank Account
        POST
    • Webhook Data Apis
      • Get Webhook Data
        GET
      • Create Webhook Data
        POST
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
        POST
      • Create Bulk Vendors
        POST
      • Update Bulk Vendors
        PUT
      • Get Beneficiaries (V1)
        POST
      • Get Beneficiaries
        POST
      • Change Vendor Status
        PATCH
      • Get Beneficiary
        GET
    • Invoice Management
      • Payout Apis
        • validateInvoices
          POST
        • initiate
          POST
        • Search Payouts V1
          POST
        • bulkCreatePayout
          POST
        • Create Payout
          POST
        • Update Payouts
          PATCH
        • Search Payouts
          POST
        • createBulkPayoutForPartnerIntegration
          POST
        • Update Bulk Payouts
          PATCH
        • Update Approval Status
          PATCH
        • Get Invoice Data
          GET
        • Delete Payout
          DELETE
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
        POST
      • Payment Request
        POST
    • Update Beneficiary
      PUT
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
        POST
    • Customer Management
      • Customer Apis
        • Activate customer
          PUT
        • createBulkCustomer
          POST
        • bulkUpdate
          POST
        • Deactivate customer
          PUT
        • deleteCustomerByCustomerId
          DELETE
        • updateCustomer
          PATCH
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
          GET
    • Invoice Management
      • invoice-controller
        • createInvoice
          POST
        • invoiceBulkUpload
          POST
        • Dispatch Invoice Collection
          POST
        • Delete Invoice Collection
          POST
        • searchCollectionInvoices
          POST
        • getInvoice
          GET
        • updateInvoice
          PATCH
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
          POST
        • getCustomerReminders
          POST
        • getCustomerReminder
          GET
        • deleteReminder
          DELETE
        • updateCustomerReminder
          PATCH
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
        POST
      • Change Invoice Status Request
        POST
      • Bulk Create Invoice
        POST
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
        POST
    • Expenses
      POST
    • Advance
      POST
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
          POST
        • SSO LOGIN (Single Sign On)
          POST
      • Create And Allocate point
        POST
      • Bulk Create And Allocate Points
        POST
      • Get Card Account Details
        POST
      • Get Transaction details
        POST
      • List Users Details
        POST
      • Get User Card Details
        POST
    • Channel Incentives
      • Incentive Create And Allocate point
        POST
      • Reward Get Transaction details
        POST
      • Incentive Get User Details
        POST
    • Points Redemption
      • User Authentication
        POST
      • Get Cart for User
        GET
      • Search Catalog
        POST
      • Get Product Catalog Details
        GET
      • Get Product Configs (Denominations)
        GET
      • Add to cart
        POST
      • Update Cart
        PATCH
      • Create Order
        POST
      • Order Search
        POST
      • create order
        POST
      • Fetch Order Info by Partner order Reference id
        POST
    • Point Management APIs
      • Overview
      • Create Event
        POST
      • Get Event
        GET
      • Update Event
        PATCH
      • Allocate Coins
        POST
      • Get Balance
        GET
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
        POST
    • Gift Card
      • Create
        POST
      • Request Physical
        POST
      • Block
        POST
      • Replace
        POST
      • Get User Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Meal Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Prepaid Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Fuel_cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Advance Card Feature
      • Create Card Account
        POST
      • Set Pin
        POST
      • Get Card Account Details
        POST
      • Generate Otp Card
        POST
      • View Card
        POST
      • Update Card Velocity Rules
        POST
      • Get Card Velocity Rules
        POST
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
        POST
    • GSTN Verification
      • Gstin Verification
        GET
    • PAN Verification
      • Pan Verification
        GET
    • UPI(VPA) Verification
      • Vpa Verification
        POST
  1. Bharat Connect (BBPS)
  2. B2B Invoicing
  3. webhook-payments

Webhook Payment Request

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 ''

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 2024-10-10 08:29:16
Previous
Webhook Edit Invoice Response
Next
Webhook Payment Confirmation Request
Built with