Remote Capture Message Content

Each remote capture message is a service request with a header and a payload section. The header has a message type field. The message type of a remote capture message can be one of the following values: 
     CAPTURE_OPEN_BATCH
     CAPTURE_PAYMENT
     CAPTURE_TRANSACTION
     CAPTURE_CLOSE_BATCH

Each batch of messages has a unique message group ID, and each message in the same batch has a unique sequence number within the batch. A response is not required for the batch messages. The batch (ICL) data fields are in the payload section of the message.

All remote capture messages are required to validate according to appbridge.xsd when they arrive in the Gateway Server receiving queue. The Gateway Server does not validate the messages.

Table 1. Remote Capture Message Values
Parameter Name Value Description
msgDesc Service request Message description
msgType
  • CAPTURE_OPEN_BATCH
  • CAPTURE_PAYMENT
  • CAPTURE_TRANSACTION
  • CAPTURE_CLOSE_BATCH
 Message type
version 1.0.0 Version of the message
messageTime   Current time with the time zone
sourceId   Source of the batch
destinationId PAYDIR_GATEWAY Destination of the batch
msgGroup → id   Unique batch message group ID
msgGroup → seqNum   Unique sequence number in the same batch
responseRequired False Message response required
payload   Payload of the batch message
A sample XML remote capture message is shown below. 
<?xml version="1.0" encoding="UTF-8"?>
<ibmPaymentsDirectorBridge xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="appbridge.xsd" 
    xmlns:cap="http://www.ibm.com/PayDirCapture"
    xsi:schemaLocation="http://www.ibm.com/PayDirCapture PayDirCapture1.xsd">
   <header>
      <msgDesc>Service Request</msgDesc>
      <msgType>CAPTURE_OPEN_BATCH</msgType>
      <version>1.0.0</version>
      <messageTime>2008-09-27T21:30:40-04:00</messageTime>
      <sourceId>VENDORA_ATM01</sourceId>
      <destinationId>PAYDIR_GATEWAY</destinationId>
      <msgGroup>
         <id>VENDOR_ASSIGNED_UNIQUE_IDENTIFIER</id>
         <seqNum>1</seqNum>
      </msgGroup>
      <responseRequired>false</responseRequired>
   </header>
   <payload>
      <cap:batchRecord type="open" xmlns:cap="http://www.ibm.com/PayDirCapture"
           xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance">
         <userField>sample batch user data</userField>
         <enterpriseID>enterprise0</enterpriseID>
         <bankID>bank0</bankID>
         <branchID>branch0</branchID>
         <batchID>batch0</batchID>
         <businessDate>2008-09-26</businessDate>
         <sourceType>teller</sourceType>
         <openDateTime>2008-09-27T12:00:00</openDateTime>
         <providerTimeZone>-04:00</providerTimeZone>
         <originalRecordData format="IR"></originalRecordData>
      </cap:batchRecord>
   </payload>
</ibmPaymentsDirectorBridge>
The Gateway Server supports the following types of remote capture messages:
  • Batch message
  • Transaction message
  • Item message

The batch message includes open batch message and close batch message.

The payload section is required to validate according to PayDirCapture1.xsd when it arrives in the Gateway Server receive queue. The Gateway Server does not validate the message.