Address Inquiry

Address Inquiry

Field NameLenTypeReqVerComments
methodN/AAlp-NumYes1.1addressInquiry
fromEmailN/AAlp-NumYes1.1The email associated with your account
addressIdN/ANum--1.1The ID associated with the address that you want to see (optional)
keyN/AAlp-NumYes1.1MD5(sharedSecret + addressId)

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

Field NameLenTypeMdtVerComments
ResponseCodeN/AAlp-NumYes1.1The response code; 00 = Success;
ResponseDescriptionN/AAlp-NumYes1.1Human readable response
FeeN/ARealYes1.1Fee for the current transaction
Addresses / Address / AddressIdN/ANumYes1.1The ID associated with the address
Addresses / Address / AddressType1NumYes1.1The Address type
1 = Home
2 = Bussiness
3 = Home and Business
Addresses / Address / Address1N/AAlp-Num--1.1Street address 1
Addresses / Address / Address2N/AAlp-Num--1.1Street address 2
Addresses / Address / CityN/AAlpYes1.1City address
Addresses / Address / StateCode2/3Alp-NumYes1.1State address (ISO 3166-2)
Addresses / Address / CountryCode2AlpYes1.1Country address (ISO Char 2 Code)
Addresses / Address / PostalCodeN/AAlp-NumYes1.1Zip / Postal Code
Addresses / Address / Confirmed1NumYes1.10 = not confirmed
1 = confirmed
Addresses / Address / StreetName1Num--1.2Street Name
Addresses / Address / StreetNumber1Num--1.2Street Number
Addresses / Address / Building1Num--1.2Building
Addresses / Address / Entrance1Num--1.2Entrance
Addresses / Address / Floor1Num--1.2Floor
Addresses / Address / Apartment1Num--1.2Apartment
Addresses / Address / District1Num--1.2District

Request Sample:

https://secure.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