Request structure and validation
The specification separates organisation and submission information from recipient details. It uses a basis year for accrued income, original or amendment batch indicators, record counts and commission totals. The validateOnly flag distinguishes checking data from submitting it. JSON field names are case-sensitive, and required properties, identifiers and date formats must match the specified schema. The November 2021 update adds validation for the M-series FIN.
Responses and version control
Successful processing returns an acknowledgement; failed requests provide diagnostic and affected-record information. The document requires sandbox testing before production subscription and describes application credentials separately from user authority. It is a dated interface specification, not evidence that its endpoints, authentication or data types remain unchanged. Use the applicable current specification when implementing software, and retain the acknowledgement and reconciliation totals for an actual submission.
Official source
A concise, independent Apex Gateway guide based on the official English source, not a reproduction of the complete document. Consult the original for full conditions, exceptions and subsequent updates.
Read the official PDF ↗