POST request/clevel/customer/carbonoffset/payment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AnnualkWhGas	integer	None.
CarbonFootprint	decimal number	None.
CustomerId	integer	None.
FirstName	string	None.
FootprintEquals	string	None.
FullCarbonCost	decimal number	None.
IsPaymentSuccessful	boolean	None.
LastName	string	None.
PaymentDate	date	None.
PaymentReference	string	None.
ProjectPercentage	decimal number	None.
ProjectSelected	string	None.
QuoteId	string	None.
uuid	string	None.

Request Formats

application/json, text/json

Sample:

{
  "uuid": "sample string 1",
  "customerId": 2,
  "quoteId": "sample string 3",
  "firstName": "sample string 4",
  "lastName": "sample string 5",
  "annualkWhGas": 6,
  "carbonFootprint": 7.0,
  "footprintEquals": "sample string 8",
  "projectSelected": "sample string 9",
  "projectPercentage": 1.0,
  "paymentDate": "2025-04-04T11:02:44.330859+00:00",
  "fullCarbonCost": 1.0,
  "isPaymentSuccessful": true,
  "paymentReference": "sample string 10"
}

application/xml, text/xml

Sample:

<CLevelcarbon.CarbonFootprintPut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.CLevelCarbon">
  <AnnualkWhGas>6</AnnualkWhGas>
  <CarbonFootprint>7</CarbonFootprint>
  <CustomerId>2</CustomerId>
  <FirstName>sample string 4</FirstName>
  <FootprintEquals>sample string 8</FootprintEquals>
  <FullCarbonCost>1</FullCarbonCost>
  <IsPaymentSuccessful>true</IsPaymentSuccessful>
  <LastName>sample string 5</LastName>
  <PaymentDate>2025-04-04T11:02:44.330859+00:00</PaymentDate>
  <PaymentReference>sample string 10</PaymentReference>
  <ProjectPercentage>1</ProjectPercentage>
  <ProjectSelected>sample string 9</ProjectSelected>
  <QuoteId>sample string 3</QuoteId>
  <uuid>sample string 1</uuid>
</CLevelcarbon.CarbonFootprintPut>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="uuid"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerId"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="QuoteId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FirstName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LastName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AnnualkWhGas"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarbonFootprint"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FootprintEquals"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ProjectSelected"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ProjectPercentage"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentDate"

2025-04-04T11:02:44.3308590+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FullCarbonCost"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsPaymentSuccessful"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentReference"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

CarbonOffsetPaymentResponse

Name	Type	Additional information
CheckOutUrl	string	None.
IsServerError	boolean	None.
IsSuccess	boolean	None.
JsonResult	string	None.
QuoteId	string	None.
TransactionCanclledUrl	string	None.
TransactionSuccessUrl	string	None.
Updated	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "quoteId": "sample string 1",
  "checkOutUrl": "sample string 2",
  "transactionSuccessUrl": "sample string 3",
  "transactionCanclledUrl": "sample string 4",
  "updated": true,
  "jsonResult": "sample string 6",
  "isSuccess": true,
  "isServerError": true
}

application/xml, text/xml

Sample:

<CLevelcarbon.CarbonOffsetPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.CLevelCarbon">
  <CheckOutUrl>sample string 2</CheckOutUrl>
  <IsServerError>true</IsServerError>
  <IsSuccess>true</IsSuccess>
  <JsonResult>sample string 6</JsonResult>
  <QuoteId>sample string 1</QuoteId>
  <TransactionCanclledUrl>sample string 4</TransactionCanclledUrl>
  <TransactionSuccessUrl>sample string 3</TransactionSuccessUrl>
  <Updated>true</Updated>
</CLevelcarbon.CarbonOffsetPaymentResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="QuoteId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CheckOutUrl"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TransactionSuccessUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TransactionCanclledUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Updated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="JsonResult"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsSuccess"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsServerError"

True
--MultipartDataMediaFormatterBoundary1q2w3e--