Add invoice payment

Add the payment processed for any invoice

Endpoint

Method	URI
POST	https://apiv2.keliweb.it/api/v2/keliweb/add-invoice-payment

Request Parameters

Parameter	Type	Description	Required
HTTP headers: Authorization	string	Bearer + the token to access APIs	Required
invoiceid	integer		Required
transid	string	The unique transaction id that should be applied to the payment	Required
date	date	The date that the payment should have assigned. Format: YYYY-MM-DD HH:mm:ss	Optional
amount	float	The amount paid, can be left undefined to take full amount of invoice	Optional
fees	float	The amount of the payment that was taken as a fee by the gateway	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/add-invoice-payment",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'invoiceid' => '1',
                                    'transid'   => 'D28DJIDJW393JDWQKQI332',
                                    'gateway'   => 'mailin',
                                    'date'      => '2016-01-01 12:33:12'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("invoiceid", "1");
                    form.append("transid", "D28DJIDJW393JDWQKQI332");
                    form.append("gateway", "mailin");
                    form.append("date", "2016-01-01 12:33:12");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/add-invoice-payment",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                    {
                        "result": "success"
                    }