Description
Allows to pay Customer's Invoices and / or Debit Notes specified. At least one of the parameters (Invoice Id or Debit Note Id) needs to be provided. The Invoices and Debit Notes would be settled only if the Customer has sufficient funds.
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/customer-pay.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&debit-ids=0&debit-ids=1
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| invoice-ids | Array Of Integer | Required | Invoice Ids that are to be settled |
| debit-ids | Array Of Integer | Required | Debit Note Ids that are to be settled |
Response
Returns a hash map of the specified Transactions (Invoices and / or Debit Notes) containing the below details:
-
Invoice Id (invoiceid)
-
Action Type (actiontype)
-
Description of the Action (actiontypedesc)
-
Action Id of the Action (eaqid)
-
Customer Id associated with the Transaction (customerid)
-
Action Status (actionstatus)
-
Description of the Action Status (actionstatusdesc)
-
Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.