Skip to main content

Dispatch Invoice

POST https://pgbiz.omniware.in/v1/dispatchinvoice
Content-Type: application/x-www-form-urlencoded

Dispatch transitions a created invoice to dispatched and emails the PDF + payment link to the customer. A cancelled invoice cannot be dispatched.

Request parameters​

api_keystring (40)required
invoice_nointegerrequired
hashstring (255)required

Response​

{
  "data": {
    "message": "Invoice dispatched successfully",
    "invoice_status": "dispatched"
  }
}

Errors:

{ "error": { "code": "GEN-INVALID-HASH", "message": "The hash key field is invalid" } }
{ "error": { "code": "GEN-INVOICE-ERROR", "message": "Invoice with cancelled status cannot be dispatched" } }