DeductFunds
Deducts the requested amount from a card, or a pocket if applicable.
Request
Path parameters
string, 10 characters, required
The Paymentology issued terminal ID of the terminal requesting the transaction
string, 1-20 characters, required
Customer reference linked with this card
string, 1-20 characters, required
The tracking number of the card to either deduct the requested amount from or to which the pocket to be deducted belongs to
string, 0-255 characters, required
UUID of the type of pocket to be deducted if applicable. Else leave empty.
integer, required
The requested amount to be deducted from the card or pocket
string, 1-255 characters, required
A unique identifier generated by the client, which must not be duplicated over time.
date, required
Transaction date generated by the calling client
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">DeductFunds</methodName>
<params>
<param>
<value>
<string>1234567890</string>
</value>
</param>
<param>
<value>
<string>987654321</string>
</value>
</param>
<param>
<value>
<string>123456789874561</string>
</value>
</param>
<param>
<value/>
</param>
<param>
<value>
<int>123</int>
</value>
</param>
<param>
<value>
<string>27-deduct</string>
</value>
</param>
<param>
<value>
<dateTime.iso8601>20161006T08:20:58</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>12345A6789876D04BAF654F56B704962326E1234</string>
</value>
</param>
</params>
</methodCall>
Response
STATUS200 OK
Schema
string
Echo
string
Echo
string
Echo
string
Echo
integer
Echo
array
Balances of pockets linked to the card or from the card itself if this campaign has no pocket configurations
string
Echo
string
Transaction ID number generated by Paymentology
integer
Status code indicating transaction result
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>clientTransactionID</name>
<value>
<string>27-deduct</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>requestAmount</name>
<value>
<int>123</int>
</value>
</member>
<member>
<name>customerReference</name>
<value>
<string>987654321</string>
</value>
</member>
<member>
<name>resultText</name>
<value>
<string>Approved</string>
</value>
</member>
<member>
<name>pocketUUID</name>
<value>
<string/>
</value>
</member>
<member>
<name>serverTransactionID</name>
<value>
<string>ABCDE1EB-123D-00FA-4ABC1234567890CC</string>
</value>
</member>
<member>
<name>trackingNumber</name>
<value>
<string>123456789874561</string>
</value>
</member>
<member>
<name>balance</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>currency</name>
<value>
<string>710</string>
</value>
</member>
<member>
<name>amount</name>
<value>
<int>282014</int>
</value>
</member>
<member>
<name>pocketUUID</name>
<value>
<string>12AB3CDE-456F-7890-
9D0A8BBD7A6E141E</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
Was this page helpful?