Getting started
Test environment
To get started you can upload test files by changing the enviornment tag in the filename to TEST from PROD.
The filename is normally
| Enviornment | Filename |
|---|---|
| Test | FT0001.TEST.TEMP.BEVXML(+1) |
| Production | FT0001.PROD.TEMP.BEVXML(+1) |
Authentication
When you order the service you will be provided with connection details as well as a username and password which you will use to authenticate with the service.
The service is a SFTP server so you use the username and password in your SFTP client when you login.
Usage
The Batch API can be used for uploading requests and downloading reports.
Uploading a test document
The following example uploads a file (myrequest.xml) to the test environment.
sftp ... <connection details> put myrequest.xml FT0001.TEST.TEMP.BEVXML(+1) exit |
Uploading a large production document
The following example uploads a large file (myrequest.xml) to the production environment. As the document is large it is first zipped.
zip myrequest.zip myrequest.xml sftp ... <connection details> put myrequest.zip FT0001.PROD.TEMP.BEVXML(+1) exit |
Credit monitoring request
The following example shows an updateType TOTAL with all attributes (such as stock) are set on the root level as opposed to the object level.
<?xmlversion="1.0"encoding="UTF-8"?> <monitoringUpdate userID="99999" stock="YY" updateDate="SSYY-MM-DD" updateType="TOTAL"> <objects> <object> <objectID>5564002931</objectID> <reference>Referens 1</reference> </object> <object> <objectID>5568213283</objectID> <reference>Referens 2</reference> </object> <object> <objectID>5561002345</objectID> <reference>Referens 3</reference> </object> <object> <objectID>5564587073</objectID> <reference>Referens 4</reference> </object> </objects> </monitoringUpdate> |
Credit monitoring request with mixed customer stock
The following example shows an updateType TOTAL with mixed customer stock i.e. some attributes (such as updateDate) are set on the root level and some (such as stock) are set on the object level.
<?xmlversion="1.0"encoding="UTF-8"?> <monitoringUpdate userID="99999" updateDate="SSYY-MM-DD" updateType="TOTAL"> <objects> <object stock="YY"> <objectID>5564002931</objectID> <reference>Referens 1</reference> </object> <object stock="YY"> <objectID>5568213283</objectID> <reference>Referens 2</reference> </object> <object stock="Y1"> <objectID>5561002345</objectID> <reference>Referens 3</reference> </object> <object stock="Y1"> <objectID>5564587073</objectID> <reference>Referens 4</reference> </object> </objects> </monitoringUpdate> |
Credit monitoring request with mixed updateTypes
The following example shows a mixed updateType with attributes (such as stock) are set on the root level as opposed on the object level.
<?xmlversion="1.0"encoding="UTF-8"?> <monitoringUpdate userID="88888" stock="YY" updateDate="SSYY-MM-DD"> <objects> <object updateType="NEW"> <objectID>5564002931</objectID> <reference>Referens 1</reference> </object> <object updateType="REMOVE"> <objectID>5568213283</objectID> <reference>Referens 2</reference> </object> <object updateType="CHANGE"> <objectID>5561002345</objectID> <reference>Referens 3</reference> </object> <object updateType="CHANGE"> <objectID>5564587073</objectID> <reference>Referens 4</reference> </object> </objects> </monitoringUpdate> |
Credit monitoring request with mixed userID
The following example shows a mixed userID.
<?xmlversion="1.0"encoding="UTF-8"?> <monitoringUpdate updateDate="SSYY-MM-DD" updateType="TOTAL"> <objects> <object userID="88888" stock="YY"> <objectID>5564002931</objectID> <reference>Referens 1</reference> </object> <object userID="88888" stock="YY"> <objectID>5568213283</objectID> <reference>Referens 2</reference> </object> <object userID="99999" stock="YY"> <objectID>5561002345</objectID> <reference> </reference> </object> <object userID="99999" stock="YY"> <objectID>5564587073</objectID> <reference> </reference> </object> </objects> </monitoringUpdate> |