Adds payment to a given invoice.
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "AddInvoicePayment" | Required |
| invoiceid | int | Required | |
| transid | string | The unique transaction ID that should be applied to the payment. | Required |
| gateway | string | The gateway used, in system name format (for example, paypal or authorize). | Required |
| date | string | The date that the payment should have assigned. Format: YYYY-MM-DD HH:mm:ss | Required |
| amount | float | The amount paid. You can leave this undefined to take the full amount of the invoice. | Optional |
| fees | float | The amount of the payment that was taken as a fee by the gateway. | Optional |
| noemail | bool | Set this to true to prevent sending an email for the invoice payment. | Optional |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
'action' => 'AddInvoicePayment',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'invoiceid' => '1',
'transid' => 'D28DJIDJW393JDWQKQI332',
'gateway' => 'mailin',
'date' => '2016-01-01 12:33:12',
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);$command = 'AddInvoicePayment';
$postData = array(
'invoiceid' => '1',
'transid' => 'D28DJIDJW393JDWQKQI332',
'gateway' => 'mailin',
'date' => '2016-01-01 12:33:12',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"result": "success"
}Possible error condition responses include:
- Invoice ID Not Found
- It is not possible to add a payment to an invoice that is Cancelled
| Version | Changelog |
|---|---|
| 1.0 | Initial Version |