Onyx Commission Export

Modified on: Fri, 5 Sep, 2025 at 7:47 AM

Applies to:          Stayntouch PMS          

Onyx Commission Export


TABLE OF CONTENTS

SETUP ONYX CONNECTION


The Onyx Commissions Export is only available when the interface is activated from Settings > Integrations > Commissions > Onyx. The credentials, including SFTP details, brand ID, and file path are to be provided by the Onyx Account Manager. Once set up, Onyx files are exported to an SFTP folder.



Search functionality for Travel Agent name, IATA number, and city is provided. Filters provided are from/to date range, min. amount, and name/amount sorting. 


An INCLUDE NON-COMMISSIONABLE BILLS checkbox is an optional selection, which will include non-commissionable records when required. This checkbox will be enabled in default when the Onyx interface is enabled. When Onyx is enabled, the Onyx Commission Export Type will be selected by default on the EXPORT popup window.


 

The Onyx Commission Export is exported asynchronously and saved in an SFTP location, and is then sent to the recipient address provided via email. The EXPORT button in the popup window will be enabled only if you provide a valid email address in the recipient field. The client can process files from the SFTP location.



The Onyx Commission Export consists of two files:

  • Onyx Payment Record
  • Onyx Property Record

 

Onyx Payment Record

 

This consists of Batch Header, Payment Record, Payment Record Agency Info, Payment Record Processing Info, and Batch Trailer.


 

Onyx Property Record

 

This consists of Batch Header, Property Maintenance, and Batch Trailer.


HOW TO RUN AN ONYX COMMISSION EXPORT


To run this export, navigate to Financials > Commissions to view all commissions pending payment for the selected period.

 

 

 

Select all Travel Agents to see what will be exported.


 

Or choose only from a selection of Travel Agents to hold them for another batch or set to paid if that is the case.

 

 

To view commissionable bills only, filter to exclude NON-COMMISSIONABLE BILLS. By default, it will include commissionable and non-commissionable bills.

 

 

Choose Onyx Commission Export from EXPORT TYPE if you work with Onyx.


 

The arrows (>>) on the right will direct you to the Travel Agent Card.


 

Here you have the same option to put on hold or pay; however, when a reservation is selected, you will also be able to modify the commission amount.


 

IMPORTANT:

  1. After completing the export, mark all the records included in the export as paid to exclude from the next export.
  2. The Travel Agent Card must be set up correctly with an address, state code, and IATA number; otherwise, the export will be rejected.


When Onyx receives the files, they will then process the commissions.


NOTE: For Onyx integration setup, from Settings > Hotel & Staff > Hotel Details, please make sure the STATE field has only TWO characters, otherwise the entire export will fail. This is not required if the site not using this integration.


AUTOMATE THE ONYX COMMISSION EXPORT


Managing commissions just got easier. You can now set the Onyx Commission Export to automatically send to your configured Onyx SFTP during the End of Day (EOD) process—no manual uploads needed!

 

A new checkbox, SEND DURING EOD, is available from Settings > Integrations > Commissions > Onyx (default = off). When enabled, the Onyx Commission Export is sent automatically during EOD.

 

If the SFTP transfer fails, your EOD process continues uninterrupted.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.