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

API інтеграція

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

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

An image from the static

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

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

Для ініціації скасування резерву запит до Tranzzo API повинен містити такі параметри:

ParameterTypeRequiredDescription
pos_idUUIDMerchant's identifier (POS_ID)
order_idStringMerchant's order identifier to be captured (max length is 32 characters)
order_currencyCURRENCYCurrency of original order
commentStringVoid comment. Can be used for describing reasons of void or for passing another data about operation (max length is 2048 characters)
server_urlURLWebhook notification will be sent to this URL

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

$ curl "https://cpay.tranzzo.com/api/v1/void" \
-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",
"order_currency": "UAH",
"comment": "10101",
"server_url": "https://callback.blackhole.com/callback/"
}'

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

ParameterTypeDescription
operation_idUUIDUnique Tranzzo void identifier
payment_idUUIDTranzzo payment identifier of primary operation
order_idStringMerchant's order_id of primary operation (max length is 32 characters)
transaction_idUUIDUnique Tranzzo transaction identifier
pos_idUUIDMerchant's identifier (POS_ID)
modeMODEdirect
methodMETHODvoid
amountNumberActual void amount
currencyCURRENCYTransaction currency
statusSTATUSTransaction status
status_codeSTATUS_CODETranzzo payment status code
status_descriptionSTATUS_DESCRIPTIONTranzzo payment status code description
created_atTIMESTAMPTimestamp when transaction was created
processing_timeTIMESTAMPTimestamp when transaction was updated last time
feeObjectAmount and currency of commission
commentStringVoid 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": "void",
"amount": 100,
"currency": "UAH",
"status": "success",
"status_code": "1009",
"status_description": "Reverse successful.",
"created_at": "2018-10-10T10:10:10.100",
"processing_time": "2018-10-10T10:10:12.000",
"fee": null,
"comment": "10101"
}

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

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

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

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

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