ArbiPayment API v1

ArbiPayment REST API

API дозволяє вашій CRM, інтернет-магазину чи боту автоматично створювати платіжні посилання за IBAN: обираєте збережені реквізити, вказуєте суму та призначення — отримуєте посилання на сторінку оплати з QR-кодом НБУ.

Посилання, створені через API, зʼявляються у вашому кабінеті в розділі «Мої посилання» з позначкою API — ними можна керувати так само, як і створеними вручну.

Базовий URLhttps://www.arbipayment.online/api/v1
ФорматJSON, UTF-8
ДатиRFC 3339, UTC
ВалютаUAH

Як почати

  1. Зареєструйтесь і додайте реквізити у розділі «Мої реквізити» (або через POST /requisites).
  2. У кабінеті відкрийте API Токен і створіть токен.
  3. Викличте POST /links та віддайте клієнту поле url з відповіді.

Автентифікація

Кожен запит має містити токен у заголовку Authorization за схемою Bearer:

Authorization: Bearer ap_live_9f3c1a…

Як альтернативу можна передати заголовок X-API-Token: ap_live_9f3c1a…. Токен у query-рядку не приймається.

Токен дає повний доступ до ваших реквізитів і посилань. Викликайте API лише зі свого сервера — не вставляйте токен у JavaScript сайту чи мобільний застосунок. Якщо токен скомпрометовано, відкличте його в кабінеті та створіть новий.

Без токена або з недійсним токеном API повертає 401 Unauthorized.

Відповіді та помилки

Успішні відповіді повертають обʼєкт ресурсу. Списки — обʼєкт з полями data (масив) і meta (пагінація):

{
  "data": [ … ],
  "meta": { "page": 1, "per_page": 20, "total": 57, "total_pages": 3 }
}

Помилки мають єдиний формат. Поле field присутнє, якщо помилка стосується конкретного поля запиту:

{
  "error": {
    "code": "validation_error",
    "message": "Вкажіть призначення платежу",
    "field": "purpose"
  }
}
HTTPcodeКоли
200—Успішний запит
201—Ресурс створено; заголовок Location містить його адресу
204—Ресурс видалено, тіло відповіді порожнє
400invalid_jsonТіло не є JSON-обʼєктом
400validation_errorПередано невідоме поле (див. field)
401unauthorizedТокен відсутній, недійсний або відкликаний
404not_foundРесурс не існує або належить іншому користувачу
405method_not_allowedМетод не підтримується; див. заголовок Allow
415unsupported_media_typeContent-Type не application/json
422validation_errorЗначення поля некоректне
429rate_limitedПеревищено ліміт запитів; див. Retry-After
500internal_errorПомилка на нашому боці — повторіть запит пізніше

Ліміти

  • 120 запитів на хвилину на один токен; при перевищенні — 429 із заголовком Retry-After: 60.
  • До 10 токенів на акаунт.
  • Розмір тіла запиту — до 64 КБ.
  • Пагінація: per_page від 1 до 100 (за замовчуванням 20).

GET /me

Перевірка токена: повертає власника і назву токена.

curl https://www.arbipayment.online/api/v1/me \
  -H "Authorization: Bearer $TOKEN"
{
  "user":  { "id": 7, "name": "Олена", "email": "olena@example.com" },
  "token": { "id": 3, "name": "Інтернет-магазин", "prefix": "ap_live_9f3c1a", "created_at": "2026-11-04T09:12:00Z" }
}

GET /requisites

Список реквізитів отримувача. id звідси передається як requisite_id при створенні посилання.

Query-параметри
ПараметрТипОпис
statusstringactive або inactive. Без параметра — усі
qstringПошук за назвою, ЄДРПОУ/РНОКПП, IBAN, банком
page, per_pageintegerПагінація
curl "https://www.arbipayment.online/api/v1/requisites?status=active" \
  -H "Authorization: Bearer $TOKEN"
{
  "data": [
    {
      "id": 12,
      "name": "Кавʼярня «Зерно»",
      "public_name": "Кавʼярня «Зерно»",
      "legal_name": "ФОП Коваленко Олена Петрівна",
      "tax_id": "3153821259",
      "iban": "UA263534890000026008111113966",
      "bank_name": "АТ КБ «ПриватБанк»",
      "active": true,
      "created_at": "2026-10-01T08:00:00Z",
      "updated_at": "2026-10-01T08:00:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 1, "total_pages": 1 }
}

GET /requisites/{id}

Один запис реквізитів. Якщо реквізити не існують або належать іншому користувачу — 404.

POST /requisites

Створює реквізити отримувача. Відповідь — 201 Created з обʼєктом реквізитів.

ПолеТипОпис
legal_namestringобовʼязковеЮридична назва ФОП / ТОВ — потрапляє в QR-код НБУ
tax_idstringобовʼязковеЄДРПОУ (8 цифр) або РНОКПП (10 цифр)
ibanstringобовʼязковеUA + 27 цифр; пробіли ігноруються
public_namestringПублічна назва для кабінету

Приклади коду

<?php
$ch = curl_init('https://www.arbipayment.online/api/v1/links');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('ARBIPAY_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'requisite_id' => 12,
        'amount'       => 1500.50,
        'purpose'      => 'Оплата замовлення №1024',
        'private_note' => 'order_id=1024',
    ], JSON_UNESCAPED_UNICODE),
]);
$body   = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($status === 201) {
    header('Location: ' . $body['url']); // відправити клієнта на оплату
} else {
    error_log($body['error']['message'] ?? 'API error');
}
const res = await fetch('https://www.arbipayment.online/api/v1/links', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.ARBIPAY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    requisite_id: 12,
    amount: 1500.5,
    purpose: 'Оплата замовлення №1024',
    expires_in: 3600,
  }),
});

const body = await res.json();
if (!res.ok) throw new Error(body.error.message);
console.log(body.url); // посилання на оплату
import os
import requests

resp = requests.post(
    "https://www.arbipayment.online/api/v1/links",
    headers={"Authorization": f"Bearer {os.environ['ARBIPAY_TOKEN']}"},
    json={
        "requisite_id": 12,
        "amount": 1500.50,
        "purpose": "Оплата замовлення №1024",
    },
    timeout=10,
)
data = resp.json()
if resp.status_code != 201:
    raise RuntimeError(data["error"]["message"])
print(data["url"])  # посилання на оплату