On This Page

Capture a Payment

You can capture an authorized payment by requesting a capture, which completes the payment.

You can capture the full amount in a single request or capture partial amounts in multiple capture requests.

The

PENDING

status and a new request ID indicate a successful capture. Send a follow-on check status request periodically to receive the current status of the capture. The payment is complete when the check status request responds with a

COMPLETED

status. For more information about sending a check status request, see Check Status for a Transaction.

Endpoints

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/captures

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/captures

Set the {id}
to the request ID contained in the authorization response.

Required Fields for Capturing a Payment

merchantInformation.merchantDescriptor.name
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
paymentInformation.paymentType.method.name: Set to one of these values:

payPal
: the PayPal payment method.
venmo
: the Venmo payment method.
paymentInformation.paymentType.name: Set to
eWallet
.
processingInformation.actionList: Set to
AP_CAPTURE
.
processingInformation.captureOptions.isFinal: Set to one of these values:

true
: Release the authorization hold on the remaining funds.
false
: Do not release the authorization hold on the remaining funds.
processingInformation.captureOptions.notes

Example: Capturing a Payment

Request

{
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "65"
        }
    },
    "merchantInformation": {
        "merchantDescriptor": {
            "name": "test-descriptor"
        }
    },
    "processingInformation": {
        "captureOptions": {
            "notes": "paypalV2",
            "isFinal": "true"
        },
        "actionList": [
            "AP_CAPTURE"
        ]
    },
    "paymentInformation": {
        "paymentType": {
            "method": {
                "name": "payPal"
            },
            "name": "eWallet"
        }
    }
}

Response to a Successful Request

{
    "processorInformation": {
        "transactionId": "6EM63359FN838823Y"
    },
    "message": "Successful",
    "status": "COMPLETED",
    "id": "7265097759866005201991",
    "submitTimeUtc": "2024-09-16T18:02:56Z"
}

Response Statuses for Capturing a Payment

Cybersource responds to your request with one of these statuses in the

status

response field:

INVALID_REQUEST

: The capture request was not successful. Send a new capture request.

PENDING

: The capture request was successful and is being reviewed by PayPal. Use the check status request as often as necessary until the status updates. For more information, see Check Status for a Transaction.

When you request a status update, Cybersource responds with one of these statuses in the

status

field:

COMPLETED

: The funds were successfully captured, and the payment is complete.

DECLINED

: The funds were not captured because PayPal declined the request after a review.