MVC Card Activation and Load

API: Ws_Activate_MVCLoad

This web service allows simultaneous load and activation of a Master Virtual CardsClosed A Thredd virtual card that is restricted to loading and unloading to a physical card and cannot be used for e-commerce or in-store transactions. An MVC is used to reflect the value of the ‘actual’ money in the Issuer's bank account. An MVC guarantees that the load is limited to the amount prefunded (i.e. loaded onto MVC) and gives the Programme Manager the ability to distribute funds immediately rather than having to wait for notification of each individual load into the Issuer Bank account. (MVC). It combines the functions of Ws_BalanceTransfer and Ws_Activate for clients that are using MVCs.

Record Description

Tag

Type

Minimum Length

Maximum Length

Description

Request

Response

<WSID>

N

1

19

Web service ID. Must be unique for every web service request sent. For details, see the FAQs.Tip: You could use a number based on the current date and time, as long as it is unique (e.g., 20201217145006).

Mandatory

Mandatory

<IssCode>

AN

1

4

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

Mandatory

Mandatory

<TxnCode>

AN

1

2

The Transaction Code. See Transaction Codes. Default value is 10.

Mandatory

Mandatory

<Title>

AN

1

4

Cardholder’s title. Also used as the card purchaser's title if no delivery address is supplied.

Optional

Omit

<LastName>

AN

1

20

Cardholder's last name. If no delivery address is supplied, this is the card purchaser’s last name.

Optional

Omit

<FirstName>

AN

1

20

Member’s first name
Mandatory if <LastName> is present and the value of <ActMethod> is not ‘6’.

Conditional

Omit

<Addrl1>

AN

1

50

Address Line 1
Mandatory if ‘Address’ fields are being specified

Conditional

Omit

<Addrl2>

AN

1

50

Address line 2

Optional

Omit

<City>

AN

1

50

Cardholder's home city. Also used as the card purchaser's city if no delivery address is supplied. Mandatory if <addrL1> is present, and <postcode> is not present.

Conditional

Omit

<Postcode>

AN

1

10

Cardholder's home postcode. Also used as the card purchaser's postcode if no postcode is supplied. Mandatory if <addrL1> is present, and <city> is not present. See Postcode Permitted Characters.

Conditional

Omit

<Country>

AN

1

3

Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). Mandatory if <addrL1> is present.

Conditional

Omit

<ActMethod>

AN

1

1

Method used for card activation. See Activation Methods.

Mandatory

Omit

<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 <track2> and <PublicToken> are 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

The cardholder's date of birth. Mandatory if the value of <AuthType> is ‘2’ or ‘6’.

Conditional

Omit

<CVV>

AN

3

3

Card Verification ValueClosed 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 for setting a code which is validated during activation (e.g. via the Thredd IVR systemClosed Interactive Voice Response System Typically a telephony-based system, where the user calls in and selects options via an automated voice prompt.). If provided, must be 6 digits; leading zeroes are acceptable. Mandatory if the value of <AuthType> is ‘4’. Leave empty if not required.

Conditional

Omit

<LocDate>

YYYY-MM-
DD

10

10

The local current date in year-month-date format.

Mandatory

Mandatory

<LocTime>

HHMMSS

6

6

The local current time, in hour-minute-second format.

Mandatory

Mandatory

<MVCPAN>

AN

16

19

MVC card unique identifier. Mandatory if <MVCToken> is not present in the request.

Conditional

Omit

<MVCToken>

AN

16

19

The MVC card’s public token.

Conditional

Mandatory

<AmtTxn>

D

1

20

The requested amount to transfer. If not specified, the full card balance is transferred.The actual amount transferred is returned in the response. The amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes.

Mandatory

Mandatory

<CurCode>

AN

3

3

3-letter ISO currency code for the currency to load (e.g. EUR). This must match the card’s currency or the action fails (Note: For a Multi-FX card, the card can be loaded in any of the card's currencies). If not provided, then the card uses its billing currency. See Currency Codes.

Conditional

Mandatory

<LoadSrc>

AN

1

3

The source of the load request is used to determine the fee for the load, if applicable. For transfers between Primary and Secondary cards, the value must be 68. If omitted, defaults to 14 - Unknown for normal transfers, but 68 for Primary-Secondary card transfers.See Load Sources.

Optional

Omit

<LoadedBy>

AN

1

30

User who loaded the card.

Optional

Omit

<Description>

AN**

1

150

Description of the load. If supplied, appears in the <description> tag of a response to a card or account query. See Card Statement (V1).

Optional

Omit

<FeeWaiver>

N

1

1

Indicates whether to waive any web service fee set up on the system: 0 = No, 1 = Yes, 2 = Waive the fee on the “from” card only, 3= Waive the fee on the “to” card only. Default is 0.

Optional

Omit

<BrnCode>

AN

8

8

Branch code (or Agent code) with which the card is associated. If supplied, it is exported in the XML in CardLoadUnload > Card > branchcode.

Optional

Omit

<ActivateOrNot>

N

1

1

Whether to activate the card while loading. 1 = activate and load; 0 = load only.

Mandatory

Omit

<ExpDate>

YYYY-MM-DD

10

10

Card expiry date. If left blank, updates with the default expiry date, based on the Card Scheme's validity period in months, otherwise updates with the input value. The date returned of the actual physical expiry is in MM/YY.

Optional

Omit

<ItemSrc>

N

1

2

Source field to define alternate fees. Legacy field for information purposes only; see Item Source Types. Suggest using 0.

Mandatory

Omit

<SmsBalance>

N

1

1

Whether to send an SMS regarding the details of transaction amount and available balance to the customer after each card use. 0 or False = Do not send; 1 or True = Send; 2 = Do not change current value.

Optional

Omit

<IsLive>

N

1

1

Specifies whether the card is active or not. 1 or True = Active; 0 or False = Not Active.

Omit

Mandatory

<AvlBal>

D

1

20

The current balance on the card account. This includes all financial transactions and outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes.

Omit

Mandatory

<BlkAmt>

D

1

20

Amount of funds blocked on the card account as a result of all outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes.

Omit

Mandatory

<ItemId>

AN

1

20

The unique item ID for this Card Transfer. The ID returned is the ID relating to the ‘unload’ leg of the transfer, that is, the unload from the MVC.

Omit

Mandatory

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See MVC Action Codes.

Omit

Mandatory

** Some formatting may be done on this string, see String Cleaning and Approved Characters.

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_Activate_MVCLoad>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>10</hyp:TxnCode>
         <hyp:Title></hyp:Title>
         <hyp:LastName></hyp:LastName>
         <hyp:FirstName></hyp:FirstName>
         <hyp:Addrl1></hyp:Addrl1>
         <hyp:Addrl2></hyp:Addrl2>
         <hyp:City></hyp:City>
         <hyp:PostCode></hyp:PostCode>
         <hyp:Country></hyp:Country>
         <hyp:ActMethod>6</hyp:ActMethod>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:PAN></hyp:PAN>
         <hyp:PublicToken>670240217</hyp:PublicToken>
         <hyp:DOB></hyp:DOB>
         <hyp:CVV></hyp:CVV>
         <hyp:AccCode></hyp:AccCode>
         <hyp:LocDate>2021-08-12</hyp:LocDate>
         <hyp:LocTime>181818</hyp:LocTime>
         <hyp:MVCPAN></hyp:MVCPAN>
         <hyp:MVCToken>669773806</hyp:MVCToken>
         <hyp:AmtTxn>10</hyp:AmtTxn>
         <hyp:CurCode>USD</hyp:CurCode>
         <hyp:LoadSrc>7</hyp:LoadSrc>
         <hyp:LoadedBy>Mathews</hyp:LoadedBy>
         <hyp:Description>Activation and MVC Load</hyp:Description>
         <hyp:FeeWaiver></hyp:FeeWaiver>
         <hyp:BrnCode></hyp:BrnCode>
         <hyp:ActivateOrNot>1</hyp:ActivateOrNot>
         <hyp:ExpDate></hyp:ExpDate>
         <hyp:ItemSrc>0</hyp:ItemSrc>
         <hyp:SMSBalance></hyp:SMSBalance>
      </hyp:Ws_Activate_MVCLoad>
   </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_Activate_MVCLoadResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_Activate_MVCLoadResult>
            <WSID>7290533590339256320</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>10</TxnCode>
            <PublicToken>670240217</PublicToken>
            <MVCToken>669773806</MVCToken>
            <LocDate>2021-08-12</LocDate>
            <LocTime>120000</LocTime>
            <AmtTxn>10</AmtTxn>
            <CurCode>USD</CurCode>
            <IsLive>true</IsLive>
            <AvlBal>10</AvlBal>
            <BlkAmt>0</BlkAmt>
            <ItemID>123456</ItemID>
            <SysDate>2021-08-12</SysDate>
            <ActionCode>124</ActionCode>
         </Ws_Activate_MVCLoadResult>
      </Ws_Activate_MVCLoadResponse>
   </soap:Body>
</soap:Envelope>