Описание: Check verification
Введение
API URL
Примечание
Сервер Присоединяющейся Стороны |
|---|
https://proxy.connectingpartyserver.com/verification/{invoiceId}/check |
Параметры запроса
Название параметра |
Описание |
Значение |
|---|---|---|
consumer |
Тип: Object |
|
consumer.device |
Тип: Object |
|
consumer.device.serialNumber |
Серийный номер устройства потребителя. |
Тип: StringДлина: 1-50 |
session |
Тип: Object |
|
session.accessToken |
Ключ access token потребителя, отправленный приложением Присоединяющейся Стороны. |
Тип: StringДлина: 32-128 |
session.nonce |
Значение, отправленное приложением Присоединяющейся Стороны. |
Тип: StringДлина: 32-128 |
session.signature |
Значение, отправленное приложением Присоединяющейся Стороны. |
Тип: StringДлина: 32-128 |
session.token |
Токен сеанса транзакции верификации. |
Тип: StringДлина: 16-36 |
Параметры успешного ответа
Название параметра |
Описание |
Значение |
|---|---|---|
invoiceId |
Идентификатор транзакции верификации. |
Необходимость: ОбязательноТип: String |
session |
Необходимость: ОбязательноТип: Object |
|
session.checkSignature |
Контрольная сумма, сгенерированная hmac-sha1 (см. Вычисление подписи) из конкатенации consumer.device.serialNumber, session.nonce, endpointId и invoiceId. |
Необходимость: ОбязательноТип: String |
session.nonce |
Unique random string generated by Присоединяющаяся сторона’s server in Initiate verification ответ. |
Необходимость: ОбязательноТип: String |
session.token |
Токен сеанса транзакции верификации. |
Необходимость: ОбязательноТип: String |
billing |
Необходимость: ОпциональноТип: Object |
|
billing.address |
Необходимость: ОпциональноТип: Object |
|
billing.address.city |
Название города. |
Необходимость: ОпциональноТип: String |
billing.address.country |
Трёхбуквенный код страны ISO. |
Необходимость: ОпциональноТип: String |
billing.address.postcodeZip |
Почтовый индекс ZIP. |
Необходимость: ОпциональноТип: String |
billing.address.state |
Поле «Штат» используется при наличии. Например, Лос-Анджелес находится в штате CA. |
Необходимость: ОпциональноТип: String |
billing.address.street |
Поле «Улица» используется для названий районов и улиц. |
Необходимость: ОпциональноТип: String |
billing.address.street2 |
Поле «Улица 2» используется для длинных адресов. Обычно оно содержит номер квартиры и здания. |
Необходимость: ОпциональноТип: String |
billing.phone |
Контактный номер телефона клиента. |
Необходимость: ОпциональноТип: String |
consumer.birthDay |
Потребитель’s birth day in «ddMMyyyy» format. |
Необходимость: ОпциональноТип: String |
consumer.email |
Потребитель’s email адрес. |
Необходимость: ОпциональноТип: String |
consumer.ipAddresses |
IP-адреса потребителя. |
Необходимость: ОпциональноТип: List |
consumer.ipAddresses[] |
IP-адрес потребителя. |
Необходимость: ОпциональноТип: String |
transaction.currency |
Буквы верхнего регистра (alpha-код по ISO 4217). |
Необходимость: ОпциональноТип: String |
transaction.randomSumCentis |
Случайная сумма (для проверки случайной суммы), 1.00 EUR = 100 центов. |
Необходимость: ОпциональноТип: Integer |
Параметры неуспешного ответа
Название параметра |
Описание |
Значение |
|---|---|---|
error |
Тип: Object |
|
error.cause |
Причина ошибки. Возможные значения: |
Тип: Enum |
error.code |
Уникальный код ошибки. |
Тип: String |
error.message |
Описание ошибки. |
Тип: String |
invoiceId |
Идентификатор транзакции верификации. |
Тип: String |
Пример запроса
{
"consumer": {
"device": {
"serialNumber": "string"
}
},
"session": {
"accessToken": "string",
"nonce": "string",
"signature": "string",
"token": "string"
}
}
Пример успешного ответа
{
"billing": {
"address": {
"city": "string",
"country": "string",
"postcodeZip": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"phone": "string"
},
"consumer": {
"birthDay": "string",
"email": "string",
"ipAddresses": ["string"]
},
"invoiceId": "string",
"session": {
"checkSignature": "string",
"nonce": "string",
"token": "string"
},
"transaction": {
"currency": "string",
"randomSumCentis": "integer"
}
}
Пример неуспешного ответа
{
"error": {
"cause": "enum",
"code": "string",
"message": "string"
},
"invoiceId": "string"
}