Skip to content

capturepayment.md

Latest commit

 

History

History
82 lines (60 loc) · 1.72 KB

capturepayment.md

File metadata and controls

82 lines (60 loc) · 1.72 KB

+++ title = "CapturePayment" toc = true +++

Attempt to capture a payment on an unpaid CC Invoice

Request Parameters

Parameter Type Description Required
action string "CapturePayment" Required
invoiceid int The ID of the pending order Required
cvv string The CVV Number for the card being attempted Optional

Response Parameters

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

Example Request (CURL)

$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' => 'CapturePayment',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'invoiceid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

$command = 'CapturePayment';
$postData = array(
    'invoiceid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response JSON

{
    "result": "success"
}

Error Responses

Possible error condition responses include:

  • Invoice Not Found or Not Unpaid
  • Payment Attempt Failed

Version History

Version Changelog
1.0 Initial Version