v1

latestOpenAPI 3.0.32026-07-1311117.0 KB

Get a balance

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

post/customs/guarantees/{grn}/balance

Path parameters

grnstring required

The guarantee reference number (GRN) of the guarantee.

Headers

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.

Request body

accessCodestring required

The accessCode granting access to make use of the guarantee.

Response

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.

All 1 operations