Description
Adds funds in a Customer's Account.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
customer-id | Integer | Required | Customer Id of the Customer in whose Debit Account these funds are to be added |
amount | Float | Required | Amount to be added |
description | String | Required | Description for the Transaction |
transaction-type | Array of Strings | Required | Type of the Transaction. Possible values can be credit or receipt. |
transaction-key | String | Required | A unique Transaction key |
update-total-receipt | Boolean | Required | Possible values are true or false. Pass true if the amount needs to be added to the Total Receipts figure of the Customer. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/add-customer-fund.json?auth-userid=0&api-key=key&customer-id=0&amount=0&description=description-text&transaction-type=credit&transaction-key=transaction-key-text&update-total-receipt=true
Response
Returns a Transaction Id (Integer) if funds are added successfully in the specified Customer's Account.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.