Get transactions

Get all transactions matching the following parameters


Endpoint


Method URI
POST https://apiv2.keliweb.it/api/v2/keliweb/get-transactions

Request Parameters


Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Required
invoiceid integer Obtain transactions for a specific invoice id Optional
transid string Find transactions for a specific transaction id Optional

Response Parameters


Parameter Type Description
result string The result of the operation: success or error
totalresults integer The total number of results available
startnumber integer The starting number for the returned results
numreturned integer The number of results returned
transactions array An array of transactions matching the criteria passed

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-transactions",
                      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(
                                    'clientid' => '1'
                                )
                            ),
                      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("clientid", "1");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-transactions",
                        "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",
                    "totalresults": 1,
                    "startnumber" : 0,
                    "numreturned" : 1,
                    "transactions": {
                        "transaction": [
                            {
                                "id"         : "10",
                                "userid"     : "1",
                                "currency"   : "0",
                                "gateway"    : "paypal",
                                "date"       : "2016-01-01 06:41:11",
                                "description": "Invoice Payment",
                                "amountin"   : "45.90",
                                "fees"       : "0.00",
                                "amountout"  : "0.00",
                                "rate"       : "1.00000",
                                "transid"    : "1479732071aad259f3513ec",
                                "invoiceid"  : "59",
                                "refundid"   : "0"
                            }
                        ]
                    }
                }