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}$

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Payment Confirmation Response Webhook

Payment Confirmation Request Webhook