Raiffeisenbank cards API

Download OpenAPI specification:Download

Автоматизированный выпуск карт с помощью API или реестра. Это позволит вам выпускать корпоративные карты без документов и паспортов. Отправляйте нам список держателей реестром через банк-клиент или по API — мы выпустим вам карты.

Реестр

Отправляйте список сотрудников через интернет-банк в формате XLS, CSV или XML. Список сотрудников можете заполнять вручную или выгружать из вашей учетной системы.
Если заказываете карты в отделение банка, срок доставки через 3-5 дней. Если заказываете карты на адреса держателей (только для форматов XLS и CSV), срок доставки через 5-7 дней в зависимости от региона доставки. Держатели получат СМС о готовности карты.

Формат реестра

Шаблон реестра:

Примеры реестров:

Наименование параметра	Значение
ИдПервичногоДокумента	Уникальный идентификатор реестра на стороне Компании
РасчетныйСчетОрганизации	Счёт Компании, открытый в Банке, к которому будут созданы карты
ВидВклада/КодВидаВклада	Тип карт (MIR_CORPORATE/ MIR_CORPORATE_VIRTUAL/ MC_CORPORATE/ CASH_IN/ CASH_IN&OUT)
Фамилия	Фамилия сотрудника-держателя, которому будет создана карта
Имя	Имя сотрудника-держателя, которому будет создана карта
Отчество	Отчество сотрудника-держателя, которому будет создана карта
ЭмбоссированныйТекст	Имя и фамилия сотрудника-держателя латиницей, которые будет напечатаны на карте
ОтделениеБанка/ ФилиалОтделенияБанка	Код отделения Банка, куда будут доставлены карты
Пол	Пол сотрудника-держателя, которому создаётся карта
ДатаРождения	Дата рождения
МестоРождения.СтранаНазвание	Страна рождения
Серия	Серия паспорта РФ
Номер	Номер паспорта РФ
ДатаВыдачи	Дата выдачи паспорта РФ
КемВыдан	Кем выдан паспорт РФ
Гражданство	Гражданство
АдресПрописки.Страна	Страна прописки
АдресПрописки.РегионНазвание	Регион адреса прописки
АдресПрописки. НаселенныйПунктНазвание	Населенный пункт адреса прописки
АдресПрописки.УлицаНазвание	Улица адреса прописки (при отсутствии указать Нет)
АдресПрописки.Дом	Дом адреса прописки
МобильныйТелефон	Мобильный телефон сотрудника-держателя (79210000001 или 9210000001)
Суточный лимит (csv файл)	Суточный лимит на снятие наличных
Месячный лимит (csv файл)	Ежемесячный общий расходный лимит
Секретное слово (csv файл)	Секретное слово держателя карты
Индекс доставки (csv файл)	Индекс доставки
Регион доставки (csv файл)	Регион доставки
Населенный пункт доставки (csv файл)	Населенный пункт доставки
Улица доставки (csv файл)	Улица доставки
Дом доставки (csv файл)	Дом доставки
Корпус доставки (csv файл)	Корпус доставки

Инструкция по выгрузке реестра из 1С

Список отделений для получения карт

Об API

После заключения договора вам придет письмо о подключении к сервису с авторизационными данными.

Интегрируйте наш API с вашей учетной системой.
Отправляйте список сотрудников.
Проверяйте статус готовности карт.
Через 3-5 дней карты доставят в отделение банка. Держатели получат СМС о готовности карты.

Взаимодействие осуществляется по протоколу HTTP с использованием методов GET/POST (в описании каждого запроса явно указан требуемый метод и адрес). POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов.

API всегда возвращает ответ в формате JSON, независимо от типа запроса. Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет дополнительно описание ошибки (message).

Авторизация

Для авторизация запросов необходимы:

secretKey - секретный ключ, который используется для межсервисного взаимодействия.

ВАЖНО: Секретный ключ необходимо хранить в защищенном месте, нельзя публиковать на сторонних ресурсах или передавать третьим лицам.

Межсервисные запросы авторизуются посредством секретного ключа API (SECRET_KEY). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer SECRET_KEY". API

Выпуск карт

Для реализации взаимодействия Райффайзенбанк предоставляет API:

запрос на создание карт с ипользованием HTTP;
получение информации о статусе запроса на создание карт.

Заявка на создание карт

Метод на подачу заявки на выпуск карт.

header Parameters

Authorization

required

string

Bearer secret key

Request Body schema: application/json

batchId required	string <= 36 characters Уникальный идентификатор пакета.
required	Array of objects Список карт на выпуск.

Responses

Request samples

Payload

Content type

application/json

{"batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
"cards": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "203",
"person": {"surname": "Тестов",
"name": "Тест",
"patronymic": "Тестович",
"birthday": "1980-01-30",
"gender": "MALE",
"cellPhone": "79123456789",
"transcriptFullName": "Testov Test Testovich",
"citizenshipCode": "643",
"secretWord": "secretword123",
"email": "test@test.ru",
"passport": {"series": "1234",
"number": "123456",
"issuedBy": "ОУФМС по МО в городском округе Серпухов",
"issuedDate": "2010-01-30",
"countryOfBirthIsoCode": "643",
"placeOfBirth": "string",
"departmentCode": "string"
},
"address": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3"
}
},
"deliveryAddress": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3",
"postalCode": "127521"
}
}
]
}

Response samples

400
401
500

Content type

application/json

{"code": "INVALID_DATA",
"message": "Некорректные данные",
"errors": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"invalidFields": ["person.passport.series"
]
}
]
}

Заявка на создание карт Deprecated

Метод на подачу заявки на выпуск карт.

header Parameters

Authorization

required

string

Bearer secret key

Request Body schema: application/json

batchId required	string <= 36 characters Уникальный идентификатор пакета.
required	Array of objects Список карт на выпуск.

Responses

Request samples

Payload

Content type

application/json

{"batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
"cards": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "203",
"person": {"surname": "Тестов",
"name": "Тест",
"patronymic": "Тестович",
"birthday": "1980-01-30",
"gender": "MALE",
"cellPhone": "79123456789",
"transcriptFullName": "Testov Test Testovich",
"citizenshipCode": "643",
"secretWord": "secretword123",
"email": "test@test.ru",
"passport": {"series": "1234",
"number": "123456",
"issuedBy": "ОУФМС по МО в городском округе Серпухов",
"issuedDate": "2010-01-30",
"countryOfBirthIsoCode": "643"
},
"address": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3"
}
},
"deliveryAddress": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3",
"postalCode": "127521"
}
}
]
}

Response samples

400
401
500

Content type

application/json

{"code": "ERROR.INVALID_DATA",
"message": "Некорректные данные",
"errors": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"invalidFields": ["person.passport.series"
]
}
]
}

Статус заявки на выпуск карт

Метод получения информации о статусе заявки.

path Parameters

batchId

required

string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"cardId": "12345678",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "603",
"status": {"value": "IN_PROGRESS",
"description": "В обработке",
"message": "Ошибка в паспортных данных: неверно указаны ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
"dateTime": "2021-01-01T12:00:27.87+00:20"
},
"person": {"companyId": "HBA23K",
"maskedName": "Тестов Т.Т.",
"birthday": "1980.01.30",
"gender": "MALE",
"maskedCellPhone": "7916***4567",
"passport": {"maskedSeries": "1*3*",
"maskedNumber": "1***56",
"issuedDate": "2012-10-22",
"countryOfBirthIsoCode": "string",
"placeOfBirth": "string",
"departmentCode": "string"
}
}
}
]

Статус заявки на выпуск карт Deprecated

Метод получения информации о статусе заявки.

path Parameters

batchId

required

string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"cardId": "12345678",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "603",
"status": {"value": "IN_PROGRESS",
"description": "В обработке",
"message": "Ошибка в паспортных данных: неверно указаны ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
"dateTime": "2021-01-01T12:00:27.87+00:20"
},
"person": {"companyId": "HBA23K",
"maskedName": "Тестов Т.Т.",
"birthday": "1980.01.30",
"gender": "MALE",
"maskedCellPhone": "7916***4567",
"passport": {"maskedSeries": "1*3*",
"maskedNumber": "1***56",
"issuedDate": "2012-10-22"
}
}
}
]

Заявка на привязку моментальных карт

Метод на подачу заявки на привязку моментальных карт.

header Parameters

Authorization

required

string

Bearer secret key

Request Body schema: application/json

batchId required	string <= 36 characters Уникальный идентификатор пакета.
required	Array of objects Список карт на выпуск.

Responses

Request samples

Payload

Content type

application/json

{"batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
"cards": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "203",
"person": {"surname": "Тестов",
"name": "Тест",
"patronymic": "Тестович",
"birthday": "1980-01-30",
"gender": "MALE",
"cellPhone": "79123456789",
"transcriptFullName": "Testov Test Testovich",
"citizenshipCode": "643",
"secretWord": "secretword123",
"email": "test@test.ru",
"passport": {"series": "1234",
"number": "123456",
"issuedBy": "ОУФМС по МО в городском округе Серпухов",
"issuedDate": "2010-01-30",
"countryOfBirthIsoCode": "643",
"placeOfBirth": "string",
"departmentCode": "string"
},
"address": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3"
}
},
"card": {"lastFourDigits": "4321",
"cardId": "87654321"
}
}
]
}

Response samples

400
401
500

Content type

application/json

{"code": "INVALID_DATA",
"message": "Некорректные данные",
"errors": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"invalidFields": ["person.passport.series"
]
}
]
}

Заявка на привязку моментальных карт Deprecated

Метод на подачу заявки на привязку моментальных карт.

header Parameters

Authorization

required

string

Bearer secret key

Request Body schema: application/json

batchId required	string <= 36 characters Уникальный идентификатор пакета.
required	Array of objects Список карт на выпуск.

Responses

Request samples

Payload

Content type

application/json

{"batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
"cards": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "203",
"person": {"surname": "Тестов",
"name": "Тест",
"patronymic": "Тестович",
"birthday": "1980-01-30",
"gender": "MALE",
"cellPhone": "79123456789",
"transcriptFullName": "Testov Test Testovich",
"citizenshipCode": "643",
"secretWord": "secretword123",
"email": "test@test.ru",
"passport": {"series": "1234",
"number": "123456",
"issuedBy": "ОУФМС по МО в городском округе Серпухов",
"issuedDate": "2010-01-30",
"countryOfBirthIsoCode": "643"
},
"address": {"countryOfRegistrationIsoCode": "643",
"region": "Москва",
"city": "Москва",
"street": "Октябрьская",
"house": "84",
"building": "3"
}
},
"card": {"lastFourDigits": "4321",
"cardId": "87654321"
}
}
]
}

Response samples

400
401
500

Content type

application/json

{"code": "ERROR.INVALID_DATA",
"message": "Некорректные данные",
"errors": [{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"invalidFields": ["person.passport.series"
]
}
]
}

Статус запроса на привязку моментальных карт

Информация о статусе заявки на привязку моментальных карт.

path Parameters

batchId

required

string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"cardId": "12345678",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "603",
"status": {"value": "IN_PROGRESS",
"description": "В обработке",
"message": "Ошибка в паспортных данных: неверно указаны ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
"dateTime": "2021-01-01T12:00:27.87+00:20"
},
"person": {"companyId": "HBA23K",
"maskedName": "Тестов Т.Т.",
"birthday": "1980.01.30",
"gender": "MALE",
"maskedCellPhone": "7916***4567",
"passport": {"maskedSeries": "1*3*",
"maskedNumber": "1***56",
"issuedDate": "2012-10-22",
"countryOfBirthIsoCode": "string",
"placeOfBirth": "string",
"departmentCode": "string"
}
}
}
]

Статус запроса на привязку моментальных карт Deprecated

Информация о статусе заявки на привязку моментальных карт.

path Parameters

batchId

required

string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "c130bc10-3286-4d0b-afd0-29e271491e13",
"cardId": "12345678",
"account": "40702810603000060801",
"product": "MC_CORPORATE",
"dailyLimit": "500",
"monthlyLimit": "5000",
"branchId": "603",
"status": {"value": "IN_PROGRESS",
"description": "В обработке",
"message": "Ошибка в паспортных данных: неверно указаны ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
"dateTime": "2021-01-01T12:00:27.87+00:20"
},
"person": {"companyId": "HBA23K",
"maskedName": "Тестов Т.Т.",
"birthday": "1980.01.30",
"gender": "MALE",
"maskedCellPhone": "7916***4567",
"passport": {"maskedSeries": "1*3*",
"maskedNumber": "1***56",
"issuedDate": "2012-10-22"
}
}
}
]

Операции по картам

Для просмотра информации и управления картой Райффайзенбанк предоставляет API:

Просмотр списка карт
Подробная информация по карте
История действий
Список операций
Реквизиты карты
Установка лимитов
Блокировка, разблокировка и закрытие карты

Список карт

Подробная информация о картах с фильтром и пагинацией.

query Parameters

page	integer <int32> Default: 1 Номер страницы
size	integer <int32> Default: 20 Количество отображаемых карт
account	string Номер счета
expiryStartDate	string <YYYY-MM-DD> Начало срока действия карты
expiryEndDate	string <YYYY-MM-DD> Конец срока действия карты
status	Array of strings Items Enum: "ACTIVE" "CLOSED" "BLOCKED" Статусы
product	string Enum: "MIR_CORPORATE" "MIR_CORPORATE_VIRTUAL" "MC_CORPORATE" "VISA_CORPORATE" "VISA_PLATINUM" "CASH_IN" "CASH_IN&OUT" Карточный продукт

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

{"meta": {"page": 1,
"size": 20,
"hasNext": true,
"count": 34
},
"data": [{"id": "string",
"maskedNumber": "1***56",
"status": "CLOSED",
"createdDate": "2020-02-01",
"isActivated": true,
"expiryDate": "2024-02-01",
"product": "MIR_CORPORATE",
"account": "40702810603000060801",
"type": "DEBIT",
"currency": "RUB",
"embossedName": "TEST TESTOV",
"person": {"name": "Тест",
"surname": "Тестов",
"patronimic": "Тестович",
"cnum": "CNUM"
},
"limits": [{"type": "CASH",
"period": "DAILY",
"value": "100"
}
]
}
]
}

Информация о карте

Подробная информация по конкретной карте.

path Parameters

cardId

required

string

Идентификатор карты

header Parameters

Authorization

required

string

Bearer secret key

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": "string",
"maskedNumber": "1***56",
"status": "CLOSED",
"createdDate": "2020-02-01",
"isActivated": true,
"expiryDate": "2024-02-01",
"product": "MIR_CORPORATE",
"account": "40702810603000060801",
"type": "DEBIT",
"currency": "RUB",
"embossedName": "TEST TESTOV",
"person": {"name": "Тест",
"surname": "Тестов",
"patronimic": "Тестович",
"cnum": "CNUM"
},
"limits": [{"type": "CASH",
"period": "DAILY",
"value": "100"
}
]
}

История действий по карте

Метод получения истории действий с картой.

path Parameters

cardId

required

string

id карты

query Parameters

page	integer <int32> Default: 1 Номер страницы
size	integer <int32> Default: 20 Количество отображаемых карт

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": "string",
"cardId": "string",
"createdDate": "string",
"type": "string",
"author": "string",
"action": {"limits": [{"type": "string",
"period": "string",
"oldValue": "string",
"value": "string"
}
],
"status": {"oldStatus": "string",
"status": "string",
"reason": "string"
}
}
}
],
"meta": {"page": 0,
"size": 20,
"hasNext": true,
"count": 34
}
}

Список операций по карте Deprecated

Метод получения списка операций по карте (период не обязательный, если его не указывать то: toDate = текущая дата, fromDate = минус 7 дней от текущей даты)

path Parameters

cardId

required

string

Идентификатор карты

query Parameters

toDate	string <date>
fromDate	string <date>

Responses

Response samples

200
400
401
500

Content type

application/json

[{"accountMovementType": "DEBIT",
"extendedNarrative": "string",
"authorization": {"amount": "1000.00",
"currency": "RUB"
},
"status": {"value": "HOLD",
"dateTime": "2019-08-24T14:15:22"
},
"transaction": {"amount": "1000.00",
"currency": "RUB"
},
"card": {"id": "1",
"maskedNumber": "553496******0091"
},
"merchant": {"mcc": "1000",
"label": "Лимузины и такси",
"name": "YANDEX.TAXI",
"city": "Gorod Moskva",
"country": "RU"
}
}
]

Список операций по карте

Метод получения списка операций по карте (период не обязательный, если его не указывать то: toDate = текущая дата, fromDate = минус 7 дней от текущей даты)

path Parameters

cardId

required

string

Идентификатор карты

query Parameters

toDate	string <date>
fromDate	string <date>

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "string",
"accountMovementType": "DEBIT",
"extendedNarrative": "string",
"authorization": {"amount": "1000.00",
"currency": "RUB"
},
"status": {"value": "HOLD",
"dateTime": "2019-08-24T14:15:22"
},
"transaction": {"amount": "1000.00",
"currency": "RUB"
},
"card": {"id": "1",
"maskedNumber": "553496******0091"
},
"merchant": {"mcc": "1000",
"label": "Лимузины и такси",
"name": "YANDEX.TAXI",
"city": "Gorod Moskva",
"country": "RU"
}
}
]

Реквизиты карты

Получение реквизитов по карте. Инфраструктура клиента должна соответствовать стандартам PCI DSS.

path Parameters

cardId

required

string

Идентификатор карты

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"pan": "2200000000000000",
"expiryDate": "12/12",
"cvv": "123"
}

Установка лимита по карте

На данный момент возможна установка следующих лимитов:

суточный лимит на снятие наличных - "period": "DAILY", "type": "CASH".
месячный лимит на все операции (безналичные оплаты и снятие наличных) - "period": "MONTHLY", "type": "AUTH".

Данные лимиты устанавливаются как по отдельности, так и оба единовременно.

path Parameters

cardId

required

string

Идентификатор карты

Request Body schema: application/json
required

Array

period required	string Enum: "MONTHLY" "DAILY" Период изменяемого лимита
type required	string Enum: "AUTH" "CASH" Тип транзакции у лимита
value required	string[0-9]+ Значение для установки

Responses

Request samples

Payload

Content type

application/json

[{"period": "DAILY",
"type": "CASH",
"value": "1000"
},
{"period": "MONTHLY",
"type": "AUTH",
"value": "10000"
}
]

Response samples

200
400
401
500

Content type

application/json

[{"period": "MONTHLY",
"type": "AUTH",
"value": "10000"
}
]

Блокировка, разблокировка и закрытие карты

Метод по закрытию и блокировке/разблокировке карты.

path Parameters

cardId

required

string

Уникальный банковский идентификатор карты

header Parameters

Authorization

required

string

Bearer secret key

Request Body schema: application/json

Change card status

cardStatus required	string Enum: "CLOSED" "BLOCKED" "ACTIVE" Статус для установки.
reason	string Комментарий.

Responses

Request samples

Payload

Content type

application/json

{"cardStatus": "CLOSED",
"reason": "string"
}

Response samples

400
401
500

Content type

application/json

{"code": "ERROR.INVALID_DATA",
"message": "Некорректные данные"
}

Операции по счетам

API для просмотра информации и управления счетами:

Получение баланса счёта, к которому привязаны карты

Баланс по счёту

Получение баланса счёта, к которому привязаны карты.

path Parameters

account

required

string

Номер счёта

Responses

Response samples

200
400
401
500

Content type

application/json

{"availableBalance": 70.76
}

Справочная информация

Дополнительная информация для выпуска карт.

Список отделений для выдачи карт

Responses

Response samples

200

Content type

application/json

[{"branchId": "740",
"name": "Отделение Домодедово",
"city": "Москва",
"address": "г.Домодедово ул.Корнеева д.12"
}
]

Уведомления об операциях

Для информирования Компании о проведенных операциях по картам могут использоваться уведомления на адрес, указанный в настройках. В составе API имеется следующий функционал:

уведомление о блокировке средств на карте (статус HOLD);
уведомление о списании средств по счету (статус CAPTURE);
запрос на отправку уведомления в тестовом контуре с иcпользованием HTTP;

Взаимодействия осуществляются через протокол HTTP посредством метода POST как для исходящих из банка сообщений, так и для входящих.

Адреса для тестовой и продакшн сред можно указать с помощью метода в API.

Для партнёра уведомление представляет собой входящий POST-запрос, который использует JSON-структуру.

Уведомление считается принятым, если получатель ответил на запрос HTTP-кодом 200.

Ответы с любыми другими HTTP-кодами будут считаться невалидными. Повторные попытки отправки будут проводиться в течение суток с нарастающим интервалом.

Для проверки подлинности уведомления к данным добавляется подпись в заголовке x-api-signature-sha256, полученная на основе общего секретного ключа и контрольной строки (operation.authorization.amount|operation.card.id|operation.created|operation.id|operation.status.value) с помощью HMAC-SHA-256.

Помимо этого предоставляется опциональная возможность дополнительной аутентификации (authType) посредством логина и пароля (authType = BASIC), либо через bearer-токен (authType = BEARER).

Уведомление об операциях по картам Webhook

Request Body schema: application/json

event required	string Value: "DCC.OPERATION" Тип события.
clientId required	string Id компании(CNUM).
required	object

Responses

Request samples

Payload

Content type

application/json

Example

HOLD

{"event": "DCC.OPERATION",
"clientId": "CNUM01",
"operation": {"id": "be313e48-c501-58e6-be55-422498c7d86f",
"accountMovementType": "DEBIT",
"created": "2020-01-15T16:01:49.043924+03:00",
"authorization": {"amount": "20.88",
"currency": "EUR"
},
"status": {"value": "HOLD",
"dateTime": "2021-01-01T12:00:27.87+00:20"
},
"card": {"id": "14901823",
"maskedNumber": "553496******0091"
},
"merchant": {"mcc": "5499",
"label": "Различные продовольственные магазины",
"name": "ГАСТРОНОМ",
"city": "RYAZAN",
"country": "RU"
}
}
}

Установка URL и параметров аутентификации для уведомлений.

header Parameters

Authorization

required

string

Bearer secret key.

Request Body schema: application/json

URL и параметры аутентификации для приема уведомлений

url required	string URL, куда требуется отправлять уведомления по всем статусам.
statusValues	Array of strings Items Enum: "HOLD" "CAPTURE" Статус операции. Необязательный параметр, если не отправить, то URL будет указан для всех статусов.
authType	string Enum: "NO_AUTH" "BASIC" "BEARER" Тип аутентификации. Необязательный параметр, без отправки которого, будет выставлено значение NO_AUTH.
login	string <= 30 characters Логин клиента.
password	string <password> <= 200 characters Пароль клиента.
token	string <= 4000 characters Bearer-токен.

Responses

Request samples

Payload

Content type

application/json

{"url": "https://yoururl.ru",
"statusValues": ["HOLD"
],
"authType": "NO_AUTH",
"login": "clientLogin",
"password": "pwd/wStrongEncryption",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Response samples

400
401
500

Content type

application/json

{"code": "ERROR.INVALID_URL",
"message": "URL Protocol should be http or https"
}

Получение тестового сообщения в интеграционной среде

Request Body schema: application/json

URL и параметры аутентификации для приема уведомлений

url required	string URL, куда требуется отправить сформированное уведомление.
statusValue required	string Enum: "HOLD" "CAPTURE" Статус операции, по которому будет сформировано и отправлено тестовое сообщение.
authType	string Enum: "NO_AUTH" "BASIC" "BEARER" Тип аутентификации. Необязательный параметр, без отправки которого, будет выставлено значение NO_AUTH.
login	string <= 30 characters Логин клиента.
password	string <password> <= 200 characters Пароль клиента.
token	string <= 4000 characters Bearer-токен.

Responses

Request samples

Payload

Content type

application/json

{"url": "https://yoururl.ru",
"statusValue": "HOLD",
"authType": "NO_AUTH",
"login": "clientLogin",
"password": "pwd/wStrongEncryption",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Response samples

400
500

Content type

application/json

{"code": "ERROR.INVALID_STATUS",
"message": "Status value should be HOLD or CAPTURE, actual status is null"
}