BearerDetail

Get the details of the bearer that is identified by the given tracking number

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

Tracking number that identifies the card to be returned

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">BearerDetail</methodName>
  <params>
    <param>
      <value>
        <string>1234567890</string>
      </value>
    </param>
    <param>
      <value>
        <string>aL3dF5</string>
      </value>
    </param>
    <param>
      <value>
        <string>123456789874561</string>
      </value>
    </param>
    <param>
      <value>
        <string>8211da11-1a22-42d5-b3c9-1fbd1c56f787</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20180730T11:59:20</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>01d123f5a220b73d4cf7845656b1cb4fb22c85f3</string>
      </value>
    </param>
  </params>
</methodCall>

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

clientTransactionID

string

Echo

serverTransactionID

string

Transaction ID number generated by Paymentology

prefix

string

The salutation for the bearer (eg Mr, Mrs, Miss)

firstName

string

The first name of the bearer

middleName

string

The middle name of the bearer

lastName

string

The last name of the bearer

idNumber

string

The identification number for the bearer

mobilePhoneArea

string

The Mobile Phone Area of the bearer

mobilePhoneNumber

string

The Mobile Phone Number of the bearer

screeningRequested

integer

Indicator for whether screening was requested (1 if requested)

screeningResultCode

integer

Status code indicating screening result

screeningResultText

string

Text indicating screening result

image

string

The KYC Image for the Bearer

<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>mobilePhoneArea</name>
            <value>
              <string>2710</string>
            </value>
          </member>
          <member>
            <name>screeningResultCode</name>
            <value>
              <int>0</int>
            </value>
          </member>
          <member>
            <name>screeningRequested</name>
            <value>
              <int>0</int>
            </value>
          </member>
          <member>
            <name>customerReference</name>
            <value>
              <string>aL3dF5</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>Success</string>
            </value>
          </member>
          <member>
            <name>firstName</name>
            <value>
              <string>TTKTest</string>
            </value>
          </member>
          <member>
            <name>screeningResultText</name>
            <value>
              <string>Screening not requested</string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>4D123F5F-456D-034A-6D88FFED928B12E0</string>
            </value>
          </member>
          <member>
            <name>idNumber</name>
            <value>
              <string>12346543789</string>
            </value>
          </member>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>8211da11-1a22-42d5-b3c9-1fbd1c56f787</string>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>terminalID</name>
            <value>
              <string>1234567890</string>
            </value>
          </member>
          <member>
            <name>middleName</name>
            <value>
              <string/>
            </value>
          </member>
          <member>
            <name>mobilePhoneNumber</name>
            <value>
              <string>12345670</string>
            </value>
          </member>
          <member>
            <name>image</name>
            <value>
              <string/>
            </value>
          </member>
          <member>
            <name>prefix</name>
            <value>
              <string/>
            </value>
          </member>
          <member>
            <name>lastName</name>
            <value>
              <string>Zen</string>
            </value>
          </member>
          <member>
            <name>trackingNumber</name>
            <value>
              <string>123456789874561</string>
            </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.