Messaging API Message

Each remote capture batch message is a service request message wrapped in a Gateway Server Messaging API message. The message type of remote capture batch messages can be one of the following values:
  • CAPTURE_OPEN_BATCH
  • CAPTURE_PAYMENT
  • CAPTURE_TRANSACTION
  • CAPTURE_CLOSE_BATCH
The Gateway Server can support the following types of remote capture messages:
  • Batch message
  • Transaction message
  • Item message

Each batch message has a unique message group ID and each message in the same batch has a unique sequence number. No response is required for the batch messages. The real batch message is wrapped in the payload of the Messaging API message. See Table 1.

Each batch message is required to be validated by PayDirCapture1.xsd before it is wrapped by the Messaging API message. Gateway Server does not validate the message.

Messaging API messages must be validated by appbridge.xsd before they are sent to the Gateway Server receiving queue. Gateway Server does not validate the message.

Table 1. Messaging API Message
Parameter Name Value Description
msgDesc Service Request Message description
msgType CAPTURE_OPEN_BATCH CAPTURE_PAYMENT CAPTURE_TRANSACTION CAPTURE_CLOSE_BATCH Message type
version false Version of the message
messageTime   Current time with time zone.
sourceId   Source of the batch
destinationId PAYDIR_GATEWAY Destination of 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
The following is a sample Messaging API message.
Note: The XML in bold font is the actual remote capture batch message. The XML in regular font is the Messaging API message that contains the remote capture batch message.
<?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>