Devalue

Deducts the requested amount from a card, or pocket if specified, with a redemption type of “Devalue”.

Request Path Parameters

ParametertypeLimitsrequiredDescription
terminalIDString10 characters✓The Paymentology issued terminal id of the terminal requesting the transaction
customerReferenceString1-20 characters✓Customer reference linked with this card
trackingNumberString1-20 characters,✓The tracking number of the card to devalue
pocketUUIDString0-255 characters✓UUID of the pocket to devalue if applicable. Else, leave empty.
requestAmountInteger✓The requested amount to be deducted from the card and loaded onto the profile
transactionIDString1-255 characters✓A unique identifier generated by the client, which must not be duplicated over time.
transactionDateDate✓Transaction date generated by the calling client
checksumString✓HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key
<methodCall>
    <methodName>Devalue</methodName>
    <params>
        <param>
            <value>
                <string>0042128722</string>
            </value>
        </param>
        <param>
            <value>
                <string>Tutuka Test</string>
            </value>
        </param>
        <param>
            <value>
                <string>687653400000962</string>
            </value>
        </param>
        <param>
            <value>
                <string  />
            </value>
        </param>
        <param>
            <value>
                <int>1000</int>
            </value>
        </param>
        <param>
            <value>
                <string>4857467</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20161024T17:54:10</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>F6D28CEB84B350FF87F46A9E2169A810A017ABFA</string>
            </value>
        </param>
    </params>
</methodCall>

Response Parameters

FieldtypeDescription
terminalIDStringEcho
customerReferenceStringEcho
trackingNumberStringEcho
pocketUUIDStringEcho
requestAmountIntegerEcho
balanceArrayBalances of pockets linked to the card
clientTransactionIDStringEcho
serverTransactionIDStringTransaction id number generated by Paymentology
authorisationIDStringAuthorization id number generated by Paymentology
resultCodeIntegerStatus code indicating transaction result
resultTextStringStatus text indicating transaction result
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>4857467</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>0042128722</string>
                        </value>
                    </member>
                    <member>
                        <name>requestAmount</name>
                        <value>
                            <int>1000</int>
                        </value>
                    </member>
                    <member>
                        <name>customerReference</name>
                        <value>
                            <string>Tutuka Test</string>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>pocketUUID</name>
                        <value>
                            <string  />
                        </value>
                    </member>
                    <member>
                        <name>authorisationID</name>
                        <value>
                            <string>3070985</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>AA030733-155D-00FA-4DBD67E427F4346D</string>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>687653400000962</string>
                        </value>
                    </member>
                    <member>
                        <name>balance</name>
                        <value>
                            <array>
                                <data>
                                    <value>
                                        <struct>
                                            <member>
                                                <name>currency</name>
                                                <value>
                                                    <string>840</string>
                                                </value>
                                            </member>
                                            <member>
                                                <name>amount</name>
                                                <value>
                                                    <int>4000</int>
                                                </value>
                                            </member>
                                            <member>
                                                <name>pocketUUID</name>
                                                <value>
                                                    <string>CABCCA6F-155D-0028-
                                                        9D9D270F6F1C5369</string>
                                                </value>
                                            </member>
                                        </struct>
                                    </value>
                                </data>
                            </array>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>