BatchAdminReq

NAME: BatchAdminReq - SET BatchAdminReq message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct BatchAdminReq_ {
    asn1set__MessageWrapper      messageWrapper;
    asn1set__BatchAdminReqData   batchAdminReqData;
    cert_identity                merchantSignatureCID;
    cert_identity                gatewayKeyExchangeCID;
} *BatchAdminReq;

BatchAdminReq safe_cast_BatchAdminReq(msg)
    set_msg            msg;             /* IN */

DESCRIPTION: BatchAdminReq contains the data from a SET BatchAdminReq 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.
BatchAdminReq message objects of type set_msg can be cast to type BatchAdminReq using the safe_cast_BatchAdminReq() 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.rrPID
 *    messageWrapper.messageHeader.swIdent
 *    messageWrapper.message._choice
 *    batchAdminReqData.brandAndBINSeq
 *    batchAdminReqData.batchAdminRRTags.rrpid
 *    batchAdminReqData.batchAdminRRTags.currentDate

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

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

 *    batchAdminReqTBS.batchAdminRRTags.merTermIDs.merchantID
 *    merchantSignatureCID

Non-required fields may be left empty at the discretion of the merchant application.

CACHING

Payment Gateway

      STATE_BATCHADMINREQ_RRPID      put
      STATE_RRTAGS                   put

Merchant

      STATE_BATCHADMINREQ_RRPID      put
      STATE_BRANDID                  get

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

SEE ALSO: set_msg

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.


    batchAdminReq = safe_cast_BatchAdminReq(request);
    assert(batchAdminReq != 0);
   
    /* agentNum is an optional INTEGER */         
    batchAdminReq->batchAdminReqTBS.batchAdminTags.merTermIDs.agentNum = N_AGENT;
    SET_PRESENT(batchAdminReq->batchAdminReqTBS.batchAdminRRTags.merTermIDs,
                asn1set__MerTermIDs__agentNum);
                
    /* ... */

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