VasTransferFunds

Transfer funds from a card for a VAS transaction.

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

Profile number linked with this card.

cardIdentifier

string,  required

The card number, tracking number, or sequence number of the card to load.

requestAmount

integer,  required

The requested amount to be deducted from the card, in cents.

redemptionType

string,  required

Redemption type of the VAS transaction.

transactionType

string,  required

Type of VAS transaction.

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-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key.

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>VasTransferFunds</methodName>
  <params>
    <param>
      <value>
        <string>1234567890</string>
      </value>
    </param>
    <param>
      <value>
        <string>PROF12345</string>
      </value>
    </param>
    <param>
      <value>
        <string>4111111111111111</string>
      </value>
    </param>
    <param>
      <value>
        <int>10000</int>
      </value>
    </param>
    <param>
      <value>
        <string>VAS1</string>
      </value>
    </param>
    <param>
      <value>
        <string>AIRTIME</string>
      </value>
    </param>
    <param>
      <value>
        <string>TXN202505230001</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20250523T05:06:12</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>ef3c2-5db9e-dsd87-f9a6bc</string>
      </value>
    </param>
  </params>
</methodCall>

 

Response

STATUS200 OK

Schema

terminalID

string

Echo of the incoming terminalID.

profileNumber

string

Echo of the incoming profileNumber.

cardIdentifier

string

Echo of the incoming cardIdentifier.

clientTransactionID

string

Echo of the incoming transactionID value.

serverTransactionID

string

Transaction ID generated by Paymentology.

transactionReference

string

Unique reference number for the VAS transaction.

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>terminalID</name>
            <value>
              <string>1234567890</string>
            </value>
          </member>
          <member>
            <name>profileNumber</name>
            <value>
              <string>PROF12345</string>
            </value>
          </member>
          <member>
            <name>cardIdentifier</name>
            <value>
              <string>4111111111111111</string>
            </value>
          </member>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>TXN202505230001</string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>PT12345678901</string>
            </value>
          </member>
          <member>
            <name>transactionReference</name>
            <value>
              <string>VAS202505230001</string>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>0</int>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>Transaction Approved</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.