Webservice Specifications #
POST: Submit Declaration #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
messageType |
(required) |
Messaging Type. |
Yes |
routeId |
(required) |
Route ID. Used by API developers to match requests and responses. Echoed back in the route_id tag of the response. |
Yes |
attachments |
(required) |
Attachment of files. See details. |
Yes |
Attachment Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
numberoffiles |
(required) |
Number of files for the primary document. |
Yes |
files |
(required) |
Files for the primary document. See details. |
Yes |
Attachment Files Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
File |
(required) |
Files for the primary documents. See details. |
Yes |
File Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
fileName |
(required) |
File name of the attachment. |
Yes |
fileSize |
(required) |
File size of the attachment. |
Yes |
base64 |
(required) |
File content of the attachment. |
Yes |
POST: Submit Supporting Document #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
messageType |
(required) |
Messaging Type. |
Yes |
routeId |
(required) |
Route ID. Used by API developers to match requests and responses. Echoed back in the route_id tag of the response. |
Yes |
attachments |
(required) |
Attachment of files. See details. |
Yes |
Attachment Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
numberoffiles |
(required) |
Number of files for the supporting document. |
Yes |
files |
(required) |
Files for the supporting document. See details. |
Yes |
Attachment Files Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
File |
(required) |
Files for the primary documents. See details. |
Yes |
File Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
fileName |
(required) |
File name of the attachment. |
Yes |
fileSize |
(required) |
File size of the attachment. |
Yes |
base64 |
(required) |
File content of the attachment. |
Yes |
GET: Transaction Status Query #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
documentRefNo |
(required) |
Document reference number to be included in the transaction status query. |
Yes |
transactionId |
(required) |
Transaction id to be included in the transaction status query. |
Yes |
GET: Sub-status Update Query #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
documentRefNo |
(required) |
Document reference number to be included in the transaction status query. |
Yes |
transactionId |
(required) |
Transaction id to be included in the transaction status query. |
Yes |
subStatus |
(required) |
Sub-status update on the submitted query and response received on the transaction query. |
Yes |
GET: Download Response Query #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
documentRefNo |
(required) |
Document reference number to be included in the download files query. |
Yes |
transactionId |
(required) |
Transaction id to be included in the download files query. |
Yes |
GET: Download Response within Transaction Date Range Query #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
fromDate |
(required) |
|
Yes |
toDate |
(required) |
|
Yes |
POST: Submit Response Files #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
messageType |
(required) |
Messaging Type. |
Yes |
routeId |
(required) |
Route ID. Used by API developers to match requests and responses. Echoed back in the route_id tag of the response. |
Yes |
attachments |
(required) |
Attachment of files. See details. |
Yes |
Attachment Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
numberoffiles |
(required) |
Number of files for the response file submission. |
Yes |
files |
(required) |
Files for the response document. See details. |
Yes |
Attachment Files Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
File |
(required) |
Files for the primary documents. See details. |
Yes |
File Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
fileName |
(required) |
File name of the attachment. |
Yes |
fileSize |
(required) |
File size of the attachment. |
Yes |
base64 |
(required) |
File content of the attachment. |
Yes |
GET: Submission Response Query #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
messageType |
(required) |
Messaging Type. |
Yes |
routeId |
(required) |
Route ID. Used by API developers to match requests and responses. Echoed back in the route_id tag of the response. |
Yes |
attachments |
(required) |
Attachment of files. See details. |
Yes |
Attachment Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
numberoffiles |
(required) |
Number of files for the primary document. |
Yes |
files |
(required) |
Files for the response document. See details. |
Yes |
Attachment Files Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
File |
(required) |
Files for the primary documents. See details. |
Yes |
File Query Parameters #
| Parameter | Por defecto | Descripción | Mandatory |
|---|---|---|---|
fileName |
(required) |
File name of the attachment. |
Yes |
fileSize |
(required) |
File size of the attachment. |
Yes |
base64 |
(required) |
File content of the attachment. |
Yes |
English 
Chinese (China) 
Chinese (Hong Kong) 
French 
German 
Italian 
Japanese 
Portuguese 
Romanian 
Slovak 
Spanish (Colombia) 
Spanish (Chile) 
Spanish (Ecuador) 
Spanish (Mexico) 