CTC Guarantee Balance API phase 5 service guide
Learn how to use CTC Guarantee Balance API v2.0 with your software.
The CTC Guarantee Balance API is based on REST principles with an endpoint that returns data in JSON format and it uses standard HTTP error response codes.
Use the API to provide traders with up-to-date information about how much of their guarantee funds they have left to use when organising transit movements. Goods can be delayed if a trader’s guarantee balance does not contain sufficient funds.
The API does not provide real-time data about a trader’s guarantee balance. Instead, the API provides a snapshot of the guarantee state at the time when a request is submitted. It is possible that a short delay could coincide with events that could change the trader’s balance information. Guarantee balance responses for a trader could become out of date quickly if the trader has a lot of transit movements progressing at the same time.
The API endpoint relates only to Great Britain and Northern Ireland. You can also use the HMRC sandbox environment to run tests for Great Britain and Northern Ireland transit movements.
You can use the API on its own or you can use it with the CTC Traders API v2.0, which enables your software to send departure and arrival movement notifications to the New Computerised Transit System (NCTS) and get messages sent from customs offices of departure and destination.
NCTS guarantees explained
If a trader moves goods between the UK and other countries that are part of the Common Transit Convention (CTC), their transit movements must have the appropriate guarantee funds to cover eventualities, such as the loss of goods during transit.
Consequently, each transit declaration sent to the NCTS must include guarantee details. The NCTS checks the guarantee reference number (GRN) quoted against the declared access code. Any validation failures will cause a declaration to be rejected.
You can use more than one guarantee for a transit declaration if they are not comprehensive guarantees or guarantee waivers. A comprehensive guarantee or guarantee waiver that is not sufficient to cover a movement may be topped up by using an individual guarantee or vouchers.
For more information, see HMRC guidance about NCTS guarantees.
This version of the CTC Guarantee Balance API:
- supports only NCTS phase 5 (CTC Guarantee Balance API v1.0 supports only NCTS phase 4)
- is ready for testing
- will not be ready for use in production until phase 5 goes live - in the meantime, you should continue using CTC Guarantee Balance API v1.0
Learn how to get started with the CTC Guarantee Balance API.
If you are new to the NCTS, you should review all of this document before reviewing other documents for phase 5. If you are migrating from NCTS phase 4 to phase 5, you should review this section at least before reviewing other documents for phase 5.
Before you start
Before you start using the Guarantee Balance API, you should:
- ensure that you have an HMRC developer account - if you don’t have one, you must register for an account, activate it by email, and sign in
- add your subscription to this API to your application
- learn about the user-restricted authentication used by the API
- create an application in our sandbox environment
- use the Create Test User API to create one or more test users for your sandbox application
- download NCTS-P5 reference data that can be used for testing
- read the testing guide (pending) to check that your software is compatible with this version of the API and to learn how to test your application in the sandbox environment
Note: If you want to test the API before the testing guide is published, please see Submit a guarantee balance request.
Production environment requirements
Before you can use the production environment for the CTC Guarantee Balance API, you must:
- complete the CTC Guarantee Balance API Application for Production Credentials Checklist (pending)
- use your developer account to apply for production credentials
Get your customers ready
If you work for a software house, each trader you serve must use the Government Gateway to sign up to the CTC Traders API and provide you with the following:
- GB Economic Operators Registration and Identification (EORI) number
- VAT details (optional)
- Standard Industrial Classification (SIC) code
- company or organisation details:
- unique tax reference (UTR) number
- registered company name (this must be an exact match)
- registered company address
- date of company establishment
- email address
- contact details
These journeys show examples of use:
The process flow of a guarantee query check is in the NCTS Phase 5 Technical Interface Specification.
- CTC Guarantee Balance API roadmap (pending)
- CTC Guarantee Balance API v2.0 documentation
- CTC Guarantee Balance API v2.0 reference
- CTC Guarantee Balance API v2.0 changelog (GitHub)
- CTC Guarantee Balance API phase 5 testing guide (pending)
- CTC Traders API v2.0 documentation
Getting help and support
Before contacting us, find out if there is planned API downtime or a technical issue by checking HMRC API Platform Status and New Computerised Transit System service availability.
If you have specific questions about the CTC Guarantee Balance API, contact our Software Developer Support (SDS) Team. You’ll get an initial response within 2 working days.
You can also email questions to SDSTeam@hmrc.gov.uk. We might ask for more detailed information when we respond.
You can find the changelog for this document in the ctc-guarantee-balance-phase5-service-guide GitHub wiki.