Allow user to get their invoice by invoice number

Changelogs

Version	Date	Changes by	Description of change
V1.0	24 Oct 2024	Tam Tran	Added Table of Contents. Added Changelogs.

Order Resource

Registries object

Registry Name

Registries[Name] text

Registry Display Name (IREC | TIGR)

Registries[RegistryFees].FeeName text

Fee Name

Registries[RegistryFees].FeeCode text

Fee Code

Registries[RegistryFees].Currency text

Currency

Registries[RegistryFees].ChargedValue number (18,4)

Charged Value

Registries[RegistryFees].ExternalPaymentValue number (18,4)

External Payment Value

Registries[RegistryFees].MinEnergyValue number (18,4)

Min Energy Value

Registries[RegistryFees].MaxEnergyValue number (18,4)

Max Energy Value

Registries[RegistryFees].FrequencyYear number (18,2)

Frequency Year

Registries[RegistryFees].ChargedBy object

Value: Value of Enum
Description: Description of Enum

Payment Type (PerTransaction, PercentageOfTransaction)

Registries[RegistryFees].CreatedTime datetime

Created Time

Registries[RegistryFees].UpdatedTime datetime

Updated Time

Registries[RegistryFees].HasApplyMinimumBuyerProcessingFee boolean

Minimum Buyer Processing Fee

Registries[IssuerFees].IssuerName text

Issuer Name

Registries[IssuerFees].Fees array[object]

Platform array[object]

Code Block

language	json

{
  "Registries": [
    {
      "Name": "IREC",
      "RegistryFees": [
        {
          "FeeName": "Redemption fee (per MWh) - RECs acquired through REHash",
          "FeeCode": "RECRA",
          "Currency": "EUR",
          "ChargedValue": 0.08,
          "ExternalPaymentValue": 0.08,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "Redemption fee (per MWh) - Self Retirement",
          "FeeCode": "RECRS",
          "Currency": "USD",
          "ChargedValue": 0.4,
          "ExternalPaymentValue": 0.08,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        }
      ],
      "IssuerFees": [
        {
          "IssuerName": "Issuer Org 5E7B2",
          "Fees": [
            {
              "FeeName": "Device Registration from 0 to <250kW",
              "FeeCode": "ASRG",
              "Currency": "EUR",
              "ChargedValue": 0,
              "ExternalPaymentValue": 0,
              "MinEnergyValue": 0,
              "MaxEnergyValue": 0.25,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PerTransaction",
                "Description": "Per Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            },
            {
              "FeeName": "Device Registration from 250kW to < 1MW",
              "FeeCode": "ASRG",
              "Currency": "EUR",
              "ChargedValue": 100,
              "ExternalPaymentValue": 100,
              "MinEnergyValue": 0.25,
              "MaxEnergyValue": 1,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PerTransaction",
                "Description": "Per Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            },
            {
              "FeeName": "Device Registration from 1 to < 3MW",
              "FeeCode": "ASRG",
              "Currency": "EUR",
              "ChargedValue": 500,
              "ExternalPaymentValue": 500,
              "MinEnergyValue": 1,
              "MaxEnergyValue": 3,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PerTransaction",
                "Description": "Per Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            },
            {
              "FeeName": "Device Registration >= 3MW",
              "FeeCode": "ASRG",
              "Currency": "EUR",
              "ChargedValue": 1000,
              "ExternalPaymentValue": 1000,
              "MinEnergyValue": 3,
              "MaxEnergyValue": null,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PerTransaction",
                "Description": "Per Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            },
            {
              "FeeName": "Device renewal fee after 5-year validity",
              "FeeCode": "ASRN",
              "Currency": "EUR",
              "ChargedValue": 0.4,
              "ExternalPaymentValue": 0.4,
              "MinEnergyValue": 1,
              "MaxEnergyValue": 1,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PercentageOfTransaction",
                "Description": "Percentage Of Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            },
            {
              "FeeName": "Issuance fee (per MWh)",
              "FeeCode": "RECR",
              "Currency": "EUR",
              "ChargedValue": 0.025,
              "ExternalPaymentValue": 0.025,
              "MinEnergyValue": 1,
              "MaxEnergyValue": 1,
              "FrequencyYear": 0,
              "ChargedBy": {
                "Value": "PerTransaction",
                "Description": "Per Transaction"
              },
              "CreatedTime": "2024-07-08T05:08:21.51",
              "UpdatedTime": "2024-07-08T05:08:21.51",
              "HasApplyMinimumBuyerProcessingFee": true
            }
          ]
        }
      ]
    },
    {
      "Name": "TIGR",
      "RegistryFees": [
        {
          "FeeName": "Asset Registration <0.25 MWp",
          "FeeCode": "ASRG",
          "Currency": "USD",
          "ChargedValue": 100,
          "ExternalPaymentValue": 100,
          "MinEnergyValue": 0,
          "MaxEnergyValue": 0.25,
          "FrequencyYear": 1,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "Asset Registration from 0.25 to <1 MWp",
          "FeeCode": "ASRG",
          "Currency": "USD",
          "ChargedValue": 200,
          "ExternalPaymentValue": 200,
          "MinEnergyValue": 0.25,
          "MaxEnergyValue": 1,
          "FrequencyYear": 1,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "Asset Registration from 1 to <10 MWp",
          "FeeCode": "ASRG",
          "Currency": "USD",
          "ChargedValue": 500,
          "ExternalPaymentValue": 500,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 10,
          "FrequencyYear": 1,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "Asset Registration >=10 MWp",
          "FeeCode": "ASRG",
          "Currency": "USD",
          "ChargedValue": 1000,
          "ExternalPaymentValue": 1000,
          "MinEnergyValue": 10,
          "MaxEnergyValue": null,
          "FrequencyYear": 1,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "QRE Validation Fee",
          "FeeCode": "QREV",
          "Currency": "USD",
          "ChargedValue": 500,
          "ExternalPaymentValue": 500,
          "MinEnergyValue": null,
          "MaxEnergyValue": null,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "REC Import",
          "FeeCode": "RECL",
          "Currency": "USD",
          "ChargedValue": 0.01,
          "ExternalPaymentValue": 0.01,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "REC Registration",
          "FeeCode": "RECR",
          "Currency": "USD",
          "ChargedValue": 0.03,
          "ExternalPaymentValue": 0.03,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "Redemption fee (per MWh) - RECs acquired through REHash",
          "FeeCode": "RECRA",
          "Currency": "USD",
          "ChargedValue": 0.03,
          "ExternalPaymentValue": 0.03,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        },
        {
          "FeeName": "All-In Fee for REC Self-Consumption Redemption",
          "FeeCode": "RECRS",
          "Currency": "USD",
          "ChargedValue": 0.4,
          "ExternalPaymentValue": 0.03,
          "MinEnergyValue": 1,
          "MaxEnergyValue": 1,
          "FrequencyYear": 0,
          "ChargedBy": {
            "Value": "PerTransaction",
            "Description": "Per Transaction"
          },
          "CreatedTime": "2024-07-08T05:08:21.51",
          "UpdatedTime": "2024-07-08T05:08:21.51",
          "HasApplyMinimumBuyerProcessingFee": true
        }
      ],
      "IssuerFees": null
    }
  ],
  "Platform": [
    {
      "FeeName": "Seller Processing Fee",
      "FeeCode": "RECT",
      "Currency": "USD",
      "ChargedValue": 0.01,
      "ExternalPaymentValue": 0,
      "MinEnergyValue": 1,
      "MaxEnergyValue": null,
      "FrequencyYear": 0,
      "ChargedBy": {
        "Value": "PercentageOfTransaction",
        "Description": "Percentage Of Transaction"
      },
      "CreatedTime": "2024-07-08T05:08:21.51",
      "UpdatedTime": "2024-07-08T05:08:21.51",
      "HasApplyMinimumBuyerProcessingFee": true
    },
    {
      "FeeName": "Buyer Processing Fee",
      "FeeCode": "RECB",
      "Currency": "USD",
      "ChargedValue": 0.01,
      "ExternalPaymentValue": 0,
      "MinEnergyValue": 1,
      "MaxEnergyValue": null,
      "FrequencyYear": 0,
      "ChargedBy": {
        "Value": "PercentageOfTransaction",
        "Description": "Percentage Of Transaction"
      },
      "CreatedTime": "2024-07-08T05:08:21.51",
      "UpdatedTime": "2024-07-08T05:08:21.51",
      "HasApplyMinimumBuyerProcessingFee": true
    },
    {
      "FeeName": "Trading Import Fee (per MWh)",
      "FeeCode": "RECTPI",
      "Currency": "USD",
      "ChargedValue": 0.02,
      "ExternalPaymentValue": 0,
      "MinEnergyValue": 1,
      "MaxEnergyValue": null,
      "FrequencyYear": 0,
      "ChargedBy": {
        "Value": "PercentageOfTransaction",
        "Description": "Percentage Of Transaction"
      },
      "CreatedTime": "2024-07-08T05:08:21.51",
      "UpdatedTime": "2024-07-08T05:08:21.51",
      "HasApplyMinimumBuyerProcessingFee": true
    },
    {
      "FeeName": "Origination Fee (per MWh)",
      "FeeCode": "RECTPO",
      "Currency": "USD",
      "ChargedValue": 0.08,
      "ExternalPaymentValue": 0,
      "MinEnergyValue": 1,
      "MaxEnergyValue": null,
      "FrequencyYear": 0,
      "ChargedBy": {
        "Value": "PercentageOfTransaction",
        "Description": "Percentage Of Transaction"
      },
      "CreatedTime": "2024-07-08T05:08:21.51",
      "UpdatedTime": "2024-07-08T05:08:21.51",
      "HasApplyMinimumBuyerProcessingFee": true
    },
    {
      "FeeName": "REC Export Fee of Device Registered in REHash (MWh)",
      "FeeCode": "RECTO",
      "Currency": "USD",
      "ChargedValue": 0.8,
      "ExternalPaymentValue": 0,
      "MinEnergyValue": 1,
      "MaxEnergyValue": 1,
      "FrequencyYear": 0,
      "ChargedBy": {
        "Value": "PerTransaction",
        "Description": "Per Transaction"
      },
      "CreatedTime": "2024-07-08T05:08:21.51",
      "UpdatedTime": "2024-07-08T05:08:21.51",
      "HasApplyMinimumBuyerProcessingFee": true
    }
  ]
}

API Definition

Status

colour	Green
title	GET

public/v2/fee-agreements

Request

Headers

Content-Type	`application/json`
Authorization	`Bearer {{access_token}}`

Query Parameters

InvoiceNumber - text

The Invoice Number of Invoice

Registry (optional) enum

(IREC, TIGR)

Code Block
curl --location 'https://uat-api.redex.eco/public/v2/invoices/INV-REAR-2024-09-27-00006' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {{access_token}}'

Response

Response Body

Data object collection - Order Resource

A collection of objects - Order Resource

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 400, 422.

http状态码，如200，201，400, 422

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info
200 Success

Code Block

language	json

{
 
  "Data": {
 
      "InvoiceNumberRegistries": "INV-REAR-2024-09-27-00006",[
      {
 "Quantity": 20.000000,
        "IssuedDateName": "2024-09-27T00:00:00.0000000ZIREC",
        "DueDateRegistryFees": "2024-10-01T15:59:59.9999999Z", [
          {
  "PaidDate": null,         "StatusFeeName": {"Redemption fee (per MWh) - RECs acquired through REHash",
    "Value": "Unpaid",
            "DescriptionFeeCode": "Unpaid"
    RECRA",
   },         "CreatedTimeCurrency": "2024-09-27T16:30:14.693EUR",
            "UpdatedTimeChargedValue": "2024-09-27T16:30:14.693"0.08,
            "CurrencyCodeExternalPaymentValue": "USD",0.08,
            "FeeCodeNumberMinEnergyValue": null1,
            "PayerTaxPercentageMaxEnergyValue": 0.0000,1,
            "PayeeTaxPercentageFrequencyYear": 0.0000,
            "PayerChargedBy": {
              "CompanyNameValue": "1234PerTransaction",
              "RegistrationNumberDescription": "1234Per Transaction",
            "Address": "zxcvb"},
            "CountryCreatedTime": "Åland Islands"
2024-07-08T05:08:21.51",
       },         "PayeeUpdatedTime": {"2024-07-08T05:08:21.51",
            "CompanyNameHasApplyMinimumBuyerProcessingFee": "REDEX Pte. Ltd.", true
          },
         "RegistrationNumber": "201834016K", {
            "AddressFeeName": "Blk 71 Ayer Rajah CrescentRedemption fee (per MWh) - Self Retirement",
            "CountryFeeCode": "SingaporeRECRS",
        },         "MainInvoiceCurrency": {"USD",
            "TotalChargedValue": 400.004,
            "SubTotalExternalPaymentValue": 400.0008,
            "PayeeTaxAmountMinEnergyValue": 0.001,
            "PayerTaxAmountMaxEnergyValue": 0.001,
            "ItemsFrequencyYear": [0,
            "ChargedBy": {
        {      "Value": "PerTransaction",
              "QuantityDescription": 20.000000, "Per Transaction"
            },
            "UnitPriceCreatedTime": 1.50,"2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "TotalPriceHasApplyMinimumBuyerProcessingFee": 30.00,true
          }
        ],
 "Description": "Singapore v2024 Solar I-REC (Bid 20 Qty @ USD 1.5000)",       "IssuerFees": [
          {
            "TransactionDateIssuerName": "2024-09-27T08:15:35.4800000Z",
       Issuer Org 5E7B2",
            "TransactionIdFees": "EX2024092708153565670626"[
              {
 },               "FeeName": "Device {Registration from 0 to <250kW",
                "QuantityFeeCode": 1.000000,
   "ASRG",
                "UnitPriceCurrency": 10.00,
 "EUR",
                  "TotalPriceChargedValue": 10.000,
                "ExternalPaymentValue": 0,
  "Description": "Buyer Processing Fee (Min USD 10.00)",
               "MinEnergyValue": 0,
                "MaxEnergyValue": 0.25,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "TransactionDateValue": "2024-09-27T16:30:14.7000000Z",
 PerTransaction",
                  "Description": "Per Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              },
              {
                "FeeName": "Device Registration from 250kW to < 1MW",
                "FeeCode": "ASRG",
                "Currency": "EUR",
                "ChargedValue": 100,
                "ExternalPaymentValue": 100,
                "MinEnergyValue": 0.25,
                "MaxEnergyValue": 1,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "Value": "PerTransaction",
                  "Description": "Per Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              },
              {
                "FeeName": "Device Registration from 1 to < 3MW",
                "FeeCode": "ASRG",
                "Currency": "EUR",
                "ChargedValue": 500,
                "ExternalPaymentValue": 500,
                "MinEnergyValue": 1,
                "MaxEnergyValue": 3,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "Value": "PerTransaction",
                  "Description": "Per Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              },
              {
                "FeeName": "Device Registration >= 3MW",
                "FeeCode": "ASRG",
                "Currency": "EUR",
                "ChargedValue": 1000,
                "ExternalPaymentValue": 1000,
                "MinEnergyValue": 3,
                "MaxEnergyValue": null,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "Value": "PerTransaction",
                  "Description": "Per Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              },
              {
                "FeeName": "Device renewal fee after 5-year validity",
                "FeeCode": "ASRN",
                "Currency": "EUR",
                "ChargedValue": 0.4,
                "ExternalPaymentValue": 0.4,
                "MinEnergyValue": 1,
                "MaxEnergyValue": 1,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "Value": "PercentageOfTransaction",
                  "Description": "Percentage Of Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              },
              {
                "FeeName": "Issuance fee (per MWh)",
                "FeeCode": "RECR",
                "Currency": "EUR",
                "ChargedValue": 0.025,
                "ExternalPaymentValue": 0.025,
                "MinEnergyValue": 1,
                "MaxEnergyValue": 1,
                "FrequencyYear": 0,
                "ChargedBy": {
                  "Value": "PerTransaction",
                  "Description": "Per Transaction"
                },
                "CreatedTime": "2024-07-08T05:08:21.51",
                "UpdatedTime": "2024-07-08T05:08:21.51",
                "HasApplyMinimumBuyerProcessingFee": true
              }
            ]
          }
        ]
      },
      {
        "Name": "TIGR",
        "RegistryFees": [
          {
            "FeeName": "Asset Registration <0.25 MWp",
            "FeeCode": "ASRG",
            "Currency": "USD",
            "ChargedValue": 100,
            "ExternalPaymentValue": 100,
            "MinEnergyValue": 0,
            "MaxEnergyValue": 0.25,
            "FrequencyYear": 1,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "Asset Registration from 0.25 to <1 MWp",
            "FeeCode": "ASRG",
            "Currency": "USD",
            "ChargedValue": 200,
            "ExternalPaymentValue": 200,
            "MinEnergyValue": 0.25,
            "MaxEnergyValue": 1,
            "FrequencyYear": 1,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "Asset Registration from 1 to <10 MWp",
            "FeeCode": "ASRG",
            "Currency": "USD",
            "ChargedValue": 500,
            "ExternalPaymentValue": 500,
            "MinEnergyValue": 1,
            "MaxEnergyValue": 10,
            "FrequencyYear": 1,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "Asset Registration >=10 MWp",
            "FeeCode": "ASRG",
            "Currency": "USD",
            "ChargedValue": 1000,
            "ExternalPaymentValue": 1000,
            "MinEnergyValue": 10,
            "MaxEnergyValue": null,
            "FrequencyYear": 1,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "QRE Validation Fee",
            "FeeCode": "QREV",
            "Currency": "USD",
            "ChargedValue": 500,
            "ExternalPaymentValue": 500,
            "MinEnergyValue": null,
            "MaxEnergyValue": null,
            "FrequencyYear": 0,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "REC Import",
            "FeeCode": "RECL",
            "Currency": "USD",
            "ChargedValue": 0.01,
            "ExternalPaymentValue": 0.01,
            "MinEnergyValue": 1,
            "MaxEnergyValue": 1,
            "FrequencyYear": 0,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "REC Registration",
            "FeeCode": "RECR",
            "Currency": "USD",
            "ChargedValue": 0.03,
            "ExternalPaymentValue": 0.03,
            "MinEnergyValue": 1,
            "MaxEnergyValue": 1,
            "FrequencyYear": 0,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "Redemption fee (per MWh) - RECs acquired through REHash",
            "FeeCode": "RECRA",
            "Currency": "USD",
            "ChargedValue": 0.03,
            "ExternalPaymentValue": 0.03,
            "MinEnergyValue": 1,
            "MaxEnergyValue": 1,
            "FrequencyYear": 0,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          },
          {
            "FeeName": "All-In Fee for REC Self-Consumption Redemption",
            "FeeCode": "RECRS",
            "Currency": "USD",
            "ChargedValue": 0.4,
            "ExternalPaymentValue": 0.03,
            "MinEnergyValue": 1,
            "MaxEnergyValue": 1,
            "FrequencyYear": 0,
            "ChargedBy": {
              "Value": "PerTransaction",
              "Description": "Per Transaction"
            },
            "CreatedTime": "2024-07-08T05:08:21.51",
            "UpdatedTime": "2024-07-08T05:08:21.51",
            "HasApplyMinimumBuyerProcessingFee": true
          }
        ],
        "IssuerFees": null
      }
    ],
    "Platform": [
      {
        "FeeName": "Seller Processing Fee",
        "FeeCode": "RECT",
        "Currency": "USD",
        "ChargedValue": 0.01,
        "ExternalPaymentValue": 0,
        "MinEnergyValue": 1,
        "MaxEnergyValue": null,
        "FrequencyYear": 0,
        "ChargedBy": {
          "Value": "PercentageOfTransaction",
          "Description": "Percentage Of Transaction"
        },
        "CreatedTime": "2024-07-08T05:08:21.51",
        "UpdatedTime": "2024-07-08T05:08:21.51",
        "HasApplyMinimumBuyerProcessingFee": true
      },
      {
        "FeeName": "Buyer Processing Fee",
        "FeeCode": "RECB",
        "Currency": "USD",
        "ChargedValue": 0.01,
        "ExternalPaymentValue": 0,
        "MinEnergyValue": 1,
        "MaxEnergyValue": null,
        "FrequencyYear": 0,
        "ChargedBy": {
          "Value": "PercentageOfTransaction",
          "Description": "Percentage Of Transaction"
        },
        "CreatedTime": "2024-07-08T05:08:21.51",
        "UpdatedTime": "2024-07-08T05:08:21.51",
        "HasApplyMinimumBuyerProcessingFee": true
      },
      {
        "FeeName": "Trading Import Fee (per MWh)",
        "FeeCode": "RECTPI",
        "Currency": "USD",
        "ChargedValue": 0.02,
        "ExternalPaymentValue": 0,
        "MinEnergyValue": 1,
        "MaxEnergyValue": null,
        "FrequencyYear": 0,
        "ChargedBy": {
          "Value": "PercentageOfTransaction",
          "Description": "Percentage Of Transaction"
        },
        "CreatedTime": "2024-07-08T05:08:21.51",
        "UpdatedTime": "2024-07-08T05:08:21.51",
        "HasApplyMinimumBuyerProcessingFee": true
      },
      {
        "FeeName": "Origination Fee (per MWh)",
        "FeeCode": "RECTPO",
        "Currency": "USD",
        "ChargedValue": 0.08,
        "ExternalPaymentValue": 0,
        "MinEnergyValue": 1,
        "MaxEnergyValue": null,
        "FrequencyYear": 0,
        "ChargedBy": {
          "Value": "PercentageOfTransaction",
          "Description": "Percentage Of Transaction"
        },
        "CreatedTime": "2024-07-08T05:08:21.51",
        "UpdatedTime": "2024-07-08T05:08:21.51",
        "HasApplyMinimumBuyerProcessingFee": true
      },
      {
        "FeeName": "REC Export Fee of Device Registered in REHash (MWh)",
        "FeeCode": "RECTO",
        "Currency": "USD",
        "ChargedValue": 0.8,
        "ExternalPaymentValue": 0,
        "MinEnergyValue": 1,
        "TransactionIdMaxEnergyValue": null1,
        "FrequencyYear": 0,
      }  "ChargedBy": {
         ], "Value": "PerTransaction",
          "PayerSubtotalDescription": 0,"Per Transaction"
           "PayeeSubtotal": 40.00,
 },
          "PayerSubtotalWithTaxCreatedTime": 0.00"2024-07-08T05:08:21.51",
            "PayeeSubtotalWithTaxUpdatedTime": 40.00"2024-07-08T05:08:21.51",
        },"HasApplyMinimumBuyerProcessingFee": true
      }
 "SplitInvoices": null  ]
  },
 
  "Meta": null,
 
  "Errors": null,
    "StatusCode": 200,
 
  "Message": "Success"
}

Warning
400 Bad Request

Code Block

language	json

{
  "Data": null
  "StatusCode": 400,
  "Errors": null,
  "Meta": null,
  "Message": "Bad Request"
}

Warning
422 Unprocessable Entity

Code Block

language	json

{
  "Data": null
  "StatusCode": 402,
  "Errors": null,
  "Meta": null,
  "Message": "Unprocessable Entity"
}

Warning
401 Unauthorized

Code Block

language	json

{
  "Data": null,
  "StatusCode": 401,
  "Errors": null,
  "Meta": null,
  "Message": "Unauthorized"
}

Warning
403 Forbidden

Code Block

language	json

{
  "Data": null,
  "StatusCode": 403,
  "Errors": null,
  "Meta": null,
  "Message": "Forbidden"
}

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

Rate Limit: 3000 requests per 5 minute(s)
Renewal Period: 300 second(s)
Key: IP Address
Increment Condition: Any Request

Operation Policy

Rate Limit: 10 requests per 10 seconds(s)
Renewal Period: 10 second(s)
Key: accound-id business account Id.
Increment Condition: Any Request.

Rate Limit Details

Rate Limit by Key:
1. Key: This ensures that rate limits are applied uniquely for each business account id.
2. Request Limit: Each key is allowed to make up to 10 requests per 10 seconds.
3. Reset Interval: The limit resets every 10 seconds.
Response Headers:
1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

Example Response When Rate Limit is Exceeded

Code Block

language	json

HTTP/1.1 429 Too Many Requests
Retry-After: 10
Content-Type: application/json
{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}

Version	Old Version 1	New Version 2
Changes made by	Tam Tran	Tam Tran
Saved on	Oct 24, 2024	Oct 24, 2024

Page Comparison

Versions Compared

Key

Table of Contents

Changelogs

Order Resource

API Definition

Request

Headers

Query Parameters

Response

Rate limit

Rate Limiting Overview

Global Policy

Operation Policy

Rate Limit Details

Exceeding the Rate Limit

Example Response When Rate Limit is Exceeded