Executing an Order Without Payment

Description

Executes the pending actions against the specified Invoice Ids. You can also specify whether the Invoices need to be cancelled or kept pending.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
invoice-ids Array Of Integer Required Invoice Ids
cancel-invoice Boolean Required

Indicates whether the Invoice for the product needs to be cancelled or kept pending. Values can either be:

  • true - will cancel the Invoice and execute the action (to be used in cases where payment has been received through offline methods), or

  • false - will keep the Invoice pending and execute the action (for settlement upon receipt of payment at a later stage).

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/billing/execute-order-without-payment.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&cancel-invoice=true

Response

Returns a map of the executed action details.