Clear Accumulator

API: Ws_ResetAccumulator

This web service allows you to reset transaction and amount counters (since the last strongly-cardholder-authenticated transaction) on a card or payment-token, Resetting transaction and amount counters re-enables transactions which are blocked as a result of the transaction and amount counters exceeding the defined maximum limits for not-secure-enough transactions.

A successful call sets the transaction count (<TxnCount>) and accumulator value (<AccumValue>) for contactless transactions to zero. If the <accumulator type> tag is invalid, the web service is declined and an action code of 425 ( Invalid Accumulator Type) is returned.

Record Description

Tag	Type	Minimum Length	Maximum Length	Description	Request	Response
<WSID>	N	1	19	Web service ID. Must be unique for every request. For details, see the FAQs.	Mandatory	Mandatory
<IssCode>	AN	1	4	Thredd Issuer (Program Manager) Code. Assigned by Thredd.	Mandatory	Mandatory
<AuthType>	AN	1	1	Parameter to specify how the card is authenticated. See Authentication Methods.	Mandatory	Omit
<PAN>	AN	14	19	Card Number. Unique card identifier. Mandatory in request if `<PublicToken>` is not present.	Conditional	Omit
<PublicToken>	AN	1	9	The card’s public token. Mandatory in request if `<PAN>` is not present. Mandatory in the response.	Conditional	Mandatory
<DOB>	YYYY-MM- DD	10	10	Date of Birth. Mandatory if value of `<AuthType>` is ‘2’ or ‘6’.	Conditional	Omit
<CVV>	AN	3	3	Card Verification Value The Card Verification Value (CVV) on a credit card or debit card is a 3 digit number on VISA, MasterCard and Discover branded credit and debit cards. Cardholder's are typically required to enter the CVV during any online or cardholder not present transactions. CVV numbers are also known as CSC numbers (Card Security Code), as well as CVV2 numbers, which are the same as CVV numbers, except that they have been generated by a 2nd generation process that makes them harder to guess., the 3-digit code printed on the back of the card. Mandatory if the value of `<AuthType>` is ‘3’.	Conditional	Omit
<AccCode>	AN	0	6	Access code or passcode. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required. Mandatory if the value of `<AuthType>` is ‘4’.	Conditional	Omit
<LastName>	AN	1	20	Cardholder's last name for authenticating the cardholder if the value of `<AuthType>` is ‘6’.	Conditional	Omit
<AccumulatorType>	N	1	1	The type of accumulator to be cleared. See Accumulator Type.	Mandatory	Omit
<DPAN>	AN	0	19	Optional DPAN value for the MDES The MasterCard Digital Enablement Service (MDES) helps transform any connected device into a commerce device to make and receive payments. The MDES platform is used in iPhone 6, iPhone 6 Plus and Apple Watch to enable secure payments to take place for contactless and in-app payments. card. If provided, clears the accumulator for the supplied DPAN.	Optional	Omit
<PaymentTokenId>	AN	0	16	Optional payment token ID for the MDES card. If provided, clears the accumulator for the supplied payment token ID.	Optional	Omit
<ClearAllDPANs>	AN	0	1	Whether to clear all accumulators: 0 or empty string = No; 1 = Yes.	Optional	Omit
<ActionCode>	AN	3	3	The action code for the response. See Action Codes.	Omit	Mandatory
<WebServiceResult>	AN			Parameter group describing the result of the Web Service call. Only has values if the current request returns an action code of 868 Duplicate WSID. See WebServiceResult.	Omit	Mandatory

Accumulator Type

The <AccumulatorType> defines which transation counter or accumulator is being reset, as follows:

Type	Used for	Standard upper limits *	Automatically reset when
1	Contactless non strongly-authenticated transactions.	5 transactions Or EUR 150.00 accumulated amount (whichever reached first). (Note the single item limit is EUR 50.00, but that does not affect counters/accumulators.)	A card-present Strongly Authenticated Transactions occurs
2	e-commerce non strongly-authenticated transactions	5 transactions Or EUR 100.00 accumulated amount (whichever reached first). (Note the single item limit is EUR 30.00, but that does not affect counters/accumulators.)	A 3D-secure e-commerce transaction occurs
3	Maximum Acquirer TRA exemption limit value	Maximum Acquirer Transaction Risk Analysis (TRA) exemption limit value	A Strongly Authenticated Transaction occurs
4	Maximum Acquirer Low-Value exemption limit value	Maximum Acquirer Low-Value exemption limit value	A Strongly Authenticated Transaction occurs

*This is defined by the European Banking Authority in under PSD2 PSD2 is an EU Directive which sets requirements for firms that provide payment services. It introduces a number of requirements around how firms treat their customers and handle their complaints, and the data they must report to the FCA. rules for countries in its jurisdiction. You may have chosen alternative limits, especially if your card product is not euro currency. For more information on PSD2 configuration, see the PSD2 and SCA Guide.

Strongly Authenticated Transaction

A strongly-cardholder-authenticated transaction has at least two of the following characteristics:

A physical property of the cardholder (such as fingerprint, Iris scan, vein scan) is verified
Cardholder uses something only they should possess to verify the transaction (e.g. chip card, payment-token device or number generating key-fob)
Cardholder provides data only they should know to verify the transaction (e.g. PIN, passcode or pattern to unlock a payment-token such as smartphone, or secret 3D-secure data)

In practice, a “strongly-cardholder-authenticated” transaction normally means that...

For card present transactions:
- Chip has been used (contact or contactless)
- Cardholder verified by online PIN or offline PIN

For payment token transactions (e.g. Apple Pay on a smartphone):
- Cardholder used Contactless
- Cardholder verified by either:
  - online PIN
  - secret information or biometric to unlock the smartphone (e.g. passcode/pattern/fingerprint)

For e-commerce transactions, 3D-secure cardholder authentication occurred.

Request

Copy

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:hyp="http://www.globalprocessing.ae/HyperionWeb">
  <soapenv:Header>
    <hyp:AuthSoapHeader>
      <hyp:strUserName>******</hyp:strUserName>
      <hyp:strPassword>******</hyp:strPassword>
    </hyp:AuthSoapHeader>
  </soapenv:Header>
  <soapenv:Body>
    <hyp:Ws_ResetAccumulator>
      <hyp:WSID>7243844685484652544</hyp:WSID>
      <hyp:IssCode>PMT</hyp:IssCode>
      <hyp:AuthType>1</hyp:AuthType>
      <hyp:PAN>9999999999999999</hyp:PAN>
      <hyp:PublicToken></hyp:PublicToken>
      <hyp:DOB></hyp:DOB>
      <hyp:CVV></hyp:CVV>
      <hyp:AccCode></hyp:AccCode>
      <hyp:LastName></hyp:LastName>
      <hyp:AccumulatorType>1</hyp:AccumulatorType>
      <hyp:DPAN></hyp:DPAN>
      <hyp:PaymentTokenId></hyp:PaymentTokenId>
      <hyp:ClearAllDPANs>1</hyp:ClearAllDPANs>
    </hyp:Ws_ResetAccumulator>
  </soapenv:Body>
</soapenv:Envelope>

Response

Copy

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Ws_ResetAccumulatorResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
      <Ws_ResetAccumulatorResponse>
        <Ws_ResetAccumulatorResult>
          <WSID>7243844685484652544</WSID>
          <IssCode>PMT</IssCode>
          <PublicToken>888888888</PublicToken>
          <ActionCode>000</ActionCode>
          <WebServiceResult/> 
        </Ws_ResetAccumulatorResult> 
    </Ws_ResetAccumulatorResponse>
  </soap:Body>
</soap:Envelope>