Examples: Web-Redirect

Scenario

Customer pays for Winter Tryouts. The Organization's registrar mistakenly Refunds the transaction. As a result, the Refund must Voided.

Sale with Ack in GetResult

 All values in Purple are either merchant specific or transaction specific values that have been made up for demonstration purposes.

REQUIRED FIELD VALUE
N TERMID TEST2222
N TYPE W
N PASS mypass
N ACTION StartSession
N AMT 120.25
N CUSTEMAIL custname@email.com
N REQUESTID 1234564789
  REFNUM TW123456
  INV TRYOUTSWINTER

The INV and REFNUM field are being used as transaction identifiers to enable searchability in reporting.

Request:
TERMID=TEST2222&TYPE=W&PASS=mypass&ACTION=StartSession&AMT=120.25&REQUESTID=12345678&CUSTEMAIL=custname@gmail.com&REFNUM=TW123456&INV=TRYOUTSWINTER
Response:
CODE=0000&TEXT=SUCCESS&SECUREID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&URL=https://www.PaymentHost.com:1443/redirect/Redirect?SecureID=i1t6tvowc908r1655ww3816tv5cw88l1wa8%38SecureTYPE=GET&DATE=2016‑03‑28&TIME=17:58:08&DUR=0.146
Request:
TERMID=TEST2222&TYPE=W&PASS=mypass&ACTION=GetResult&SECUREID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&ACK=Y
Response:
CODE=0000&SECUREID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&TEXT=Approved&CARDTYPE=V&AUTH=123456&AMT=120.25&REQUESTID=12345678&REFNUM=TW123456&ACK=Y&TOKEN=4003BFDRESA19999&DATE=2016‑03‑28&TIME=17:58:08&DUR=0.146

Return a Sale Transaction

  • You will utilize the TOKEN retrieved from the Sale transaction’s GetResult response (refer to Response above) to complete a Return host-based transaction
  • While INV is not required, it is highly recommended as it ‘groups’ the Return transaction to the Sale transaction for reporting purposes.
    *The Invoice field is INV for host-based transactions and not “Invoice”.
  • You must use new, unique REF
    *The Reference Number field is REF for host-based transactions and not “RefNum”

    REQUIRED

    		 FIELD VALUE

    N

    		 TERMID TEST2222

    N

    		 TYPE R

    N

    		 TOKEN 4003BFDRESA19999

    N

    		 AMT 12025

    N

    		 REF RETURN123

     

    		 INV TRYOUTSWINTER

    Note: With host-based transactions, the amount DOES NOT include decimals but must include cents.
    i.e. “12500” is interpreted as $125.00 and “125” is interpreted as $1.25

    Request:
    TERMID=TEST2222&TYPE=R&TOKEN=4003BFDRESA19999&AMT=12025&REFNUM=RETURN123&INVOICE=TRYOUTSWINTER
    Response:
    TEXT=RETURN            $120.25&CODE=0000

    Void a Return Transaction

    With the exception of the TYPE field, you will be sending the same fields and values that was sent for the original Return transaction.

    All values in Purple are either merchant specific or transaction specific values that have been made up for demonstration purposes.

    REQUIRED FIELD VALUE
    N TERMID TEST2222
    N TYPE M
    N TOKEN 4003BFDRESA19999
    N AMT 12025
    N REF RETURN123
      INV

    TRYOUTSWINTER

     

    Request:
    TERMID=TEST2222&TYPE=M&TOKEN=4003BFDRESA19999&AMT=12025&REF=RETURN123&INV=TRYOUTSWINTER
    Response:
    TEXT=MRVOID OK     &CODE=0000

    Further Scenarios

    What happens if a Return Void is sent twice?

    Request:
    TERMID=TEST2222&TYPE=M&TOKEN=4003BFDRESA19999&AMT=12025&REF=RETURN123&INV=TRYOUTSWINTER
    Response:
    TEXT=MRV NO MATCH     &CODE=1015

     

    Answer: The transaction would not be completed and you would receive a no match response.

     

    Scenario

    Customer registers for Spring season. Later, the Customer registers for the Fall season and is able to use their credit card on file to process the transaction. This is achieved through the use of TOKEN.

    Sale

     All values in Purple are either merchant specific or transaction specific values that have been made up for demonstration purposes.

    REQUIRED

    FIELD

    VALUE

    N

    TERMID

    TEST9876

    N

    TYPE

    W

    N

    PASS

    mypass

    N

    ACTION

    		 StartSession

    N

    AMT

    160.00

    N

    CUSTEMAIL

    custname@email.com

    N

    REQUESTID

    987654321

     

    REFNUM

    20230420SS1234

     

    INV

    SPR20231234

     

    DESC

    Spring Season 2023

    The INV and REFNUM field are being used as transaction identifiers to enable searchability in reporting.

    Request (StartSession)
    TERMID=TEST9876&TYPE=W&PASS=mypass&ACTION=StartSession&AMT=160.00&REQUESTID=987654321&CUSTEMAIL=custname@gmail.com&REFNUM=20230420SS1234&INV=SPR20231234&DESC=SPRING SEASON 2023
    Response (Start Session)
    CODE=0000&TEXT=SUCCESS&SECUREID=k1t6tvoxc908r1655ww380988nmb5cw&URL=https://www.PaymentHost.com:1443/redirect/Redirect?SecureID=k1t6tvoxc908r1655ww380988nmb5cw%38SecureTYPE=GET&DATE=2023‑03‑28&TIME=07:14:31&DUR=0.136
    Request (GetResult)
    TERMID=TEST9876&TYPE=W&PASS=mypass&ACTION=GetResult&SECUREID=k1t6tvoxc908r1655ww380988nmb5cw
    Response (GetResult)
    CODE=0000&SECUREID=k1t6tvoxc908r1655ww380988nmb5cw&TEXT=Approved&CARDTYPE=V&AUTH=1122233&AMT=160.00&REQUESTID=987654321&REFNUM=20230420SS1234&ACK=N&TOKEN=6703BF87THESA18KJJJ&DATE=2023‑03‑28&TIME=07:14:31&DUR=0.136
    Request (Ack)
    TERMID=TEST9876&TYPE=W&PASS=mypass&ACTION=Ack&SECUREID=k1t6tvoxc908r1655ww380988nmb5cw
    Response (Ack)
    CODE=0000&TEXT=CAPTURED&DATE=2023‑03‑28&TIME=07:14:31&DUR=0.136

     

    Sale using Token

    • You will utilize the TOKEN obtained from the customer’s initial transaction (see the GetResult response above) to complete a Sale host-based transaction.

     All values in Purple are either merchant specific or transaction specific values that have been made up for demonstration purposes.

    REQUIRED FIELD VALUE
    N TERMID TEST9876
    N PASS mypass
    N TYPE S
    N TOKEN 6703BF87THESA18KJJJ
    N AMT 16000
    N REF 20230420FS1001
      CUSTNAME CINDY SMITH
      CUSTEMAIL custname@gmail.com
      INV FALL20231234
      DESC Fall Season 2023

     

    Request:
    TERMID=TEST9876&PASS=mypass&TYPE=S&TOKEN=6703BF87THESA18KJJJ&AMT=16000&REF=20230420FS1001&INVOICE=FALL20231234&DESC=FALLSEASON2023&CUSTNAME=CINDYSMITH&CUSTEMAIL=custname@gmail.com
    Response:
    TEXT=APPROVED            $160.00&CODE=0000

     

    Further Scenarios

    What are my options if the TOKEN's card is expired?

    If the TOKEN is attached to a card that is expired, you could resolve it one of two ways depending on whether you want to process a transaction simultaneous to obtaining a new card token.

    Option 1: If you want to process a transaction simultaneous to obtaining a new TOKEN, then you will create a new Payment Session and process the transaction as a standard Web-Redirect transaction where you will receive a new TOKEN in the GetResult response (refer to “Sale” example above).

    Option 2: If you want to obtain a new TOKEN without processing a new transaction, then you will follow the steps for Obtain Card Token (illustrated below)

    Obtain Card Token

    All values in Purple are either merchant specific or transaction specific values that have been made up for demonstration purposes.

     

    REQUIRED

    FIELD

    VALUE

    N

    TERMID

    TEST9876

    N

    TYPE

    W

    N

    PASS

    mypass

    N

    ACTION

    		 StartSession

    N

    AMT

    0.00

    N

    CUSTEMAIL

    custname@email.com

    N

    REQUESTID

    TOKEN

     

    Request (StartSession)
    TERMID=TEST9876&TYPE=W&PASS=mypass&ACTION=StartSession&AMT=0&REQUESTID=TOKEN&CUSTEMAIL=custname@gmail.com
    Response (Start Session)
    CODE=0000&TEXT=SUCCESS&SECUREID=z1t6tvowc908r1655ww3816tv5cw88l1wa8&URL=https://www.PaymentHost.com:1443/redirect/Redirect?SecureID=z1t6tvowc908r1655ww3816tv5cw88l1wa8&DATE=2023-03-28&TIME=17:58:08&DUR=0.146
    Request (GetResult)
    TERMID=TEST9876&TYPE=W&PASS=mypass&ACTION=GetResult&SECUREID=z1t6tvowc908r1655ww3816tv5cw88l1wa8
    Response (GetResult)
    CODE=0000&TEXT=TOKENOK&SECUREID=z1t6tvowc908r1655ww3816tv5cw88l1wa8&CARDTYPE=V&ACK=Y&TOKEN=7003BFDRESA19999&DATE=2023‑03‑28&TIME=17:58:08&DUR=0.146