CapRes

NAME: CapRes - SET CapRes message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct CapRes_ {
    asn1set__MessageWrapper    messageWrapper;
    asn1set__CapResData        capResData;
    asn__any                   gatewaySignatureCID;
    asn__any                   merchantKeyExchangeCID;
} *CapRes;

CapRes safe_cast_CapRes(msg)
    set_msg            msg;             /* IN */

DESCRIPTION: CapRes contains the data from a SET CapRes message in native C form. See the asn_types.h and asn1set.h header files for the declarations of the various types. See the SET specification for a description of individual fields.
CapRes message objects of type set_msg can be cast to type CapRes using the safe_cast_CapRes() routine.

FIELDS

A call to make_set_msg() results in the protocol layer filling in the following fields:

 *    messageWrapper.messageHeader.version
 *    messageWrapper.messageHeader.date
 *    messageWrapper.messageHeader.messageIDs
 *    messageWrapper.messageHeader.rrPID
 *    messageWrapper.messageHeader.swIdent
 *    messageWrapper.message._choice
 *    capResData.capTags.rrTags
 *    capResData.capTags.brandCRLIdentifier (optional)
 *    capResData.capTags.peThumb (optional)
 *    capResData.capResItemSeq->capResItem.transIDs
 *    capResData.capResItemSeq->capResItem.authRRPID
 *    gatewaySignatureCID
 *    merchantKeyExchangeCID

It is unwise for applications to change the contents of the fields filled in by the protocol layer.

After calling make_set_msg(), gateway software must fill in the following required fields:

 *    capResData.capResSeq->capResItem.capResPayload.capCode
 *    capResData.capResSeq->capResItem.capResPayload.capAmt

Non-required fields may be left empty at the discretion of the gateway application, subject to any business constraints placed on the application.

CACHING

Payment Gateway

      STATE_AUTHREQ_RRPID            get
      STATE_CAPREQ_RRPID             get
      STATE_GATEWAY_SIGID            get
      STATE_MERCHANT_KEYID           get
      STATE_RRTAGS                   get
      STATE_TRANSIDS                 get

Merchant

      STATE_CAPAMT                   put
      STATE_CAPCODE                  put
      STATE_CAPDATE                  put
      STATE_CAPREQ_RRPID             get

RETURN VALUES: On success, safe_cast_CapRes() returns a pointer to a CapRes data structure. Objects of type set_msg that were not created with message type asn1set__Message__capRes will cause safe_cast_CapRes() to fail. On failure, safe_cast_CapRes() returns a 0 pointer.

SEE ALSO: set_msg, AuthReq, AuthRes, CapReq, PInitReq, PInitRes, PReq, PRes

NOTES: There is a difference between non-required and optional. Non-required fields may be omitted according to the SET protocol. Optional fields may be omitted according to ASN.1 encoding rules. In some messages, a field may be optional according to ASN.1, but still required by the SET protocol. In these cases, it is incumbent on the application to fill in these fields.
Optional fields that are filled in require an application of the SET_PRESENT() macro. See documentation on ASN.1/DER runtime types for additional information.

EXAMPLE

A more complete, explicated example is provided in the Implementor's Guide.

    capRes = safe_cast_CapRes(response);
    assert(capRes != 0);
   
    capRes->messageWrapper.messageHeader.swIdent._choice = asn1set__SWIdent__visibleString;
    capRes->messageWrapper.messageHeader.swIdent.u.visibleString = "AcquirerServ v0.3b";

    /* ... */

BUGS: This document describes a beta implementation. The information contained in this document may be incomplete and is subject to change.