Developers / API / Balance Inquiry
Balance inquiry

Balance Inquiry

Balance Inquiry

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.0 balanceInquiry
fromEmail N/A Alp-Num Yes 1.0 The email address used during login
accountId N/A Num -- 1.0 The ID of the account (optional, if ommited all balances are returned)
key N/A Alp-Num Yes 1.0 MD5(sharedSecret + accountId)

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

Field Name Len Type Mdt Ver Comments
ResponseCode N/A Alp-Num Yes 1.0 The response code; 00 = Success;
ResponseDescription N/A Alp-Num Yes 1.0 Human readable response
Fee N/A Real Yes 1.0 Fee for the current transaction
Account/ AccountId N/A Num Yes 1.0 The ID of the account for which the balance was requested
Account/ AccountNumber N/A Alp-Num Yes 1.0 The number of the account for which the balance was requested
Account/ AccountName N/A Alp Yes 1.1 The name of the account for which the balance was requested
Account/ Type N/A Num Yes 1.0 Account type: 1001 = Checking; 2002 = Mastercard;
Account/ Balance N/A Real Yes 1.0 The balance of the account
Account/ Currency 3 Alp Yes 1.0 The three letters currency code

Request Sample:

https://www.paxum.com/payment/api/paymentAPI.php

POST

method=balanceInquiry&fromEmail=payee@domain.com&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://www.paxum.com/payment/api/paymentAPI.php

POST

method=balanceInquiry&fromEmail=payee@domain.com&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>Master Card USD</AccountName>
			<Balance>250.00</Balance>
			<Type>2002</Type>
			<Currency>USD</Currency>
		</Account>
		...
	</Accounts>
</Response>

Working Sample(s):

balanceInquiry.php