Status

Retrieve the current status of a card.

Request Path Parameters

Parameter	type	Limits	required	Description
terminalID	String	10 characters	✓	The Paymentology issued terminal ID of the terminal requesting the transaction.
profileNumber	String	1-20 characters	✓	The profile to which the card belongs.
cardIdentifier	String	1-20 characters	✓	The card number, tracking number or sequence number of the card to retrieve the status of.
transactionID	String	1-255 characters	✓	Transaction ID number generated by the calling client.
transactionDate	Date		✓	Transaction date generated by the calling client.
checksum	String		✓	HMAC-SHA1 hashed signature of the concatenated method name with all argument values using the terminal password as private key.

<?xml version="1.0"?>
<methodCall>
  <methodName>Status</methodName>
  <params>
    <param>
      <value>
        <string>2569874521</string>
      </value>
    </param>
    <param>
      <value>
        <string>7654327412</string>
      </value>
    </param>
    <param>
      <value>
        <string>24569874</string>
      </value>
    </param>
    <param>
      <value>
        <string>15432332</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20230228T20:55:45</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>221FA0D339B067055EB4D4A25490775CE2D325BB</string>
      </value>
    </param>
  </params>
</methodCall>

Response Parameters

Parameter	type	Description
expired	Boolean	Is the card expired.
retired	Boolean	Is the card retired.
stopped	Boolean	Is the card stopped.
stolen	Boolean	Is the card stolen.
valid	Boolean	Is the card valid.
cancelled	Boolean	Is the card cancelled.
loaded	Boolean	Has the card been loaded.
lost	Boolean	Is the card marked as lost.
activated	Boolean	Is the card activated.
redeemed	Boolean	Has the card been redeemed.
empty	Boolean	Is the card empty.
pinBlocked	Boolean	Has the PIN code been blocked.
clientTransactionID	String	Echo of the incoming value.
serverTransactionID	Date	Transaction ID generated by Paymentology.
resultCode	Integer	Status code indicating the transaction result.
resultText	String	Text indicating the transaction result.

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>pinBlocked</name>
            <value>
              <string>FALSE</string>
            </value>
          </member>
          <member>
            <name>stolen</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>valid</name>
            <value>
              <string>true</string>
            </value>
          </member>
          <member>
            <name>lost</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>expired</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>OK</string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>7654327412-2S5FA0D339B067055E458DF21490775CE2524SDF</string>
            </value>
          </member>
          <member>
            <name>loaded</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>15432332</string>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>cancelled</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>retired</name>
            <value>
              <string>false</string>
            </value>
          </member>
          <member>
            <name>stopped</name>
            <value>
              <string>true</string>
            </value>
          </member>
          <member>
            <name>activated</name>
            <value>
              <string>true</string>
            </value>
          </member>
          <member>
            <name>empty</name>
            <value>
              <string>true</string>
            </value>
          </member>
          <member>
            <name>redeemed</name>
            <value>
              <string>false</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>