Boarding API
JSON over HTTPS with real-time status polling
Boarding File Upload
Automated file-based boarding via SFTP
Boarding API
The Boarding API is the primary method for boarding merchants. You submit JSON requests over HTTPS and receive real-time status feedback through polling. It does not require SFTP or file encryption infrastructure.
See Board merchants via the Boarding API for the full guide.
Boarding File Upload
XML boarding uses the Boarding File Upload utility, an automated file-based method that supports the full range of operations (create, update, deactivate). You build an XML file, validate it against the Boarding File Upload XSD schema, and upload it via SFTP. Fexco processes the file and returns a confirmation file to your SFTP directory.
See Board merchants via XML for the full guide.
Boarding method comparison
The table below compares both methods across format, authentication, supported operations, and infrastructure requirements.You can use different methods for different operations. For example, you could use the Boarding API for creating and deactivating merchants, and XML for updates.
Next steps
Once you have chosen a method, follow the guide for your boarding method:- Board merchants via the Boarding API: submit boarding requests over HTTPS with real-time status polling.
- Board merchants via XML: build, validate, and upload an XML boarding file via SFTP.
