Payments

Платежи являются связанной сущностью полиса. На этой странице мы подробно рассмотрим различные конечные точки платежей, которые вы можете использовать для программного управления полисами. Мы рассмотрим, как запрашивать, создавать, обновлять и удалять платежи.

The payments model

Модель платежей содержит всю информацию о ваших платежах, такую как: дата платежа, сумма платежа, номер счёта и т.д.

Свойства

Name
id
Type
integer
Description
Первичный ключ, уникальное поле.
Name
billing_number
Type
string
Description
Номер счёта.
Name
refundPayments
Type
array
Description
Платежи по возвратам.
Name
additionalPayments
Type
array
Description
Платежи по доплатам.
Name
billing_payment_date
Type
timestamp
Description
Дата планового платежа.
Name
billing_payment_in_currency
Type
double
Description
Плановый платеж в валюте.
Name
billing_payment_in_rub
Type
double
Description
Плановый платеж в рублях.
Name
delete
Type
boolean
Description
Есть ли права на удаление платежа.
Name
insurant
Type
string
Description
Страхователь.
Name
insurer
Type
string
Description
Страховщик.
Name
payment_date
Type
timestamp
Description
Дата фактического платежа.
Name
payment_in_currency
Type
double
Description
Фактический платеж в валюте.
Name
payment_number
Type
string
Description
Номер счёта.
Name
payment_rub
Type
double
Description
Фактический платеж в рублях.
Name
payment_status
Type
boolean
Description
Статус оплаты.
Name
policies_id
Type
number
Description
ID связанного полиса.
Name
payment
Type
string
Description
Номер полиса.
Name
time_update
Type
timestamp
Description
Дата и время обновления платежа.
Name
treaty_number
Type
string
Description
Номер договора.
Name
update
Type
boolean
Description
Есть ли права на изменение платежа.
Name
user_update
Type
string
Description
Пользователь изменивший платеж.

GET/api/v1/aiins/new/all_payments/

List all payments

Эта конечная точка позволяет вам получить список всех ваших платежей.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key.

Request

GET

/api/v1/aiins/new/all_payments/

curl -G https://backend.aiins.online/api/v1/aiins/new/all_payments/ 
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d "public_key={API key}"

Response

{
    "update": true,
    "delete": true,
    "id": 6700,
    "policy": "6424846681YN",
    "insurant": "ПАО ЛИЗИНГОВАЯ КОМПАНИЯ КАМАЗ",
    "insurer": "САО РЕСО-ГАРАНТИЯ",
    "treaty_number": "9969736311XJ",
    "time_update": "15-12-2021 17:29:35",
    "user_update": "Инс",
    "policies_id": 7517,
    "payment_number": null,
    "payment_date": null,
    "payment_rub": null,
    "payment_status": true,
    "billing_payment_date": "2021-11-13",
    "billing_payment_in_rub": 66318.46,
    "billing_payment_in_currency": 66318.46,
    "payment_in_currency": null,
    "billing_number": ""
},
{
    "update": true,
    "delete": true,
    "id": 5638,
    "policy": "1455146517FW",
    "insurant": "ООО СТАРТТЕХ",
    "insurer": "ПАО САК ЭНЕРГОГАРАНТ",
    "treaty_number": "1455146517FW",
    "time_update": "06-12-2021 11:13:16",
    "user_update": "Инс",
    "policies_id": 6507,
    "payment_number": null,
    "payment_date": null,
    "payment_rub": null,
    "payment_status": true,
    "billing_payment_date": "2021-04-16",
    "billing_payment_in_rub": 21361.3,
    "billing_payment_in_currency": 21361.3,
    "payment_in_currency": null,
    "billing_number": ""
}

POST/api/v1/aiins/payments

Create a payment

Эта конечная точка позволяет вам создать новый платеж.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
body
Type
string
Description
Тело запроса

Request

POST

/api/v1/aiins/payments

curl -X POST "https://backend.aiins.online/api/v1/aiins/payments?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d 'body'

Payload

{
    "policies_id": 9711,
    "policy": "",
    "currency": "Рубль",
    "payments": [
        {
            "id": null,
            "payment_date": null,
            "payment_in_currency": "",
            "payment_rub": "",
            "billing_payment_date": "2023-12-02",
            "billing_payment_in_currency": 50980.87,
            "billing_payment_in_rub": 50980.87,
            "billing_number": "",
            "payment_status": ""
        }
    ],
    "time_update": "",
    "user_update": ""
}

Response

{
    "update": null,
    "delete": null,
    "user_update": "",
    "time_update": "",
    "policies_id": 9711,
    "policy": "3071061831JE",
    "currency": "Рубль",
    "payments": [
        {
            "id": 9021,
            "payment_date": null,
            "payment_rub": null,
            "payment_status": false,
            "billing_payment_date": "2023-12-02",
            "billing_payment_in_rub": 50980.87,
            "billing_payment_in_currency": 50980.87,
            "payment_in_currency": null,
            "billing_number": ""
        }
    ]
}

GET/api/v1/aiins/payments/:productId

Retrieve a payment

Обратите внимание, что идентификтором для получия платежей является ID продукта

Эта конечная точка позволяет вам получить полис, указав его идентификатор. Обратитесь к списку вверху этой страницы, чтобы узнать, какие свойства включены в полис.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре

Request

GET

/api/v1/payments/:productId

curl -G https://backend.aiins.online/api/v1/aiins/payments/:productId 
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d "public_key={API key}"

Response

{
    "refundPayments": [],
    "paymentsCP": [
        {
            "update": true,
            "delete": true,
            "user_update": "Адепт Инс",
            "time_update": "10-02-2022 10:11:23",
            "policies_id": 6773,
            "policy": "7997503337NA",
            "currency": "Евро",
            "payments": [
                {
                    "id": 5958,
                    "payment_date": null,
                    "payment_rub": 83013.84,
                    "payment_status": true,
                    "billing_payment_date": "2020-12-02 00:00:00.0",
                    "billing_payment_in_rub": 83013.84,
                    "billing_payment_in_currency": 83013.84,
                    "payment_in_currency": 83013.84,
                    "billing_number": ""
                }
            ]
        },
        {
            "update": true,
            "delete": true,
            "user_update": "Адепт Инс",
            "time_update": "10-12-2021 12:38:23",
            "policies_id": 6774,
            "policy": "4395684617PU",
            "currency": "Рубль",
            "payments": [
                {
                    "id": 5961,
                    "payment_date": null,
                    "payment_rub": null,
                    "payment_status": false,
                    "billing_payment_date": "2024-12-02 00:00:00.0",
                    "billing_payment_in_rub": 43333.74,
                    "billing_payment_in_currency": 43333.74,
                    "payment_in_currency": null,
                    "billing_number": ""
                }
            ]
        },
        {
            "update": true,
            "delete": true,
            "user_update": "Адепт Инс",
            "time_update": "10-12-2021 12:38:23",
            "policies_id": 6775,
            "policy": "7263868592XC",
            "currency": "Рубль",
            "payments": [
                {
                    "id": 5960,
                    "payment_date": null,
                    "payment_rub": null,
                    "payment_status": false,
                    "billing_payment_date": "2022-12-02 00:00:00.0",
                    "billing_payment_in_rub": 59977.5,
                    "billing_payment_in_currency": 59977.5,
                    "payment_in_currency": null,
                    "billing_number": ""
                }
            ]
        },
        {
            "update": true,
            "delete": true,
            "user_update": "Адепт Инс",
            "time_update": "10-02-2022 10:11:50",
            "policies_id": 6776,
            "policy": "1327552338BV1",
            "currency": "Рубль",
            "payments": [
                {
                    "id": 5959,
                    "payment_date": null,
                    "payment_rub": null,
                    "payment_status": false,
                    "billing_payment_date": "2023-12-02 00:00:00.0",
                    "billing_payment_in_rub": 50980.87,
                    "billing_payment_in_currency": 50980.87,
                    "payment_in_currency": null,
                    "billing_number": ""
                }
            ]
        },
        {
            "update": true,
            "delete": true,
            "user_update": "Адепт Инс",
            "time_update": "10-02-2022 10:11:30",
            "policies_id": 6778,
            "policy": "3071061831JE",
            "currency": "Рубль",
            "payments": [
                {
                    "id": 5956,
                    "payment_date": null,
                    "payment_rub": 70561.76,
                    "payment_status": true,
                    "billing_payment_date": "2021-12-02 00:00:00.0",
                    "billing_payment_in_rub": 70561.76,
                    "billing_payment_in_currency": 70561.76,
                    "payment_in_currency": 70561.76,
                    "billing_number": ""
                }
            ]
        },
        {
            "update": true,
            "delete": true,
            "user_update": "Adept Insurance",
            "time_update": "30-10-2023 12:07:27",
            "policies_id": 9711,
            "policy": "33333",
            "currency": "Рубль",
            "payments": [
                {
                    "id": 9021,
                    "payment_date": null,
                    "payment_rub": null,
                    "payment_status": false,
                    "billing_payment_date": "2023-12-02 00:00:00.0",
                    "billing_payment_in_rub": 50980.87,
                    "billing_payment_in_currency": 50980.87,
                    "payment_in_currency": null,
                    "billing_number": ""
                }
            ]
        }
    ],
    "additionalPayments": []
}

PUT/api/v1/aiins/payments/:id

Update a payment

Эта конечная точка позволяет вам изменить текущий полис.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
body
Type
string
Description
Тело запроса

Request

PUT

/api/v1/aiins/payments/:id

curl -X PUT "https://backend.aiins.online/api/v1/aiins/payments/:id?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d 'body'

Payload

{
    "id": 5959,
    "payment_date": "2023-10-03",
    "payment_in_currency": "50980.87",
    "payment_rub": "50980.8750980",
    "billing_payment_date": "2023-12-02",
    "billing_payment_in_currency": 50980.87,
    "billing_payment_in_rub": 50980.87,
    "billing_number": "",
    "payment_status": true
}

Response

{
    "update": true,
    "delete": true,
    "id": 5959,
    "policy": "1327552338BV1",
    "time_update": "30-10-2023 13:11:11",
    "user_update": "Insurance",
    "policies_id": 6776,
    "payment_number": null,
    "payment_date": "2023-10-03",
    "payment_rub": 50980.875098,
    "payment_status": true,
    "billing_payment_date": "2023-12-02",
    "billing_payment_in_rub": 50980.87,
    "billing_payment_in_currency": 50980.87,
    "payment_in_currency": 50980.87,
    "billing_number": ""
}

DELETE/api/v1/aiins/payments/:id

Delete a payment

Эта конечная точка позволяет вам удалять платежи.

Request

DELETE

/api/v1/aiins/payments/:id

curl -X DELETE "https://backend.aiins.online/api/v1/aiins/payments/:id?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json"