Clear Accumulator
The Clear Accumulator endpoint enables you to reset transaction and amount counters (since the last strongly-cardholder-authenticated transaction) on a card or payment-token. The endpoint also re-enables transactions (which are blocked as a result of the transaction) and amount counters exceeding the defined maximum limits for transactions that don’t meet the security requirements.
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 request is declined and an action code of 425 (Invalid Accumulator Type) is returned.
You can use the Clear Accumulator endpoint by making a POST request to the endpoint. For example:
{{base-url}}/ws/api/v1/Ws_ResetAccumulatorThe request must include the AccumulatorType field, which defines which translation counter or accumulator is being reset. The following table describes each of the types.
Type | Used For | Standard Upper Limits | Automatically Reset When |
|---|---|---|---|
1 | Contactless transactions that are deemed insecure | 5 transactions or 300 GBP accumulated amount. Single spend is 100 GBP. 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 transactions that are deemed insecure | 5 transactions or 100 GBP accumulated amount. Single spend is 30 GBP. 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. |
Note
The Accumulator Type is defined by the European Banking Authority under PSD2 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.
The following example displays a request where AccumulatorType is set to 1, which is used where there are contactless transactions that are deemed insecure.
{
"wsid": "20250213155006",
"AuthType": "1",
"PAN": "9999999999999999",
"AccumulatorType": "1",
"ClearAllDPANs": "1",
"IssCode": "PMT"
}If successful, a 200 response is returned. For example:
{
"PublicToken": "123456789",
"ActionCode": "000"
}More Information
- For detailed field descriptions for the fields in the request and response, see Clear Accumulator - Field Descriptions.
- To view the endpoint in the API Explorer, see Clear Accumulator.
Updated 7 days ago