Skip to main content

Capture a Pre-Authorization

After a pre-authorization, capture the funds when you're ready to finalize the charge.

Prerequisites​

  • Understand EPOS communication
  • A completed pre-authorization with its UTI. The UTI is an alphanumeric string consisting of 1-64 characters. Special characters  are not allowed. For example, 000000000001, 000000000002, 000000000003. Each UTI must be a unique value. The UTI can be re-used only when the previous one expires, which currently happens after 3 months, though this is subject to change.
  • A valid auth token
  • Terminal IP address and serial number

Steps​

  1. Send a completion request with the pre-authorization UTI:
curl --location 'https://{IP}:{PORT}/payntpos/1.0.0/transaction?tid={TID}&disablePrinting=false' \
--header 'Content-Type: application/json' \
--header 'Authorization: {AUTH_TOKEN}' \
--data '{
    "transType": "COMPLETION",
    "reference": "capture-789",
    "uti": "c4b0a015-abea-3759-b5d1-dd82d0a7cc26",
    "amountTrans": 18000
}'
  1. The response returns a new UTI for the completion:
{
    "transType": "COMPLETION",
    "amountTrans": 18000,
    "uti": "373c4860-6bbf-34dd-9454-a9f1e23a0cc6"
}
  1. Check the transaction status using the new UTI.

Request Parameters​

FieldTypeRequiredDescription
transTypestringYesSet to COMPLETION
utistringYesUTI from the original pre-authorization. The UTI is an alphanumeric string consisting of 1-64 characters. Special characters  are not allowed. For example, 000000000001, 000000000002, 000000000003. Each UTI must be a unique value. The UTI can be re-used only when the previous one expires, which currently happens after 3 months, though this is subject to change.
amountTransintegerYesAmount to capture in cents
referencestringNoYour reference ID for tracking. The reference ID is an alphanumeric string consisting of 1-36 characters, Special characters are not allowed. Usually shown in 5 groups separated by hyphens, for example, gr3d4fae-9dec-11d0-a763-00a0c91e6bf1.

Capture Amount Rules​

ScenarioAllowedExample
Full captureYesPre-auth €200, capture €200
Partial captureYesPre-auth €200, capture €180
Over-captureNoPre-auth €200, capture €250 (will be declined)

Important Notes​

  • The capture amount can be equal to or less than the pre-authorized amount.
  • Capturing more than the pre-authorized amount will be declined.
  • Once captured, the transaction will settle at the end of the day.
  • Captured transactions cannot be voided—use a refund instead.