Statement

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

Version 1.3

Version 1.2

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string,   1-255 characters,  required

Customer reference linked with this card

trackingNumber

string,  1-20 characters,  required

The tracking number of the card to retrieve the statement for

pocketUUID

string,  0-255 characters,  required

The UUID of the type of pocket to retrieve the statement for if applicable. Else, leave empty.

startDate

date,  required

The date that the statement should start from

endDate

date,  required

The date that the statement should end on

transactionID

string,  1-255 characters,  required

A unique identifier generated by the client, which must not be duplicated over time.

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  required

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>

 

Response codes
Value Description
1 Ok
-4 Validation error. verify the values that you provided are correct

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

pocketUUID

string

Echo

balance

array

Balances of pockets linked to the card

clientTransactionID

string

Echo of incoming value transaction id

serverTransactionID

string

Transaction id generated by Paymentology

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

statement

array

The transaction history of the card

transactionType, string

The identifier depicting the type of transaction.

1 – Load

2 – Deduction

3 – Authorization

merchantCategoryCode, string

Merchant category code (MCC)

transactionDate, date

Date and time of the transaction, string in ISO 8601 format eg. “20150121T02:04:35”

transactionAmount, double

Transaction amount

transactionDescription, string

Transaction description

transactionSource, string

Transaction type information

Authorization and Deduction:

POS

ATM

POS with Cashback

Visa Direct AFT

Unique Transaction (related to gambling)

Loads:

Refund

Visa Direct OCT

Payment Transaction (Moneysend/P2M/P2P/MPQR)

Balance Inquiry

Chargebacks

systemDate, date

Paymentology’s system date in UTC +7 time zone, string in ISO 8601 format eg. “20150121T02:04:35”

<?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>

 

Error Objects

Error Fault for invalid checksum authentication is the following message:

<?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>

 


Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string,  1-255 characters,  required

Customer reference linked with this card

trackingNumber

string,  1-20 characters,  required

The tracking number of the card to retrieve the statement for

pocketUUID

string,  0-255 characters,  required

The UUID of the type of pocket to retrieve the statement for if applicable. Else, leave empty.

startDate

date,  required

The date that the statement should start from

endDate

date,  required

The date that the statement should end on

transactionID

string,  1-255 characters,  required

A unique identifier generated by the client, which must not be duplicated over time.

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  required

HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<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>

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

pocketUUID

string

Echo

balance

array

Balances of pockets linked to the card

TransactionType

string

The identifier depicting the type of transaction.

1 – Load

2 – Deduction

3 – Authorisation

statement

array

The transaction history of the card

clientTransactionID

string

Echo

serverTransactionID

string

Transaction id generated by Paymentology

systemDate

string

Paymentology’s system date in UTC +7 time zone

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

<?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>
                                            </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>                

 

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.