Clear Accumulator - Field Descriptions

The following tables describe the fields that can be included in the request and the response for the Clear Accumulator endpoint.

Request

The following table describes the fields that can be included in the request.

Field

Description

Type

Min Length

Max Length

Mandatory

wsid

The web service ID. This must be unique for every request sent. You can set your own wsid, for example by using the current date and time (20250213145006), or you can leave the field blank and Thredd generates the wsid for you.

N

0

19

N

AuthType

Parameter to specify how the card should be authenticated:

1 = Card number (PAN) or public token
2 = Card number/public token & cardholder’s date of birth
3 = Card number/public token & CVC2
4 = Card number/public token & access code
5 = Login ID
6 = Card number and cardholder’s date of birth and cardholder’s last name
7 = Full Track2
8 = Card number & security data

AN

1

1

No

PAN

Card Number. Required in request if AuthType is 1, 2, 3, 4 or 6 and PublicToken not present.

AN

14

19

Conditional

PublicToken

The card’s public token. Mandatory in request if PAN is not present.

AN

1

9

Conditional

DOB

Date of Birth of the cardholder. Mandatory if value of AuthType is 2 or 6.

YYYY-MM-DD

10

10

Conditional

CVV

Card Verification Value, the 3-digit code printed on the back of the card. Mandatory if the value of AuthType is ‘3’.

AN

3

3

Conditional

AccCode

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’.

AN

0

6

Conditional

LastName

Cardholder's last name, used to authenticate the cardholder if the value of AuthType is ‘6’.

AN

1

20

Conditional

AccumulatorType

The type of accumulator to be cleared. See Clear Accumulator.

N

1

1

Yes

DPAN

Optional DPAN value for the MDES card. If provided, clears the accumulator for the supplied DPAN.

AN

0

19

No

PaymentTokenId

Optional payment token ID for the MDES card. If provided, clears the accumulator for the supplied payment token ID.

AN

0

16

No

ClearAllDPANs

Whether to clear all accumulators: 0 or empty string = No; 1 = Yes.

AN

0

1

No

IssCode

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

AN

1

4

Yes

Response

The following table describes the fields that are included in the response.

FieldDescription
PublicTokenThe card's public token.
ActionCodeThe action code for the response. See Action Codes.