Capture / Ticket Request

Pre-Auth (Auth-Only) transactions allow users to hold a specific amount for processing at a later time without needing to re-enter account details. A Capture/Ticket Request is used to finalize an Auth-Only (Ticket) transaction, ensuring the held amount is processed without requiring the account data to be entered again.
Follow the steps and references outlined in this section to perform a Capture/Ticket transaction.
Capture request used to post capture an Auth only transaction without re-entering account data.

Request Body

application/json

RefId*string

Must match the RefId from the original transaction.

RegisterId*string

Alphanumeric reference field.

TPN?string

Alphanumeric TPN field.

AuthKey?string

Required if the terminal is configured to use AuthKey.

TransType*string

Identifies the type of transaction to run – Capture.

Value in"Capture"

Amount*string

Base dollar amount of the original transaction.

Tip?string

Dollar amount of tip to add. Tip must be enabled on the terminal.

MerchantId?string

Required transacting TPN when Multi MID (MMID) is enabled.

CustomerEmail?string

Pre-fills the Send Email Receipt screen.

CustomerMobile?string

Pre-fills the Text Receipt screen.

Response Body

`application/json`

curl -X GET "https://example.com/cgi.html-capture" \  -H "Content-Type: application/json" \  -d '{    "AuthKey": "",    "RegisterId": "3",    "TPN": "",    "TransType": "Capture",    "Amount": "100.00",    "Tip": "10.00",    "RefId": "2",    "MerchantId": "",    "CustomerMobile": "",    "CustomerEmail": ""  }'

{
  "RefId": "string",
  "RegisterId": "string",
  "TPN": "string",
  "ResultCode": "string",
  "Message": "string",
  "PaymentType": "string",
  "ContactDetailsError": "string"
}

Capture / Ticket Request

Request Body

Response Body

200application/json

`application/json`