- 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
- Accounts Receivable Overview
- Get Authentication Token Copy
- Customer Management
- Customer Contacts Management
- Invoice Management
- Payment Reminders
- Bharat Connect 2.0 AR
- Expense Management
- Rewards & Incentives
- Verification Suite
Dispatch Invoice Collection
POST
/api/v0/invoice/bulk/dispatch
invoice-controller
Request
Body Params application/json
invoiceIds
array[string]
optional
partialPaymentAllowed
booleanĀ
optional
Example
{
"invoiceIds": [
"string"
],
"partialPaymentAllowed": true
}
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 'https://test.your-api-server.com/api/v0/invoice/bulk/dispatch' \
--header 'Content-Type: application/json' \
--data-raw '{
"invoiceIds": [
"string"
],
"partialPaymentAllowed": true
}'
Responses
š¢200OK
application/json
Body
errorResponse
objectĀ (ErrorResponse)Ā
optional
apiSubErrors
array[objectĀ (ApiSubError)]Ā
optional
errorMessage
stringĀ
optional
errorType
enum<string>Ā
optional
Allowed values:
CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR
requestId
stringĀ
optional
timestamp
stringĀ
optional
Example:
yyyy-MM-dd HH:mm:ss
payload
objectĀ (ErrorResponse)Ā
optional
response_code
integerĀ <int32>
optional
response_message
stringĀ
optional
Example
{
"errorResponse": {
"apiSubErrors": [
{}
],
"errorMessage": "string",
"errorType": "CLIENT_REQUEST_ABORT",
"requestId": "string",
"timestamp": "yyyy-MM-dd HH:mm:ss"
},
"payload": {
"apiSubErrors": [
{}
],
"errorMessage": "string",
"errorType": "CLIENT_REQUEST_ABORT",
"requestId": "string",
"timestamp": "yyyy-MM-dd HH:mm:ss"
},
"response_code": 0,
"response_message": "string"
}
š 400Bad Request
š 401Unauthorized
š 403Forbidden
š 404Not Found
š 422Unprocessable Request
š“500Server Error