Attach Card Data

A new schedule needs to have a credit card attached (card data) in order to process the scheduled transactions. This can either be added during the Create Schedule request (SUBTYPE=CS) or added later using this request.

The attached card may become invalid in many ways such as expiry, change of card number, cancelling the card or any other circumstance that results in the card issuer declining the transactions for this card. Once this happens the schedule must be updated by attaching a new card.

A card may be attached to a schedule either by a direct call to the host with the new card data (the Host-Based Method) or through the Web-Redirect Method where the customer enters their card data.

Attaching a card changes the STATUS of the schedule from E (card error) to R (ready) and from N (new) to R (ready) if the payment requirement is also met. (View all Schedule Status’ here)

Host-Based Method

This method is used when the platform has already collected the new card data and needs to update the schedule.

Attach New Card Data

Required
Request Field
Description
N
SUBTYPE
AC for attach card
N
SCHEDID
Unique identifier
N
CARD + EXP, TRACK, or TOKEN
For card data, must choose one

Response to Attaching New Card Data

Response Field
Description
CODE
0000 is approved; anything else is declined with an error
TEXT
ATTACHED or the error description
TOKEN
Tokenized version of the card data
SCHEDULEDATA
The Schedule Data block is appended to the response if the schedule was created.
Example: Attaching a new card (the wife of the cardholder in the previous example)

Request:
TERMID=TESTTERM&PASS=mypass&TYPE=L&SUBTYPE=AC&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&CARD=5454545454545454&EXP=1225&CUSTNAME=JANESMITH&CUSTEMAIL=janesmith@email.com
Response:
CODE=0000&TEXT=ATTACHED&&SCHEDID=123e4567‑e89b‑12d3‑a456426655440000&PYMTS=DATE=20200921&AMT=100.00&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&RESULT=A&NOTIFY=Y&CARDMASK=****6781&RESPONSE=APPROVED]DATE=20201021&AMT=100.00&REFNUM=c176637b‑18c8‑4ad0‑9140‑8c9de456bac5&RESULT=W&NOTIFY=N]&INVOICE=123456789&CARDMASK=****5454&CARDHASH=AFD6B61A6955A3B11B2ACEB4193EA981&CARDNAME=JANESMITH&STATUS=R
p

The previously processed payment still shows the card mask of the card it was processed on

Web-Redirect Method

This method is used to allow the cardholder to update their card data using the hosted payment page.

The schedule of payments is included on the payment page and it is indicated that the card will not be charged at this time.

Using Web-redirect to attach a card to a scheduled payment is as simple as adding the appropriate SCHEDID and an empty (or omitted) REFNUM to the StartSession message and then proceeding with the normal redirection sequence.