Developers / API / Address Inquiry
Address Inquiry

Address Inquiry

Address Inquiry

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.1 addressInquiry
fromEmail N/A Alp-Num Yes 1.1 The email associated with your account
addressId N/A Num -- 1.1 The ID associated with the address that you want to see (optional)
key N/A Alp-Num Yes 1.1 MD5(sharedSecret + addressId)

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.1 The response code; 00 = Success;
ResponseDescription N/A Alp-Num Yes 1.1 Human readable response
Fee N/A Real Yes 1.1 Fee for the current transaction
Addresses / Address / AddressId N/A Num Yes 1.1 The ID associated with the address
Addresses / Address / AddressType 1 Num Yes 1.1 The Address type
1 = Home
2 = Bussiness
3 = Home and Business
Addresses / Address / Address1 N/A Alp-Num -- 1.1 Street address 1
Addresses / Address / Address2 N/A Alp-Num -- 1.1 Street address 2
Addresses / Address / City N/A Alp Yes 1.1 City address
Addresses / Address / StateCode 2/3 Alp-Num Yes 1.1 State address (ISO 3166-2)
Addresses / Address / CountryCode 2 Alp Yes 1.1 Country address (ISO Char 2 Code)
Addresses / Address / PostalCode N/A Alp-Num Yes 1.1 Zip / Postal Code
Addresses / Address / Confirmed 1 Num Yes 1.1 0 = not confirmed
1 = confirmed
Addresses / Address / StreetName 1 Num -- 1.2 Street Name
Addresses / Address / StreetNumber 1 Num -- 1.2 Street Number
Addresses / Address / Building 1 Num -- 1.2 Building
Addresses / Address / Entrance 1 Num -- 1.2 Entrance
Addresses / Address / Floor 1 Num -- 1.2 Floor
Addresses / Address / Apartment 1 Num -- 1.2 Apartment
Addresses / Address / District 1 Num -- 1.2 District

Request Sample:

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

POST

method=addressInquiry&fromEmail=payee%40domain.com&addressId=2345789&key=7d4420a8b447cb9c3cb1c29bea7ba707

Response Sample

<?xml version="1.0"?>
<Response>
    <Environment>PRODUCTION</Environment>
	<Method>addressInquiry</Method>
	<ResponseCode>00</ResponseCode>
	<ResponseDescription>Approved or Completed Successfully</ResponseDescription >
	<Fee>0.00</Fee>
	<Addresses>
		<Address>
			<AddressId>123456</AddressId>
			<AddressType>1</AddressType>
			<Address1>3484 Des Sources</Address1>
			<Address2>suite 205, Dollard-des-Ormeaux</Address2>
			<City>Quebec</City>
			<StateCode>QC</StateCode>
			<CountryCode>CA</CountryCode>
			<PostalCode>1</PostalCode>
			<Confirmed>0</Confirmed>
		</Address>
		...
	</Addresses>
</Response>

Working Sample(s):

addressInquiry.php