telvero-sales-backoffice/vendor/mollie/mollie-api-php/docs/recipes/payments/retrieve-captures.md

Retrieve Payment Captures

How to retrieve and list captures for a payment using the Mollie API.

Get a Single Capture

use Mollie\Api\Resources\Capture;
use Mollie\Api\Http\Requests\GetPaymentCaptureRequest;

try {
    // Retrieve a specific capture
    /** @var Capture $capture */
    $capture = $mollie->send(
        new GetPaymentCaptureRequest(
            paymentId: 'tr_WDqYK6vllg',
            captureId: 'cpt_4qqhO89gsT'
        )
    );

    echo "Captured {$capture->amount->currency} {$capture->amount->value}\n";
} catch (\Mollie\Api\Exceptions\ApiException $e) {
    echo "API call failed: " . htmlspecialchars($e->getMessage());
}

List All Captures

use Mollie\Api\Resources\Capture;
use Mollie\Api\Resources\LazyCollection;
use Mollie\Api\Http\Requests\GetPaginatedPaymentCapturesRequest;

try {
    // List all captures for a payment
    /** @var LazyCollection $captures */
    $captures = $mollie->send(
        (new GetPaginatedPaymentCapturesRequest(
            paymentId: 'tr_WDqYK6vllg'
        ))->useIterator()
    );

    /** @var Capture $capture */
    foreach ($captures as $capture) {
        echo "Capture {$capture->id}:\n";
        echo "- Amount: {$capture->amount->currency} {$capture->amount->value}\n";
        echo "- Status: {$capture->status}\n";
        echo "- Created: {$capture->createdAt}\n\n";
    }
} catch (\Mollie\Api\Exceptions\ApiException $e) {
    echo "API call failed: " . htmlspecialchars($e->getMessage());
}

The Response

$capture->id;                // "cpt_4qqhO89gsT"
$capture->paymentId;        // "tr_WDqYK6vllg"
$capture->amount->currency; // "EUR"
$capture->amount->value;    // "5.00"
$capture->description;      // "Order #12345"
$capture->status;          // "pending", "succeeded", "failed"
$capture->createdAt;       // "2024-02-24T12:13:14+00:00"

Additional Notes

• You can only retrieve captures for payments created with captureMode: 'manual'
• A payment can have multiple captures if partial captures were used
• The captures list is paginated, use next() to get the next page
• The capture status indicates whether the capture was successful
• The payment status will change to paid once all captures are successful
• Make sure to handle the webhook to process capture status updates