# API: Add payment
# addInvoicePayment
Submit new payment (transaction) to invoice
# Required parameters
| Parameter | Description |
|---|---|
id | Invoice ID |
amount | Transaction amount |
paymentmodule | ID of related payment gateway |
fee | Fees applied to payment (0 for no fees) |
date | Transaction date |
# Optional parameters
| Parameter | Description |
|---|---|
transnumber | Transaction number |
currency_id | Currency ID |
rate | Currency rate |
send_email | Set to 1 to notify customer about transaction |
# Request
GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addInvoicePayment&id=ID&amount=AMOUNT&paymentmodule=PAYMENTMODULE&fee=FEE&date=DATE
# PHP Samples
$url = 'http://url_to_hb.com/admin/api.php';
$post = [
'call' => 'addInvoicePayment',
'api_id' => $API_ID,
'api_key' => $API_KEY,
'id' => $ID,
'amount' => $AMOUNT,
'paymentmodule' => $PAYMENTMODULE,
'fee' => $FEE,
'date' => $DATE,
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$data = curl_exec($ch);
curl_close($ch);
$return = json_decode($data, true);
print_r($return);
include 'class.hbwrapper.php';
HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
$params = [
'id' => $ID,
'amount' => $AMOUNT,
'paymentmodule' => $PAYMENTMODULE,
'fee' => $FEE,
'date' => $DATE,
];
$return = HBWrapper::singleton()->addInvoicePayment($params);
print_r($return);
/* Use this method to access HostBill api from HostBill modules */
$api = new ApiWrapper();
$params = [
'id' => $ID,
'amount' => $AMOUNT,
'paymentmodule' => $PAYMENTMODULE,
'fee' => $FEE,
'date' => $DATE,
];
$return = $api->addInvoicePayment($params);
print_r($return);
# Response
{
"success": true,
"call": "addInvoicePayment",
"server_time": 1323787706,
"info": [
"Transaction has been added to invoice"
]
}