Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Mandatory field

Description

status

Yes

Processing status:

  • OK – account is found;
  • NotFound – the specified account does not exist;
  • Error – an error occurred (additional information about the error must be provided).

amount

No

Optional block with information on the amount.

editable

Yes

«editable»: <bool - permission to edit amount>

arrears

Yes

«arrears»: <number, amount of debt>

min

No

«min»: <number, minimum amount>, makes sense only if editable=true, if editable=false the field is ignored.

max

No

«max»:<number, maximum amount>, makes sense only if editable=true, if editable=false the field is ignored.

accountInfo

No

Optional block of parameters with information about the customer, all parameters are of string type up to 30 characters long.

  


 

fName

No

«fName»: <First name>

lName

No

«lName»: <Last name>

mName

No

«mName”: <Middle name>

addressInfo

No

Optional parameter block with customer address.


 


 


 

city

No

«city»: <City> - string up to 30 characters long.

street

No

«street»: <Street> - string up to 30 characters long.

house

No

«house»: <House> - string up to 10 characters long.

building

Нет

«building»: <Building> - string up to 10 characters long.

apartment

Нет

«apartment»: <Apartment> - string up to 10 characters long.

  • HTTP 400 in case of incorrect input parameters. The response must contain the following fields:
  • HTTP 401 Unauthorized request (authorization failed):
  • HTTP 403 in case of problems with request execution. The response must contain the following fields:

Example of a request to a web service: