Statement

Retrieve the statement of a card (or pocket if applicable).

Version 1.3

Version 1.2

Version 1.3

Request Path Parameters

ParametertypeLimitsrequiredDescription
terminalIDString10 characters✓The Paymentology issued terminal id of the terminal requesting the transaction
customerReferenceString1-255 characters✓Customer reference linked with this card
trackingNumberString1-20 characters✓The tracking number of the card to retrieve the statement for
pocketUUIDString0-255 characters✓The UUID of the type of pocket to retrieve the statement for if applicable. Else, leave empty.
startDateDate✓The date that the statement should start from
endDateDate✓The date that the statement should end on
transactionIDString1-255 characters✓A unique identifier generated by the client, which must not be duplicated over time.
transactionDateDate✓Transaction date generated by the calling client
checksumString✓HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key
<methodCall>
  <methodName>Statement</methodName>
  <params>
    <param>
      <value>
        <string>0008866376</string>
      </value>
    </param>
    <param>
      <value>
        <string>TEST_CUSTOMER</string>
      </value>
    </param>
    <param>
      <value>
        <string>787454700000007</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20160101T00:00:00</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20160630T00:00:00</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20160525T00:00:00</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>A30D6EE719BC95056878F9C2BF57A42BC77FFA51</string>
      </value>
    </param>
  </params>
</methodCall>
``````xml
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
            </value>
          </member>
          <member>
            <name>statement</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>transactionType</name>
                        <value>
                          <int>1</int>
                        </value>
                      </member>
                        <member>
                        <name>merchantCategoryCode</name>
                        <value>
                          <string></string>
                        </value>
                      </member>
                      <member>
                        <name>transactionDate</name>
                        <value>
                          <dateTime.iso8601>20160527T14:34:45</dateTime.iso8601>
                        </value>
                      </member>
                      <member>
                        <name>transactionSource</name>
                        <value>
                          <string>POS</string>
                        </value>
                      </member>
                      <member>
                        <name>transactionAmount</name>
                        <value>
                          <double>40.0000</double>
                        </value>
                      </member>
                      <member>
                        <name>transactionID</name>
                        <value>
                          <string>63aa6275-b497-4d08-a099-14fab686b302</string>
                        </value>
                      </member>
                      <member>
                        <name>transactionDescription</name>
                        <value>
                          <string>Standard Bank Virtual Card App Issuer</string>
                        </value>
                      </member>
                      <member>
                        <name>systemDate</name>
                        <value>
                          <dateTime.iso8601>20160527T14:34:45</dateTime.iso8601>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>terminalID</name>
            <value>
              <string>0008866376</string>
            </value>
          </member>
          <member>
            <name>customerReference</name>
            <value>
              <string>TEST_CUSTOMER</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>Approved</string>
            </value>
          </member>
          <member>
            <name>pocketUUID</name>
            <value>
              <string></string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>58F8AF30-FD3D-06A7-FB21317D7EC9C7D2</string>
            </value>
          </member>
          <member>
            <name>trackingNumber</name>
            <value>
              <string>787454700000007</string>
            </value>
          </member>
          <member>
            <name>balance</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>currency</name>
                        <value>
                          <string>840</string>
                        </value>
                      </member>
                      <member>
                        <name>amount</name>
                        <value>
                          <double>1172</double>
                        </value>
                      </member>
                      <member>
                        <name>pocketUUID</name>
                        <value>
                          <string>7676F2C8-155D-0028-9DEA0D29AD914DA0</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

<a id="error-objects"></a>
### Error Objects

Error Fault for *invalid checksum* authentication is the following message:

```xml

  Statement

        0008866376

        TEST_CUSTOMER

        787454700000007

        20160101T00:00:00

        20160630T00:00:00

        d89d6df6-4e14-45a5-a32c-217c7175dfdb

        20160525T00:00:00

        A30D6EE719BC95056878F9C2BF57A42BC77FFA51

```xml
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
            </value>
          </member>
          <member>
            <name>statement</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>transactionType</name>
                        <value>
                          <int>1</int>
                        </value>
                      </member>
                        <member>
                        <name>merchantCategoryCode</name>
                        <value>
                          <string></string>
                        </value>
                      </member>
                      <member>
                        <name>transactionDate</name>
                        <value>
                          <dateTime.iso8601>20160527T14:34:45</dateTime.iso8601>
                        </value>
                      </member>
                      <member>
                        <name>transactionSource</name>
                        <value>
                          <string>POS</string>
                        </value>
                      </member>
                      <member>
                        <name>transactionAmount</name>
                        <value>
                          <double>40.0000</double>
                        </value>
                      </member>
                      <member>
                        <name>transactionID</name>
                        <value>
                          <string>63aa6275-b497-4d08-a099-14fab686b302</string>
                        </value>
                      </member>
                      <member>
                        <name>transactionDescription</name>
                        <value>
                          <string>Standard Bank Virtual Card App Issuer</string>
                        </value>
                      </member>
                      <member>
                        <name>systemDate</name>
                        <value>
                          <dateTime.iso8601>20160527T14:34:45</dateTime.iso8601>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>terminalID</name>
            <value>
              <string>0008866376</string>
            </value>
          </member>
          <member>
            <name>customerReference</name>
            <value>
              <string>TEST_CUSTOMER</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>Approved</string>
            </value>
          </member>
          <member>
            <name>pocketUUID</name>
            <value>
              <string></string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>58F8AF30-FD3D-06A7-FB21317D7EC9C7D2</string>
            </value>
          </member>
          <member>
            <name>trackingNumber</name>
            <value>
              <string>787454700000007</string>
            </value>
          </member>
          <member>
            <name>balance</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>currency</name>
                        <value>
                          <string>840</string>
                        </value>
                      </member>
                      <member>
                        <name>amount</name>
                        <value>
                          <double>1172</double>
                        </value>
                      </member>
                      <member>
                        <name>pocketUUID</name>
                        <value>
                          <string>7676F2C8-155D-0028-9DEA0D29AD914DA0</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>
``````xml
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <fault>
    <value>
      <struct>
        <member>
          <name>faultCode</name>
          <value>
            <int>-8</int>
          </value>
        </member>
        <member>
          <name>faultString</name>
          <value>
            <string>Authentication failed</string>
          </value>
        </member>
      </struct>
    </value>
  </fault>
</methodResponse>
``````xml
<methodCall>
    <methodName type="xs:string">Statement</methodName>
    <params>
        <param>
            <value>
                <string>0008866376</string>
            </value>
        </param>
        <param>
            <value>
                <string>TEST_CUSTOMER</string>
            </value>
        </param>
        <param>
            <value>
                <string>787454700000007</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20160101T00:00:00</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20160630T00:00:00</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20160525T00:00:00</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>A30D6EE719BC95056878F9C2BF57A42BC77FFA51</string>
            </value>
        </param>
    </params>
</methodCall>
``````xml
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
                        </value>
                    </member>
                    <member>
                        <name>statement</name>
                        <value>
                            <array>
                                <data>
                                    <value>
                                        <struct>
                                            <member>
                                                <name>transactionType</name>
                                                <value>
                                                    <int>1</int>
                                                </value>
                                            </member>
                                              <member>
                                                <name>merchantCategoryCode</name>
                                                <value>
                                                    <string></string>
                                                </value>
                                            </member>
                                            <member>
                                                <name>transactionDate</name>
                                                <value>
                                                    <dateTime.iso8601>20160527T14:34:45</dateTime.iso8601>
                                                </value>
                                            </member>
                                            <member>
                                                <name>transactionAmount</name>
                                                <value>
                                                    <double>40.0000</double>
                                                </value>

Version 1.2

Request Path Parameters

ParametertypeLimitsrequiredDescription
terminalIDString10 characters✓The Paymentology issued terminal id of the terminal requesting the transaction
customerReferenceString1-255 characters✓Customer reference linked with this card
trackingNumberString1-20 characters✓The tracking number of the card to retrieve the statement for
pocketUUIDString0-255 characters✓The UUID of the type of pocket to retrieve the statement for if applicable. Else, leave empty.
startDateDate✓The date that the statement should start from
endDateDate✓The date that the statement should end on
transactionIDString1-255 characters✓A unique identifier generated by the client, which must not be duplicated over time.
transactionDateDate✓Transaction date generated by the calling client
checksumString✓HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

  Statement

        0008866376

        TEST_CUSTOMER

        787454700000007

        20160101T00:00:00

        20160630T00:00:00

        d89d6df6-4e14-45a5-a32c-217c7175dfdb

        20160525T00:00:00

        A30D6EE719BC95056878F9C2BF57A42BC77FFA51

  Statement

        0008866376

        TEST_CUSTOMER

        787454700000007

        20160101T00:00:00

        20160630T00:00:00

        d89d6df6-4e14-45a5-a32c-217c7175dfdb

        20160525T00:00:00

        A30D6EE719BC95056878F9C2BF57A42BC77FFA51