- Explore Our Product Suite
- Payment Gateway
- Payouts
- Prepaid Cards
- About Prepaid Card
- Key Capabilities
- Getting Started
- APIs
- API Access & Authorization
- Encryption & Decryption Guide
- Auth Token
- Create Card Account
- Create Gift Card
- Create Prepaid Card
- Set Card PIN
- Load Card Balance
- Get Card Account Details
- Generate Card OTP
- View Card Details
- Card Usage Controls
- Get Card Usage Limits
- Request Card Replacement
- Block Card
- Order Physical Card
- Get Card Details
- Get Transaction Details
- Get All Transaction details
- Bharat Connect (BBPS)
- About Bharat Connect
- Invoice Payments
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook 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
- Bill Payments
- Accounts Payable
- Account Receivable
- Expense Management
- Rewards & Incentives
- Verification Suite
Pay Invoices
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
payload
stringÂ
required
response_code
integerÂ
required
response_message
stringÂ
required
Example
{
"payload": "string",
"response_code": 0,
"response_message": "string"
}