Update Tenant Payment Charge

PUT /charges/tenant

Description

Update the tenant payment charge.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
countryCode	string	The country code (header)

Request Body

• Content Type: application/json

{
  "uuId": "string",
  "chargeFormula": "string",
  "type": "CREDIT",
  "tenantId": "string"
}

Charge Formula Documentation

Variables

• A: Amount
• P: Percentage

Constants

• C: Constant

Operators

• *: Multiplication
• +: Addition
• -: Subtraction

Comparators

• <: Less than
• >: Greater than

Delimiters

• |: Vertical pipe

Examples of Terms

• 5C: 5 constants
• 4P*A: 4 percent of amount
• 5.6P*A: 5.6 percent of amount
• 4P*10C: 4 percent multiplied by 10 constants
• 39C*A: 39 constants multiplied by amount
• 20C+A: 20 constants plus amount
• 39C-A: 39 constants minus amount

Examples of Charge Formulas

• 4P*A: 4 percent of amount, which is 0.04 \* A
• 5.6P*10C: 5.6 percent multiplied by 10 constants, which is 0.056 \* 10 = 0.56

Response Code: 200 - OK

Description

Successful.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the tenant payment charge
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Payment charge updated successfully",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Method: PUT

>http://your-api-url/charges/tenant

Headers

Content-Type	Value
apiKey	{{apiKey}}
countryCode	string

Body

{
  "uuId": "123e4567-e89b-12d3-a456-426614174000",
  "chargeFormula": "5.6P*A",
  "type": "CREDIT",
  "tenantId": "tenant123"
}

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string