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 Body
data.transaction_amount
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.pre_settlement_fee_charge
string
PreSettlement Fee charge must be less or equal to the amount specified in the Auth call. If not provided, the preSettlementFeeCharge provided in the auth call will be considered
data.post_settlement_fee_charge
string
PostSettlement Fee charge must be less or equal to the amount specified in the Auth call. If not provided, the postSettlementFeeCharge provided in the auth call will be considered
data.metadata
object
Add any additional metadata by passing a json object
id
string
PayEngine payment ID for the sale request
Required
transaction_id
string
Unique transaction ID
Required
merchant_id
string
Merchant ID
Required
gateway_id
string
ID of the gateway through which the transaction is processed.
Optional
description
string
Transaction Description from the original auth request
Optional
internal_transaction_id
string
Internal Transaction ID provided in the original auth request
Optional
capture_response.status
string
Transaction execution status. Allowed values PASS | FAIL | PENDING_3DSAUTH
Required
capture_response.response_code
string
Required
capture_response.response_message
string
The corresponding message for the response code
Required
capture_response.auth_code
string
Authorization code received for the transaction
Optional
capture_response.host_reference_number
string
A unique reference number by the acquiring processor for each transaction
Optional
capture_response.host_response_code
string
Optional
capture_response.task_id
string
Task identification number from acquiring processor
Required
capture_response.transaction_id
string
Transaction Identifier
Optional
capture_response.transaction_timestamp
string
Transaction timestamp in merchant's timezone
Required
capture_response.transaction_amount
string
Total amount requested in this transaction
Optional
capture_response.processed_amount
string
The actual amount processed by the processor. In standard processing, processedAmount is same as transactionAmount . The differences become relevant when features like partial authorization or multi-currency are enabled.
Required
capture_response.total_amount
string
Total amount of this transaction
Optional
capture_response.masked_card_number
string
The truncated card number displaying the last four digits
Required
capture_response.fraud_score
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
capture_response.kount_score
int
Return the Kount Omniscore if Kount is enabled for the account
Optional
capture_response.customer_receipt
string
Printable customer receipt
Required
capture_response.merchant_receipt
string
Printable merchant receipt
Required
metadata
string
Return all the metadata sent in the request
Optional
Sample Request / Response
Example Request
{
"id": "4126266e-7895-46ad-ae58-92620aa2befe",
"data": {
"transaction_amount": "150.00",
"metadata": {
"customer_id": "123",
"email" : "[email protected]"
}
}
}Webhook Payload Example
{
"event_uid": "df146813e8523c1cd5afbda038486120",
"event": "PAYMENT_CAPTURED",
"data": {
"metadata": {
"email": "[email protected]",
"customer_id": "123"
},
"account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844",
"gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
"payment_id": "2a0e8a3b-7703-4d31-a8cd-c714fed4dedf",
"description": "Description of transaction",
"merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
"transaction_id": "ca8c6e03-1699-4528-bb0c-5894e87ecf47",
"capture_response": {
"status": "PASS",
"task_id": "95103204",
"auth_code": "323072",
"card_type": "visa",
"total_amount": "1.00",
"response_code": "A0000",
"transaction_id": "67868150",
"customer_receipt": " 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",
"merchant_receipt": " 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",
"processed_amount": "1.00",
"response_message": "Success",
"host_response_code": "00",
"masked_card_number": "1111",
"transaction_amount": "1.00",
"host_reference_number": "325806055923",
"transaction_timestamp": "2025-04-02T18:26:38"
},
"internal_transaction_id": "987654321"
}
}Last updated