Difference between revisions of "SiaRegisterParams"

From Gvp-public
Jump to navigation Jump to search
 
Line 125: Line 125:
 
In GVP: 1. Only for '''modToken''' operations, else return ""
 
In GVP: 1. Only for '''modToken''' operations, else return ""
 
{{!}} Y
 
{{!}} Y
{{!}} Y (only for '''modToken''')
+
{{!}} N
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 134: Line 134:
 
In GVP: 1. Only for '''modToken''' operations, else return ""
 
In GVP: 1. Only for '''modToken''' operations, else return ""
 
{{!}} Y
 
{{!}} Y
{{!}} Y (only for '''modToken''')
+
{{!}} N
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  

Latest revision as of 15:14, 14 April 2016

Represents the list of parameters that must be sent to SIA to call registration card form.

Members

Field Data Type Description Only for modtoken (N/Y) Used for RSA calculation (N/Y)
formUrl String Instance parameter gvp.sia > SERVICE_URLS > FORM_URL N N
Params.IDVERSION String Instance parameter gvp.sia > SIA_PARAMS > ID_VERSION N Y
Params.IDENTIDAD String Instance parameter gvp.sia > SERVICE_PARAMS > SIA_ENTITY N Y
Params.IDCOMERCIO String Instance parameter gvp.sia > SERVICE_PARAMS > SIA_COMMERCE N Y
Params.IDUSUARIO String Fulfilled with GVP_USERS.id N Y
Params.IDTM String "1200" for authorise operations, "1324" for modToken N Y
Params.OPCTOKEN String Instance parameter gvp.sia > SERVICE_PARAMS > OPCTOKEN N Y
Params.IDPEDIDO String MICXXXX

where XXXX = GVP_SIA_MICROPAYMENTS.ID

N Y
Params.IMPTRANS String Instance parameter gvp.sia > SERVICE_PARAMS > SIA_MICROPAYMENT N Y
Params.CODMON String Instance parameter gvp.sia > SERVICE_PARAMS > SIA_CURRENCY N Y
Params.TIMETRANS String Timestamp +” “+ Zone of the web portal at the time of serving to the end customer browser the order confirmation screen. (yyyy-MM-DDThh: mm:SS.sss Etc/UTC)

In GVP timestamp will be provided always as UTC time and timezone will be always "Etc/UTC". Example: 2015-12-09T14:19:28.373 Etc/UTC

N Y
Params.IPORIGEN String Client public IP address, i.e. retrieved from XFF header. N Y
Params.FIRMTOKEN String RSA signature for MANAGE CREDIT CARD operations (authorize or modToken). N N
Params.TOKEN String Only for modToken operations the existing old token found in GVP_USERS_SIA_CARDS will be used, else it will be returned void "". Y Y (only for modToken)
Params.DESTOKEN String Instance parameter gvp.sia > SERVICE_PARAMS > DESTOKEN N Y
Params.SUSTKNSUSCRIP String 0: SIA does not updates subscriptions.

1: SIA updates token for all subscriptions.
In GVP: 1. Only for modToken operations, else return ""

Y N
Params.BJATKNANT String 0: SIA does not cancel old token.

1: SIA cancels token included in TOKEN field.
In GVP: 1. Only for modToken operations, else return ""

Y N
Params.URLOK String Params.URLOK = [BLOCK1]?clientUrlOK=[BLOCK2]&clientUrlKO=[BLOCK3] where:
BLOCK1 = SERVICE_PARAMS > SIA_URL_OK. Example: http://sianotification.mca.tid.es/api/creditcard/confirm
BLOCK2 = clientUrlOk input parameter value. Example: http://vivoplay.mca.tid.es/CreditCardOk
BLOCK3 = ' clientUrlKo input parameter value . Example: http://vivoplay.mca.tid.es/CreditCardFailed
Resulting URLOK with these examples: http://sianotification.mca.tid.es/api/creditcard/confirm?clientUrlOK= http://vivoplay.mca.tid.es/CreditCardOk&clientUrlKO=http://vivoplay.mca.tid.es/CreditCardFailed
N N
Params.URLKO String Params.URLKO = [BLOCK1]?clientUrlKO=[BLOCK2] where:
BLOCK1 = SERVICE_PARAMS > SIA_URL_KO. Example: http://sianotification.mca.tid.es/api/creditcard/refuse
BLOCK2 = escaped clientUrlKo input parameter value . Example: http://vivoplay.mca.tid.es/CreditCardFailed
Resulting URLKO with these examples: http://sianotification.mca.tid.es/api/creditcard/refuse?clientUrlKO=http://vivoplay.mca.tid.es/CreditCardFailed
N N
Params.sNombreEvento String "1200" for authorise operations, "1324" for modToken N N
Params.sIdWindow String Instance parameter gvp.sia > SERVICE_PARAMS > ID_WINDOW N N


Example

Example for authorise method (it doesn't require the modtoken params).

{
  "formUrl": "http://216.177.213.245:6980/servlet/ServletDirector",
  "Params": {
    "IDVERSION": "0001",
    "IDENTIDAD": "TVID",
    "IDCOMERCIO": "055720353",
    "IDUSUARIO": "12313",
    "IDTM": "1200",
    "OPCTTOKEN": "01",
    "IDPEDIDO": "MIC1231313",
    "IMPTRANS": "50",
    "CODMON": "978",
    "TIMETRANS": "2016-01-13T01:55:11.515 Etc/UTC",
    "IPORIGEN": "195.235.092.025",
    "FIRMTOKEN": "MkdqtXsJHXZ1ZbWM2N8xVwNGvHMTAcuvFEOTYxtjCkL9i9wSkMeoj5tP2TsRNvVi7GMSTZFifIYGRtkgDAXFiQfypIPVL5ExjBD71Dbm6qRKCJaT3wg+ZG3M3x85k0kcg0o8w/4MreKGXC2QJZSs3WpScftMC3wJFEDlnGPXBmS55HWaMlYDE8iF75wFsdDGrZpju2TlsmCCospM4sB2izv2iSYTU6atqjOnW0X1FAwc7lBfzR1BJY4Uiqt20P+5E6vYv04H+BIUcW8OvT1pnYbp1dCo+wRajO4gk9ZuDGfnb8Yhv231EzH9P7aar2V+UUrripFw93jlXTyR9ll+AA==",
    "TOKEN":"", 
    "DESTOKEN": "Default",
    "SUSTKNSUSCRIP":"",
    "BJATKNANT":"",
    "URLOK": "http://sianotification.mca.tid.es/api/creditcard/confirm?clientUrlOK= http://vivoplay.mca.tid.es/CreditCardOk&clientUrlKO=http://vivoplay.mca.tid.es/CreditCardFailed",
    "URLKO": "http://sianotification.mca.tid.es/api/creditcard/refuse?clientUrlKO=http://vivoplay.mca.tid.es/CreditCardFailed",
    "sNombreEvento": "1200",
    "sIdWindow": "Interface"
  }
}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation


See also