Developers / API / Add Address
Add Address

Add Address

Here you can add an address

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.1 addAddress
fromEmail N/A Alp-Num Yes 1.1 The email associated with the account to wich the address will be added
streetName N/A Alp-Num Yes 1.2 Street Name
streetNumber N/A Alp-Num Yes 1.2 Street Number
building N/A Alp-Num -- 1.2 Building
entrance N/A Alp-Num -- 1.2 Entrance
floor N/A Alp-Num -- 1.2 Floor
apartment N/A Alp-Num -- 1.2 Apartment
district N/A Alp-Num -- 1.2 District
city N/A Alp Yes 1.1 City name
state 2 / 3 Alp Yes 1.1 two - three letters state / province / county code (ISO 3166-2)
country 2 Alp Yes 1.1 two letters country code (ISO Char 2 Code)
postalCode N/A Alp-Num Yes 1.1 Zip / Postal Code
addressStatus N/A Alp-Num Yes 1.1 1 = Home
2 = Business
3 = Home and Business
Key N/A Alp-Num Yes 1.1 MD5(sharedSecret + address + address2 + city + state + country + postalCode + addressStatus)

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
TransactionId N/A Num Yes 1.1 The address ID if successfully, otherwise not specified

Request Sample:

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

POST

method=addAddress&fromEmail=payee%40domain.com&address=address&address2=address2&city=city&state=state&postalCode=postalCode&country=country&addressStatus=1&key=8fdf1160dee568649b63ae10be81d8e6

Response Sample

<?xml version="1.0"?>
<Response>
	<Method>addAddress</Method>
	<ResponseCode>00</ResponseCode>
	<ResponseDescription>Approved or Completed Successfully</ResponseDescription >
	<Fee>0.00</Fee>
	<AddressId>23646236</AddressId>
</Response>

Working Sample(s):

addAddress.php