Get a balance

Get the balance associated with a guarantee reference number (GRN).

post/customs/guarantees/{grn}/balance

Request

Base URL
https://test-api.service.hmrc.gov.uk
Auth
OAuth 2
Authorization codehttps://api.service.hmrc.gov.uk/oauth/authorize
Token URLhttps://api.service.hmrc.gov.uk/oauth/token
Scopescommon-transit-convention-guarantee-balance
TypeScript
https://skmtc.dev/hmrc/apis/common-transit-convention-guarantee-balance/docs/customs/guarantees/:grn/balance/post.ts
A function with typed inputs. Its response is checked against the schema.

grnstring required

The guarantee reference number (GRN) of the guarantee.

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Content-Type'application/json' required

The media type of the request body.

accessCodestring required

The accessCode granting access to make use of the guarantee.

A successful balance request response

_linksobject

An object containing links to other resources.

_embeddedobject

An object containing embedded resources.

balancenumber required

The guarantee's balance.

currencystring

The alphanumeric 3-character ISO currency code of the currency in which the balance is held.

No recorded changes to this operation across all 1 revision of this API.