Get credit balance

Check your current credit balance instantly.

The GET Balance endpoint allows customers to review their current credit balance within the FincoEnergies platform. This feature provides users with real-time access to their available credits, enabling better management and planning of insetting activities. With this endpoint, you'll be able to monitor your credit usage and ensure you have sufficient balance for upcoming transactions.

Default request:

Parameters (optional)

• 'ProductID' - allows the user to filter on a specific ProductID

Body request:

• No input fields required. 

Default response:

200: Default response

{
  "Message": "Response message",
  "Balance": [
    {
      "ProductID": "GS001",
      "Name": "GoodShipping Ocean",
      "Brand": "GoodShipping",
      "TotalAmountOfWtWCredits": 87,
      "TotalAmountOfTtWCredits": 87.78,
      "TotalAmountOfCredits": 0,
      "TotalEnergyContentMJ": 1133525.99,
      "TotalBiofuelVolumeM3": 34.33
    }
  ]
}

404: Not found error response

{
  "error": "No Balances found."
}

422: Validation error response

{
  "error": "Description of validation error."
}

500: Integration layer - Default error response

{
  "error": "Description of the error(s) that occurred."
}

504: Timeout error response

{
  "error": "Timeout waiting for response"
}