API Reference

Capture Transaction

In this section you will learn how to process a Capture transaction

Suggest Edits

Capture Overview

Following a PreAuthorization or Topup, a Capture transaction requests settlement of the transaction (capture the final transaction amount).

985

How to process a TokenSettlementRequest message

The merchant's system sends a TokenSettlementRequest request to ANYpay POS that contains the tokenized card number returned in the response to the original pre-authorization request, the original transaction reference for the PreAuthorization in the PreAuthTransactionReference field to link the Capture to the original PreAuthorization and the merchant's own unique transaction reference is required for the Capture.

Section TokenSettlementRequest Element describes the elements required to build an TokenSettlementRequest message.

❗️

Reversals following a Capture

A transaction cannot be reversed after aTokenSettlementRequest message has been processed

An example of a TokenSettlementRequest message can be seen below.

<?xml version="1.0" encoding="utf-16" standalone="yes"?>
<TokenSettlementRequest xmlns="http://servebase.com/2009/06/pedframework">
  <TransactionConfig>
    <CustomerCode>PXP</CustomerCode>
    <Site>PXP000000001</Site>
    <Culture>en</Culture>
    <Workstation>001</Workstation>
    <MerchantId>2100112262</MerchantId>
    <Username>PxpUser1</Username>
    <Password>PxpPassword</Password>
    <IpAddress>127.0.0.1</IpAddress>
  </TransactionConfig>
  <SettlementAmount currency="GBP">12.00</SettlementAmount>
  <TokenisedCardNumber>9999338965961111</TokenisedCardNumber>
  <TransactionReference>Capture</TransactionReference>
  <PreAuthTransactionReference>PreAuthorization</PreAuthTransactionReference>
</TokenSettlementRequest >

Handling an IccTransactionResponse message

Section IccTransactionResponse Element describes the elements that are returned in an IccTransactionResponse message. An example of an IccTransactionResponse message for a TokenSettlementRequest can be seen below.

<?xml version="1.0" encoding="utf-16"?>
<IccTransactionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://servebase.com/2009/06/pedframework">
  <Language>en</Language>
  <ResponseCode>Approved</ResponseCode>
  <FaultResponseCode>0</FaultResponseCode>
  <ResponseMessage>Transaction Approved</ResponseMessage>
  <ReceiptInfo xsi:type="IccReceiptInfo">
    <CardNumber>541333******0185</CardNumber>
    <ExpiryDate year="49" month="12" />
    <StartDate year="96" month="12" />
    <TransactionAmount currency="GBP">25.00</TransactionAmount>
    <TransactionReference>Capture</TransactionReference>
    <PreAuthTransactionReference>PreAuthorization</PreAuthTransactionReference>
    <MerchantId>2100112262</MerchantId>
    <TerminalId>210011226201</TerminalId>
    <CardScheme code="MSC" creditDebitIndicator="CREDIT">Mastercard</CardScheme>
    <CaptureMethod>Icc</CaptureMethod>
    <Dcc xsi:nil="true" />
    <BelowSignatureLimit>false</BelowSignatureLimit>
    <BalanceOnCard xsi:nil="true" />
    <AuthorizedTransactionAmount currency="GBP">25.00</AuthorizedTransactionAmount>
    <ApplicationId>A0000000041010</ApplicationId>
    <ApplicationLabel>MasterCard</ApplicationLabel>
    <PreferredName>Mastercard</PreferredName>
    <PanSequenceNumber>00</PanSequenceNumber>
    <CvmResults>410302</CvmResults>
    <TransactionDateTime>2018-02-14T17:07:24.4022694+00:00</TransactionDateTime>
    <TransactionType>Sale</TransactionType>
    <AuthorisationResponseCode />
    <IccAccreditationInfo>
      <AuthorisationRequestCryptogram>742ECE8DA5FB871C</AuthorisationRequestCryptogram>
      <ApplicationInterchangeProfile>5800</ApplicationInterchangeProfile>
      <ApplicationTransactionCounter>0003</ApplicationTransactionCounter>
      <UnpredictableNumber>B144EA01</UnpredictableNumber>
      <TerminalVerificationResult>420000E000</TerminalVerificationResult>
      <CryptogramTransactionType>00</CryptogramTransactionType>
      <CryptogramInformationData>80</CryptogramInformationData>
      <ApplicationResponseCryptogram>5800</ApplicationResponseCryptogram>
      <POSEntryMode1>3</POSEntryMode1>
      <POSEntryMode2>2</POSEntryMode2>
      <ApplicationUsageControl>FF00</ApplicationUsageControl>
      <ApplicationVersionNumber>0002</ApplicationVersionNumber>
      <TerminalApplicationVersionNumber>0002</TerminalApplicationVersionNumber>
      <TransactionStatusInformation>E800</TransactionStatusInformation>
      <TerminalType>22</TerminalType>
      <TerminalCapabilities>E0F8C8</TerminalCapabilities>
      <IssuerActionCodesOnline>F0E064F800</IssuerActionCodesOnline>
      <IssuerActionCodesDenial>0010880000</IssuerActionCodesDenial>
      <IssuerActionCodesDefault>F040642000</IssuerActionCodesDefault>
      <IssuerApplicationData>020000000000</IssuerApplicationData>
      <TerminalCountryCode>0826</TerminalCountryCode>
      <TerminalCurrencyNumber>0826</TerminalCurrencyNumber>
    </IccAccreditationInfo>
  </ReceiptInfo>
  <Token>9ee7648f-fe1d-4b89-8ad0-c372e6f86f67</Token>
  <TokenisedCardNumber>9946000000000150185</TokenisedCardNumber>
  <AuthorityCode>032725</AuthorityCode>
  <AuthorityMethod>Online</AuthorityMethod>
  <TfsEligible>false</TfsEligible>
</IccTransactionResponse>

Updated about 6 years ago