Даний метод API дозволяє видаляти виставлені неоплачені рахунки.
Запит c необхідними параметрами формується на стороні продавця та передається методом POST по протоколу HTTP на URL https://api.wayforpay.com/api
Параметри запиту:
Параметр | Опис | Обов'язкове |
transactionType | REMOVE_INVOICE | Так |
apiVersion | Версія протоколу. Значення за замовчуванням: 1 | Так |
merchantAccount | Ідентифікатор продавця. Це значення присвоюється Вам з боку WayForPay | Так |
orderReference | Рефернс створеного раніше invoice | Так |
merchantSignature | Підпис запиту | Так |
Аутентифікація запитів
З метою підтвердження валідності даних повинно бути згенеровано і передано в запиті HMAC_MD5 контрольний підпис з використанням SecretKey торговця.
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів merchantAccount, orderReference, розділених ";" (крапка з комою) в кодуванні UTF-8
Параметри відповіді:
reason | Причина відмови |
reasonCode | код відмови |
Приклад запиту і відповіді
{
"apiVersion": "1",
"transactionType": "REMOVE_INVOICE",
"merchantAccount": "test_merch_n1",
"orderReference": "INV-1479196343",
"merchantSignature": "bc54562dc1fa928b52fd3eb0e4d36937"
}
{
"reason": "Removed",
"reasonCode": 1100
}