Создание спора

API позволяет создать спор по сделке в случае, если сделка была отклонена, но платеж со стороны пользователя был произведен. Спор создается при отправке дополнительных файлов и указания новой суммы сделки.

Этот API позволяет вам инициировать спор по сделке, если возникли разногласия по её выполнению. Например, пользователь мог отправить некорректную сумму или платеж был выполнен, но сделка отклонена. Вы можете отправить дополнительные файлы для подтверждения спора и указать новую сумму сделки.

Request

POST https://repay.cx/api/v1/external/deals/{deal.id}/disputes

Headers

Name	Type	Description
api-key	string	API-ключ кассы для аутентификации запросов

Эти поля могут быть переданы как заголовки в HTTP-запросе в зависимости от реализации API.

Parameters

Name	Type	Description	Required
deal_id	string	Уникальный идентификатор сделки.
new_amount	string (number)	Новая сумма сделки, которая должна быть указана в споре

Body

Name	Type	Description
files	file array	Файлы, которые загружаются в запросе, такие как доказательства для спора. Каждый файл передается с указанием типа. Важно! Названия прикрепленных файлов должны быть на латинице.

Пример на cURL

#!/bin/bash

deal_id=1  # Замените на фактический ID сделки
new_deal_amount=1000  # Замените на фактическую сумму
api_key="cashier-api-key"  # Замените на фактический ключ API

# Файлы для отправки
file1="file1.pdf"
file2="file2.pdf"
file3="file3.pdf"

curl -X POST "http://repay.cx/api/v1/external/deals/$deal_id/disputes" \
-H "api-key: $api_key" \
-H "origin: your-domain" \
-F "files=@$file1;type=application/pdf" \
-F "files=@$file2;type=application/pdf" \
-F "files=@$file3;type=application/pdf" \
-F "new_amount=$new_deal_amount"

Этот код отправляет POST-запрос с несколькими файлами, передавая их в формате multipart/form-data через -F. Заголовки и параметры, включая ключ API и сумму, также указаны в запросе.

Response

Пример успешного ответа

{
    "status_code": 200,
    "error": {},
    "payload": {
        "id": "5bc508c3-5788-4827-8da8-ef366a7ba545",
        "status": "uploaded"
    }
}

Name	Type	Description
payload	object	Дополнительная информация о сделке
payload.id	string (UUID4)	Уникальный идентификатор созданной заявки
payload.status	string	Статус сделки, например, created