Download OpenAPI specification:
Документ описывает порядок взаимодействия платформы Клиента и платформы Carusell (система "КПА") в рамках осуществления платежей и переводов в пользу различных получателей (мерчантов, банков) с инициацией транзакции через сканирование QR кода (scan-to-pay, MPM) или перевод из приложения Клиента по реквизитам.
Для начала интеграции необходимо выполнить настройку безопасного канала связи и получить доступ к тестовому стенду.
Взаимодействие с API происходит по защищенному протоколу HTTPS с использованием взаимной TLS-аутентификации (mTLS).
Чтобы получить сертификат со стороны Carusell для тестового стенда, необходимо:
Для получения настроек доступа к тестовому контуру Клиент направляет запрос по e-mail helpdesk@cyberpro.kg команде поддержки платформы Carusell. В ответном письме будут получены следующие параметры:
Порядок работы с сервисом платежей с инициацией через сканирование QR (scan-to-pay):
Допускается вариант, при котором Клиент может не выполнять этот шаг, поскольку запрос на декодирование QR кода позволяет определить принадлежность QR определенной платежной системе.
Порядок работы с сервисом переводов по реквизитам:
| text required | string [ 0 .. 8000 ] characters Отсканированный QR код |
| bankCurrency | string (Currency) Enum: "RUB" "VND" "PHP" "UZS" "AZN" "AMD" "TJS" "LKR" "KRW" "THB" "TWD" "JPY" "SGD" "MNT" "KHR" "TRY" "ARS" "MXN" "USDT" Трёхбуквенный код валюты, либо код криптовалюты |
| serviceId | integer <int64> (ServiceId) Идентификатор сервиса. Выдаётся командой технической поддержки системы КПА. |
{- "text": "string",
- "bankCurrency": "RUB",
- "serviceId": 0
}{- "stId": 42,
- "amount": 200.25,
- "currency": "RUB",
- "rate": 85.2445,
- "merchantInfo": {
- "id": 4521,
- "name": "ООО \"Кофейня у реки\"",
- "country": "KZ",
- "city": "Moscow",
- "address": "Tverskaya, 1",
- "mcc": 5300
}, - "minimumAmount": 200.25,
- "serviceId": 0,
- "description": "Оплата на кассе"
}| serviceId required | integer <int64> (ServiceId) Идентификатор сервиса. Выдаётся командой технической поддержки системы КПА. |
| bankCode required | string code из запроса getBanks |
| accountNumber required | string Номер счёта получателя |
| recipientName required | string Имя получателя |
| description | string Описание перевода |
object (UserInfo) |
{- "serviceId": 0,
- "bankCode": "aub",
- "accountNumber": 123456789,
- "recipientName": "Ivan Ivanov",
- "description": "string",
- "recipientInfo": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "phone": 18001234567,
- "addressCountry": "KZ",
- "address": "string",
- "zipcode": "string",
- "state": "string",
- "dateOfBirth": "2000-01-01",
- "birthPlace": "New York",
- "birthCountry": "KZ",
- "citizenship": "KZ",
- "documents": [
- {
- "type": "PASSPORT",
- "country": "KZ",
- "series": "string",
- "documentNumber": "string",
- "issuer": "string",
- "issuerCode": "string",
- "issueDate": "2020-01-01",
- "expiryDate": "2020-01-01"
}
], - "email": "string",
- "id": "string"
}
}{- "stId": 42,
- "currency": "RUB",
- "rate": 85.2445
}| stId required | integer <int64> (StId) >= 0 ID платежа в системе КПА |
| bankId required | string ID платежа в системе банка |
| amount required | number <decimal> (Amount) > 0 Сумма в единицах валюты, например VND. Точность 2 десятичных знака |
| currency required | string (Currency) Enum: "RUB" "VND" "PHP" "UZS" "AZN" "AMD" "TJS" "LKR" "KRW" "THB" "TWD" "JPY" "SGD" "MNT" "KHR" "TRY" "ARS" "MXN" "USDT" Трёхбуквенный код валюты, либо код криптовалюты |
| bankAmount required | number <decimal> (Amount) > 0 Сумма в единицах валюты, например VND. Точность 2 десятичных знака |
object (UserInfo) |
{- "stId": 42,
- "bankId": "test-id",
- "amount": 200.25,
- "currency": "RUB",
- "bankAmount": 200.25,
- "payerInfo": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "phone": 18001234567,
- "addressCountry": "KZ",
- "address": "string",
- "zipcode": "string",
- "state": "string",
- "dateOfBirth": "2000-01-01",
- "birthPlace": "New York",
- "birthCountry": "KZ",
- "citizenship": "KZ",
- "documents": [
- {
- "type": "PASSPORT",
- "country": "KZ",
- "series": "string",
- "documentNumber": "string",
- "issuer": "string",
- "issuerCode": "string",
- "issueDate": "2020-01-01",
- "expiryDate": "2020-01-01"
}
], - "email": "string",
- "id": "string"
}
}{- "status": "SUCCESS"
}