> For the complete documentation index, see [llms.txt](https://docs.payengine.co/merchant-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/merchant-api-reference/transactions/credit-card-capture.md).

# Credit Card Capture

<mark style="color:green;">`POST`</mark> `https://<Platform-host>/api/payment/capture`

Request

#### Request Body

| Name                                 | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                  |
| ------------------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id<mark style="color:red;">\*</mark> | string | transactionID returned from original [Auth](broken://pages/EVjuqx1B2nqjB5QVHbKI) request                                                                                                                                                                                                                                                                                                     |
| data.transactionAmount               | string | <p>Max Length=12<br>Allowed characters: 0-9 and .(dot) <br><br>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. </p><p></p><p>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. </p> |
| data.description                     | string | Transaction Description. Character limit is 255                                                                                                                                                                                                                                                                                                                                              |

{% tabs %}
{% tab title="200 " %}
{% tabs %}
{% tab title="Field Definitions" %}

<table><thead><tr><th width="248">Field Name</th><th width="108.953125">Type</th><th width="210.9478759765625">Description</th><th>Required?</th></tr></thead><tbody><tr><td>ID</td><td>string</td><td>Platform system ID for the sale request</td><td>Required</td></tr><tr><td>TransactionID</td><td>String</td><td>Unique transaction ID</td><td>Required</td></tr><tr><td>MerchantID</td><td>string</td><td>Merchant ID</td><td>Required</td></tr><tr><td>description</td><td>string</td><td>Transaction Description</td><td>Optional</td></tr><tr><td>CaptureResponse.status</td><td>string</td><td>Transaction execution status.<br>Allowed values PASS | FAIL | PENDING_3DSAUTH</td><td>Required</td></tr><tr><td>CaptureResponse.responseCode</td><td>string</td><td><a href="/pages/3NDgEDKcaGwsNSCCiyeh">The code representing the status of the processed request</a></td><td>Required</td></tr><tr><td>CaptureResponse.responseMessage</td><td>string</td><td>The corresponding message for the response code</td><td>Required</td></tr><tr><td>CaptureResponse.authCode</td><td>string</td><td>Authorization code received for the transaction</td><td>Optional</td></tr><tr><td>CaptureResponse.hostReferenceNumber</td><td>string</td><td>A unique reference number by the acquiring processor for each transaction</td><td>Optional</td></tr><tr><td>CaptureResponse.hostResponseCode</td><td>string</td><td><a href="/pages/ysDmKvm1q1EkhoaZhGLf">Response code indicating the status of the authorization request</a></td><td>Optional</td></tr><tr><td>CaptureResponse.taskID</td><td>string</td><td>Task identification number from acquiring processor</td><td>Required</td></tr><tr><td>CaptureResponse.transactionID</td><td>string</td><td>Transaction Identifier</td><td>Optional</td></tr><tr><td>CaptureResponse.transactionTimestamp</td><td>string</td><td>Transaction timestamp in merchant's timezone</td><td>Required</td></tr><tr><td>CaptureResponse.transactionAmount</td><td>string</td><td>Total amount requested in this transaction</td><td>Optional</td></tr><tr><td>CaptureResponse.totalAmount</td><td>string</td><td>Total amount of this transaction</td><td>Optional</td></tr><tr><td>CaptureResponse.addressVerificationCode</td><td>string</td><td><a href="/pages/3pHONXvvXuE6nwwMKveb">Address verification system response</a></td><td>Optional</td></tr><tr><td>CaptureResponse.cardHolderVerificationCode</td><td>string</td><td><a href="https://docs.payengine.co/payengine-api-reference/error-and-response-codes/cvv-verification-codes">CVV verification code</a></td><td>Optional</td></tr><tr><td>CaptureResponse.cardType</td><td>string</td><td>Card Type - visa, mastercard, american express, discover, dinersclub, ebt</td><td>Required</td></tr><tr><td>captureResponse.fraudScore</td><td>int</td><td>Return the fraud score between 0 - 100. 100 means less confidence i.e. more fraudulent i and 0 means lower chance of fraudulent.<br>Note: The fraud monitoring has to be enabled. Please contact support to enable it</td><td>Optional</td></tr><tr><td>captureResponse.kountScore</td><td>int</td><td>Return the Kount Omniscore</td><td>Optional</td></tr><tr><td>CaptureResponse.customerReceipt</td><td>string</td><td>Printable customer receipt</td><td>Required</td></tr><tr><td>CaptureResponse.merchantReceipt</td><td>string</td><td>Printable merchant receipt</td><td>Required</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

### Sample Request / Response

{% tabs %}
{% tab title="Request" %}

#### Example Request

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

{% endtab %}

{% tab title="Response" %}

#### Example Response

```javascript
{
    "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": "test@test.com"
        }
    }
}
```

{% endtab %}
{% endtabs %}
