Прежде чем начать
API для биллинга
API Affise предоставляет вам различные методы для работы с биллингами. Например, вы можете получить информацию о счете на оплату, создать счет на оплату, удалить его и т. д. В этой статье вы найдете примеры наиболее популярных API-запросов (методов) для биллинга с примерами cURL и примерами ответа.
💰 Функция выставления счетов через API доступна только для некоторых тарифных планов. Свяжитесь с вашим менеджером Affise, чтобы получить эту функцию.
Получить список платежей
Используйте этот метод, чтобы получить список платежей в соответствии с их свойствами, которые вы можете указать в своем API-запросе.
Метод: GET /3.1/payments.
Запрос на получение списка платежей с указанным периодом:
https://api-rocketcompany.affise.com/3.1/payments?date_from=2022-08-08&date_to=2022-12-12
Создать счет на оплату
Данный метод используется для создания счета на определенную сумму денег для определенного партнера в соответствии с его свойствами, которые вы можете указать в запросе API.
Метод: POST /3.1/payments/create-for-affiliate.
Запрос cURL для создания счета на оплату со следующими свойствами:
идентификатор партнера
сумма счета на оплату
идентификатор валюты
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/create-for-affiliate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'aid=2'\--data-urlencode 'sum=2'\--data-urlencode 'currency=150'
Генерирование счетов на оплату для аффилиатов
Используйте этот метод для генерации счетов за определенный период времени в соответствии с его свойствами, которые вы можете указать в своем API-запросе.
Метод: POST /3.1/payments/generate.
Запрос cURL для создания счета на оплату для аффилированных лиц со следующими свойствами:
дата
идентификатор аффилиата
идентификатор исключенного партнера
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/generate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'date=2022-05-23' \--data-urlencode 'aid=2' \--data-urlencode 'exclude_aids[]=8'
Обновить счет на оплату
Используйте этот метод для обновления счета на оплату в соответствии с его свойствами, которые вы можете указать в своем API-запросе.
Метод: POST /3.1/payments/{ID}.
Запрос cURL для обновления счета на оплату со следующими свойствами:
информация о счете на оплату
статус "Оплачено частично".
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2926' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_account=счет на оплату' \--data-urlencode 'status=3'
Добавление корректирующего значения для счета на оплату
Используйте этот метод, чтобы добавить корректирующее значение для счета на оплату в соответствии с его свойствами, которые вы можете указать в своем API-запросе.
Метод: POST /3.1/payments/{ID}/add-correction.
Запрос cURL для добавления корректирующего значения со следующими свойствами:
доход = 22
комментарий
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2921/add-correction' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'revenue=22' \--data-urlencode 'comment=example'
Удаление нескольких счетов на оплату
Используйте этот метод для удаления нескольких счетов на оплату в соответствии с их свойствами, которые вы можете указать в своем API-запросе.
Метод: POST /3.1/payments/bulk-delete.
⚠️ Вы можете удалить счет с любым статусом, кроме Complete. Если вы попытаетесь удалить биллинг со статусом Complete, вы получите следующую ошибку:
Запрос cURL на удаление нескольких счетов на оплату с идентификаторами счетов на оплату = 2925 и 2924:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/bulk-delete' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn'\--data-urlencode 'ids[0]=2925'\--data-urlencode 'ids[1]=2924'
Редактирование платежных систем
Используйте этот метод для редактирования платежных систем для партнера в соответствии с их свойствами, которые вы можете указать в запросе API.
Метод: POST /3.0/admin/partner/{ID}.
⚠️ Возможность редактирования доступна только в том случае, если биллинг имеет любой статус, кроме Complete.
Запрос cURL для редактирования платежных систем с ID партнерской системы = 13, кодом валюты = USD и расширенными полями = 1b765:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/partner/2' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_systems[0][system_id]=13' \--data-urlencode 'payment_systems[0][currency]=USD' \--data-urlencode 'payment_systems[0][fields][4]=1b765'
По всем возникающим вопросам обращайтесь в службу поддержки клиентов Affise по электронной почте: [email protected].