Credit Card Capture

Credit card capture converts an authorized transaction into sale and flags it for settlement.

POST https://<PayEngine-host>/api/payment/capture

Request

Request Body

Name	Type	Description
id*	string	transactionID returned from original Auth request
data.transactionAmount	string	Max Length=12 Allowed characters: 0-9 and .(dot) Note: this value always reflects the total dollar amount for example 1.00 and 1 both will be considered $1.00 and 0.10 will be 10 cents. Transaction amount must be less or equal to the authorized amount. If not provided, the entire authorized amount is converted into sale and flag for settlement.
data.description	string	Transaction Description. Character limit is 255

200

Field Definitions

Field Name	Type	Description	Required?
ID	string	PayEngine system ID for the sale request	Required
TransactionID	String	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
description	string	Transaction Description	Optional
CaptureResponse.status	string	Transaction execution status. Allowed values PASS | FAIL | PENDING_3DSAUTH	Required
CaptureResponse.responseCode	string	The code representing the status of the processed request	Required
CaptureResponse.responseMessage	string	The corresponding message for the response code	Required
CaptureResponse.authCode	string	Authorization code received for the transaction	Optional
CaptureResponse.hostReferenceNumber	string	A unique reference number by the acquiring processor for each transaction	Optional
CaptureResponse.hostResponseCode	string	Response code indicating the status of the authorization request	Optional
CaptureResponse.taskID	string	Task identification number from acquiring processor	Required
CaptureResponse.transactionID	string	Transaction Identifier	Optional
CaptureResponse.transactionTimestamp	string	Transaction timestamp in merchant's timezone	Required
CaptureResponse.transactionAmount	string	Total amount requested in this transaction	Optional
CaptureResponse.totalAmount	string	Total amount of this transaction	Optional
CaptureResponse.addressVerificationCode	string	Address verification system response	Optional
CaptureResponse.cardHolderVerificationCode	string	CVV verification code	Optional
CaptureResponse.cardType	string	Card Type - visa, mastercard, american express, discover, dinersclub, ebt	Required
captureResponse.fraudScore	int	Return the fraud score between 0 - 100. 100 means less confidence i.e. more fraudulent i and 0 means lower chance of fraudulent. Note: The fraud monitoring has to be enabled. Please contact support to enable it	Optional
captureResponse.kountScore	int	Return the Kount Omniscore	Optional
CaptureResponse.customerReceipt	string	Printable customer receipt	Required
CaptureResponse.merchantReceipt	string	Printable merchant receipt	Required

Sample Request / Response

Request

Example Request

{
    
    "id": "54191797",
    "data": {
        "transactionAmount": "11.00",
        "description": "Payment for the services"
    }
}

Response

Example Response

{
    "data": {
        "ID": "2a0e8a3b-7703-4d31-a8cd-c714fed4dedf",
        "MerchantID": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "TransactionID": "ca8c6e03-1699-4528-bb0c-5894e87ecf47",
        "Description": "Description of transaction",
        "internalTransactionID": "987654321",
        "CaptureResponse": {
            "status": "PASS",
            "responseCode": "A0000",
            "responseMessage": "Success",
            "authCode": "323072",
            "hostResponseCode": "00",
            "hostReferenceNumber": "325806055923",
            "taskID": "95103204",
            "transactionID": "67868150",
            "transactionTimestamp": "2025-04-02T18:26:38",
            "cardType": "visa",
            "transactionAmount": "1.00",
            "processedAmount": "1.00",
            "totalAmount": "1.00",
            "customerReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:26 PM         \\n           CREDIT - SALE            \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 67868150      \\n     Description: Test Capture      \\n        SUBTOTAL: USD $1.00         \\n          TOTAL: USD $1.00          \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
            "merchantReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:26 PM         \\n           CREDIT - SALE            \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 67868150      \\n     Description: Test Capture      \\n        SUBTOTAL: USD $1.00         \\n          TOTAL: USD $1.00          \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n",
            "maskedCardNumber": "1111"
        },
        "Metadata": {
            "customerId": "123",
            "email": "[email protected]"
        }
    }
}