Balance Inquiry

Balance Inquiry

Field NameLenTypeReqVerComments
methodN/AAlp-NumYes1.0balanceInquiry
fromEmailN/AAlp-NumYes1.0The email address used during login
accountIdN/ANum--1.0The ID of the account (optional, if ommited all balances are returned)
keyN/AAlp-NumYes1.0MD5(sharedSecret + accountId)

This request is responded by a message with the following content:

Field NameLenTypeMdtVerComments
ResponseCodeN/AAlp-NumYes1.0The response code; 00 = Success;
ResponseDescriptionN/AAlp-NumYes1.0Human readable response
FeeN/ARealYes1.0Fee for the current transaction
Account/ AccountIdN/ANumYes1.0The ID of the account for which the balance was requested
Account/ AccountNumberN/AAlp-NumYes1.0The number of the account for which the balance was requested
Account/ AccountNameN/AAlpYes1.1The name of the account for which the balance was requested
Account/ TypeN/ANumYes1.0Account type: 1001 = Checking; 2002 = Card Account;
Account/ BalanceN/ARealYes1.0The balance of the account
Account/ Currency3AlpYes1.0The three letters currency code

Request Sample:

https://secure.paxum.com/payment/api/paymentAPI.php
POST
method=balanceInquiry&fromEmail=[email protected]&accountId=21312434344&key=1060b7b46a3bd36b3a0d66e0127d0517

Response Sample

<?xml version="1.0"?>
<Response>
    <Environment>PRODUCTION</Environment>
    <Method>balanceInquiry</Method>
    <ResponseCode>00</ResponseCode>
    <ResponseDescription>Approved or Completed Successfully</ResponseDescription >
    <Fee>0.00</Fee>
    <Accounts>
    <Account>
    <AccountId>21312434344</AccountId>
    <AccountNumber>2511.USD.CHQ.123456</AccountNumber>
    <AccountName>Checking USD</AccountName>
    <Balance>3254.17</Balance>
    <Type>1001</Type>
    <Currency>USD</Currency>
    </Account>
    </Accounts>
</Response>

Request Sample #2:

https://secure.paxum.com/payment/api/paymentAPI.php
POST
method=balanceInquiry&fromEmail=[email protected]&key=1060b7b46a3bd36b3a0d66e0127d0517

Response Sample

<?xml version="1.0"?>
<Response>
    <Environment>PRODUCTION</Environment>
    <Method>balanceInquiry</Method>
    <ResponseCode>00</ResponseCode>
    <ResponseDescription>Approved or Completed Successfully</ResponseDescription >
    <Fee>0.00</Fee>
    <Accounts>
    <Account>
    <AccountId>21312434344</AccountId>
    <AccountNumber>2511.USD.CHQ.123456</AccountNumber>
    <AccountName>Checking USD</AccountName>
    <Balance>3254.17</Balance>
    <Type>1001</Type>
    <Currency>USD</Currency>
    </Account>
    <Account>
    <AccountId>3267238388</AccountId>
    <AccountNumber>2511.USD.MC.123456</AccountNumber>
    <AccountName>Card USD</AccountName>
    <Balance>250.00</Balance>
    <Type>2002</Type>
    <Currency>USD</Currency>
    </Account>
    ...
    </Accounts>
</Response>

Working Sample(s):

balanceInquiry.php