LoadFunds

Load a card (or pocket if applicable) with the requested amount.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string,  1-20 characters,  required

Customer reference linked with this card

trackingNumber

string,  1-20 characters,  required

The tracking number of the card to either load or to which the pocket belongs

pocketUUID

string,  0-255 characters,  required

The UUID of the type of pocket to load, else empty if not applicable

requestAmount

integer,  required

The requested amount to be loaded on the card (or pocket if applicable)

transactionID

string,  1-255 characters,  required

A unique identifier generated by the client, which must not be duplicated over time.

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  1-255 characters,  required

HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<methodCall>
    <methodName>LoadFunds</methodName>
    <params>
        <param>
            <value>
                <string>0008866376</string>
            </value>
        </param>
        <param>
            <value>
                <string>999000001</string>
            </value>
        </param>
        <param>
            <value>
                <string>953860100000030</string>
            </value>
        </param>
        <param>
            <value>
                <string>NOTUSED</string>
            </value>
        </param>
        <param>
            <value>
                <int>11100</int>
            </value>
        </param>
        <param>
            <value>
                <string>43-load</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20180731T12:50:11</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>E52A8FA98B8827CEBD1A552C9747B5D3C7867E4F</string>
            </value>
        </param>
    </params>
</methodCall>

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

pocketUUID

string

Echo

requestAmount

integer

Echo

balance

array

Balances of pockets linked to the card

clientTransactionID

string

Echo

serverTransactionID

string

Transaction ID number generated by Paymentology

resultCode

integer

Status code indicating transaction result

resultText

string

Status text indicating transaction result

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>43-load</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>0008866376</string>
                        </value>
                    </member>
                    <member>
                        <name>requestAmount</name>
                        <value>
                            <int>11100</int>
                        </value>
                    </member>
                    <member>
                        <name>customerReference</name>
                        <value>
                            <string>999000001</string>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>pocketUUID</name>
                        <value>
                            <string>NOTUSED</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>FBB225EA-155D-00FA-4DB37895FF852B10</string>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>953860100000030</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>293237</int>
                                                </value>
                                            </member>
                                            <member>
                                                <name>pocketUUID</name>
                                                <value>
                                                    <string>11AD7BFC-155D-0028-9D0A7BBD5A6E141E</string>
                                                </value>
                                            </member>
                                        </struct>
                                    </value>
                                </data>
                            </array>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.