Inex API Documentation

ბალანსის შევსება

მიმდინარე სერვისით თქვენ შეძლებთ შეავსოსთ მომხმარებლის ბალანსი ოთახის ნომრით.

POST /integrators/payments/balance/top-up

Field	Type	Required	Example	Description
roomNumber	string	Yes	IG00001	მომხმარებლის ოთახის ნომერი.
amount	integer	Yes	100 (1 ლარი)	თანხა თეთრებში, min:1 და max:1000000.
paymentId	string	Yes	IN0001	თქვენს სისტემაში გადახდის ნომერი. (max:255) სიმბოლო.

დუბლიკატი paymentId

გაითვალისწინეთ. ჩვენი სისტემა დუბლიკატი paymentId-ით ხელახლა ბალანსის შევსების მოთხოვნისას არ დააბრუნებს შეცდომას, ასეთის არსებობის შემთხვევაში ბალანსის შევსება აღარ მოხდება და დააბრუნებს ძველ წარმატებულ პასუხს.

პასუხის სტრუქტურა 200 OK

Attribute	Type	Example	Description
data.transactionId	string	223IN1233	Inex სისტემაში ასახული ტრანზაქციის იდენტიფიკატორი.

შესაძლო პასუხები

Code	Description
200 OK	მოთხოვნა წარმატებით შესრულდა.
404 Not Found	მომხმარებელი მითითებული ოთახის ნომრით არ მოიძებნა.
403 Forbidden	თქვენ არ გაქვთ ამ ოპერაციის შესრულების უფლება
422 Unprocessable	ვალიდაციის შეცდომა (არასწორი ტიპი ან გამოტოვებული ველი).

cURL Request BASH

curl -X POST https://api-staging.inex.ge/api/v1/integrators/payments/balance/top-up \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"roomNumber": "IG00001",
"amount": 100,
"paymentId": "IN0001"
}'

Response (200 OK)

JSON Response JSON

{
    "data": {
        "transactionId": 123456
    }
}

Error Response (403)

JSON Response JSON

{
    "errors": {
        "general": [
            "You are not authorized to perform this action. Contact administrator."
        ]
    },
    "message": "error"
}

Error Response (404)

JSON Response JSON

{
    "errors": {
        "general": [
            "Requested customer not found"
        ]
    },
    "message": "error"
}

Error Response (422)

JSON Response JSON

{
    "message": "The amount field must be at least 1.",
    "errors": {
        "amount": [
            "The amount field must be at least 1."
        ]
    }
}