Status

Retrieve the current status of a card.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction.

profileNumber

string,  1-20 characters,  required

The profile to which the card belongs.

cardIdentifier

string,  1-20 characters,  required

The card number, tracking number or sequence number of the card to retrieve the status of.

transactionID

string,  1-255 characters,  required

Transaction ID number generated by the calling client.

transactionDate

date,  required

Transaction date generated by the calling client.

checksum

string,  required

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

STATUS200 OK

Schema

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>

 

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.