Перейти до основного вмісту

Платіжні атрибути

До будь-якого платіжного запиту опційно може бути включено параметр attributes. Цей параметр є списком, до якого можуть бути додані набори обʼєктів ключ-значення.

Особливості параметру attributes:

  • Ви можете передати до 20 ключів (включно).
  • Максимальна довжина ключа 45 символів.
  • Максимальна довжина значення ключа може бути до 250 символів (включно).
    Дозволяється використання літер як Латиниці, так і Кирилиці.

Приклад платіжного запиту з використанням атрибутів:

  $ curl "https://cpay.tranzzo.com/api/v1/payment" \
    -H "Content-Type: application/json" \
    -H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
    -H "X-API-KEY: ${ENDPOINTS_KEY}" \
    -X POST -d '{
      "pos_id":           "${POS_ID}",
      "mode":             "direct",
      "method":           "purchase",
      "amount":           1,
      "currency":         "UAH",
      "description":      "Order description",
      "order_id":         "123",
      "order_3ds_bypass": "always",
      "cc_number":        "4242424242424242",
      "exp_month":        2,
      "exp_year":         24,
      "card_cvv":         "111",
      "server_url":       "https://callback.blackhole.com/callback",
      "result_url":       "https://example.com/result",
      "payload":          "sale=true",
      "customer_referrer": "https://example.com",
      "attributes": [
        {
          "value": "shop_name",
          "key": "Bakery"
        },
        {
          "value": "London",
          "key": "shop_region"
        },
        {
          "value": "Smith & Loyd LLC",
          "key": "legal_entity_name"
        }
      ],
      "browser_fingerprint": {
          "browserColorDepth":       "24",
          "browserScreenHeight":     "860",
          "browserScreenWidth":      "1600",
          "browserJavaEnabled":      "false",
          "browserLanguage":         "uk-UA",
          "browserTimeZone":         "Europe/Kiev",
          "browserTimeZoneOffset":   "-120",
          "browserAcceptHeader":     "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
          "browserIpAddress":        "127.0.0.1",
          "browserUserAgent":        "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.146 Safari/537.36"
      }
    }'

За необхідності передачі в значенні назви з виділенням лапками (“...”) необхідно дотримуватися формату:

{
 "value": "TOV \"Company name\"",
 "key": "legal_entity_name"
}

Платіжні атрибути є корисним інструментом, який ви можете використовувати для структурування інформації про ваші транзакції та здійснювати через нього фільтрацію транзакцій та метрик у мерчант-порталі.

Фільтр для пошуку інформації та транзакцій за атрибутами міститься у розділах “Аналітика” та “Платежі” мерчант-порталу. Для роботи з ним просто заповність в полі “Ключ” точну назву ключа, а в полі “Значення” вкажіть точну назву відповідного значення.

Пошук може здійснюватися одразу за кількома наборами ключ-значення та/або за кількома різними значеннями одного й того самого ключа.

MP

Важливо

Не передавайте в параметрі attributes жодної конфіденційної інформації (карткові дані тощо).