API інтеграція

Цей тип інтеграції дозволяє проводити вторинні операції із зарахування всієї суми резерву або його частини.

Формат взаємодії:

An image from the static

Особливості використання цієї інтеграції для зарахування резерву:

Запит до Tranzzo API на зарахування резерву може застосовуватися тільки до первинних операцій резервування (auth) з успішним статусом (success).
Використовуйте HTTP-метод POST.
Встановлюйте суму резерву, що буде зарахована за допомогою параметру charge_amount.

Параметри запиту:

Parameter	Type	Required	Description
`pos_id`	UUID	✅	Merchant's identifier (`POS_ID`)
`order_id`	String	✅	Merchant's order identifier to be captured (max length is 32 characters)
`charge_amount`	Number	✅	Total amount to be captured. Must be a positive number. The number of decimal digits must be less than or equal to 2 (e.g., 100.00, 250, 50.50)
`order_currency`	CURRENCY	✅	Currency of original order
`comment`	String		Capture comment. Can be used for describing reasons of capture or for passing another data about operation (max length is 2048 characters)
`server_url`	URL		Webhook notification will be sent to this URL
`split`	Array[SplitPayment]	✅	Split payment properties

Приклад запиту:

$ curl "https://cpay.tranzzo.com/api/v1/split/capture" \
    -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}",
      "order_id":       "123",
      "charge_amount":  "100",
      "order_currency": "UAH",
      "comment":        "10101",
      "server_url":     "https://callback.blackhole.com/callback/capture",
      "split":[
          {
              "amount":          70,
              "sub_merchant_id": "${SUB_MERCHANT_ID_1}"
          },
          {
              "amount":          30,
              "sub_merchant_id": "${SUB_MERCHANT_ID_2}"
          }
      ]
    }'

Параметри відповіді:

Parameter	Type	Description
`operation_id`	UUID	Unique Tranzzo capture identifier
`payment_id`	UUID	Tranzzo payment identifier of primary operation
`order_id`	String	Merchant's `order_id` of primary operation (max length is 32 characters)
`transaction_id`	UUID	Unique Tranzzo transaction identifier
`pos_id`	UUID	Merchant's identifier (`POS_ID`)
`mode`	MODE	`direct`
`method`	METHOD	`capture`
`amount`	Number	Actual captured amount
`currency`	CURRENCY	Transaction currency
`status`	STATUS	Transaction status
`status_code`	STATUS_CODE	Tranzzo payment status code
`status_description`	STATUS_DESCRIPTION	Tranzzo payment status code description
`created_at`	TIMESTAMP	Timestamp when transaction was created
`processing_time`	TIMESTAMP	Timestamp when transaction was updated last time
`fee`	Object	Amount and currency of commission
`comment`	String	Capture comment

Приклад відповіді:

{
  "operation_id":        "f7d0c7cb-af32-441f-b2af-4d90d4da70e1",
  "payment_id":          "fdf1a710-8a34-414c-b023-b7e78104301a",
  "order_id":            "123",
  "transaction_id":      "4f98dc46-ffff-4ba7-a267-286fe7669894",
  "pos_id":              "dc728de1-51ef-4ef1-80f7-3b44b07b5667",
  "mode":                "direct",
  "method":              "capture",
  "amount":              100,
  "currency":            "UAH",
  "status":              "success",
  "status_code":         "1000",
  "status_description":  "Transaction is successful.",
  "created_at":          "2018-10-10T10:10:10.100",
  "processing_time":     "2018-10-10T10:10:12.000",
  "fee":                 null,
  "comment":             "10101"
}

інформація

Щоб керувати зарахованою сумою резерву та розподілити її між субмерчантами, потрібно використовувати спеціальні параметри спліт-платежів, розташовані в масиві split.

Parameter	Type	Required	Description
`amount`	Number	✅	Total amount to be captured. Must be a positive number. The number of decimal digits must be less than or equal to 2 (e.g., 100.00, 250, 50.50)
`sub_merchant_id`	UUID	✅	Unique Sub merchant identifier (to get the identifier, please contact support at [email protected])

Тестування платіжного процесу:

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

Вихід в онлайн

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

Дивіться також:​

Дивіться також: