
Here you can upload documents
| Field Name | Len | Type | Req | Ver | Comments |
|---|---|---|---|---|---|
| method | N/A | Alp | Yes | 1.2 | uploadDocument |
| fromEmail | N/A | Alp-Num | Yes | 1.2 | The email associated with the account from which the authorize is made |
| type | N/A | Num | Yes | 1.2 | Document Type |
| file | N/A | Alp-Num | Yes | 1.2 | The scan of the document coded in BASE64 |
| fileType | N/A | Alp | Yes | 1.2 | File extension |
| toEmail | N/A | Alp-Num | Yes | 1.2 | Customer's Email |
| issuingCountry | 2 | Alp-Num | -- | 1.2 | Document's Issuing Country - two letters country code (ISO Char 2 Code) |
| issuingState | 2/3 | Alp | -- | 1.2 | Document's Issuing state two - three letters state / province / county code (ISO 3166-2) |
| issuingAuthority | N/A | Alp-Num | -- | 1.2 | Document's Issuing Authority |
| issuedDate | 10 | Date | -- | 1.2 | Document's Issuing Date |
| expiryDate | 10 | Date | -- | 1.2 | Document's Issuing Expiry Date |
| series | N/A | Alp-Num | -- | 1.2 | Document's Issuing Series |
| number | N/A | Num | -- | 1.2 | Document's Issuing Number |
| addressId | N/A | Num | -- | 1.2 | Customer Address ID. If this param is sent it will validate Customer's Adress otherwise Customer's Identity. For mor infos look at samples. |
| key | N/A | Alp-Num | Yes | 1.2 | MD5(sharedSecret + type + file + fileType + toEmail + issuingCountry + issuingState + issuingAuthority + issuedDate + expiryDate + series + number + 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.2 | The response code; 00 = Success; |
| ResponseDescription | N/A | Alp-Num | Yes | 1.2 | Human readable response |
| Fee | N/A | Real | Yes | 1.2 | Fee for the current transaction |
Request Sample:
https://secure.paxum.com/payment/api/paymentAPI.php
POST
method=uploadDocument&fromEmail=payee%40domain.com&type=3&file=...&fileType=jpg&toEmail=username%40domain.com&issuingCountry=US&issuingState=NY&issuingAuthority=issuing_authority&issuedDate=2012-02-02&expiryDate=2014-02-02&series=series&number=123465
Response Sample
<?xml version="1.0"?>
<Response>
<Environment>PRODUCTION</Environment>
<Method>uploadDocument</Method>
<ResponseCode>00</ResponseCode>
<ResponseDescription>Approved or Completed Successfully</ResponseDescription >
<Fee>0.00</Fee>
</Response>
Working Sample(s):
uploadDocument.php