The P4D API: GetBalance

This function allows you to get your current top-up balance from our system. This is important as you must have sufficient credit in your top-up account in order for the PlaceBooking function to be successful.

Input Fields

Field Name	Required?	Description	Example
ShipAction	YES	This tells our system which function you require	GetBalance
Username	YES	You must specify your username	joebloggs
APIKey	YES	This is available from your Shipping Manager account page	HJ1E6DOTRDXAOL4LWBB

Output Fields

Field Name	Description	Example
ShipAction	Confirmation of the function used	GetBalance
Status	Either Success or Error	Success
RequestDate	The date your request was received (yyyy-mm-dd hh:mm:ss)	2008-01-10 12:15:31
Username	The username used to make the request	joebloggs
Balance	Your current balance in GBP	125.00

Example Input

Array
(
    [ShipAction] => GetBalance
    [Username] => joebloggs
    [APIKey] => HJ1E6DOTRDXAOL4LWBB
)

Example Output

Array
(
    [ShipAction] => GetBalance
    [Status] => Success
    [RequestDate] => 2008-01-10 12:15:31
    [Username] => joebloggs
    [Balance] => 125.00
)