ACQ4i-ng-hole payments (8.0)

Download OpenAPI specification:Download

Subbotin Sergey: subbotin-si@bisys.ru URL: http://www.bisys.ru License: (с) ООО 'Биллинговые системы' г. Пермь 2021

ACQ4i-ng-hole payments API

Authentication

basicAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

payment-controller

Payment Controller

Результат выполнения аутентификации 3DSv1

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

gatewaySessionId required	string <uuid> Идентификатор платежной сессии шлюза
md required	string Идентификатор сессии 3DSv1
paRes required	string Результат полученный от ACS сервера эмитента 3DSv1

Responses

Request samples

Payload

Content type

application/json

{"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"md": "string",
"paRes": "string"
}

Response samples

200
400
500

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"amount": 0,
"currency": "RUB",
"rrn": "string",
"approvalCode": "string",
"cardMaskPan": "string",
"cardExpDate": "string",
"registeredCard": {"type": "RegisteredCardData",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": "string"
},
"threeDSData": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"md": "string",
"paReq": "string"
},
"threeDSDataV2": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"threeDSMethodData": "string",
"threeDSMethodURLServer": "string",
"threeDSSessionData": "string",
"creq": "string"
},
"resultCode": 0,
"resultMessage": "string"
}

Результат выполнения аутентификации 3DSv2

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

gatewaySessionId required	string <uuid> Идентификатор платежной сессии шлюза
threeDSSessionData required	string Идентификатор сессии 3DSv2
cres required	string Результат полученный от ACS сервера эмитента 3DSv2

Responses

Request samples

Payload

Content type

application/json

{"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"threeDSSessionData": "string",
"cres": "string"
}

Response samples

200
400
500

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"amount": 0,
"currency": "RUB",
"rrn": "string",
"approvalCode": "string",
"cardMaskPan": "string",
"cardExpDate": "string",
"registeredCard": {"type": "RegisteredCardData",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": "string"
},
"threeDSData": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"md": "string",
"paReq": "string"
},
"threeDSDataV2": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"threeDSMethodData": "string",
"threeDSMethodURLServer": "string",
"threeDSSessionData": "string",
"creq": "string"
},
"resultCode": 0,
"resultMessage": "string"
}

Отменить платеж

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

terminalId required	string Идентификатор терминала торговой точки в системе
paymentId required	string Идентификатор платежа в системе
amount required	integer <int64> Сумма отмены, должна быть меньше или равна сумме указанной при создании платежа

Responses

Request samples

Payload

Content type

application/json

{"terminalId": "string",
"paymentId": "string",
"amount": 0
}

Response samples

200
400
500

Content type

application/json

{"resultCode": 0,
"resultMessage": "string"
}

Подтвердить выполнение платежа

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

terminalId required	string Идентификатор терминала торговой точки в системе
paymentId required	string Идентификатор платежа в системе
amount required	integer <int64> Подтверждаемая сумма платежа, должна быть меньше или равна сумме указанной при создании платежа

Responses

Request samples

Payload

Content type

application/json

{"terminalId": "string",
"paymentId": "string",
"amount": 0
}

Response samples

200
400
500

Content type

application/json

{"resultCode": 0,
"resultMessage": "string"
}

Выполнить платеж

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

terminalId required	string Идентификатор терминала торговой точки в системе
merchantTermUrl required	string Адрес для обратного редиректа на сайт торговой точки после попытки авторизации на ACS банка эмитента
orderId required	string Идентификатор заказа в торговой точке
orderDescription required	string Описание заказа
amount required	integer <int64> Сумма платежа в разменных денежных единицах
currency required	string Enum: "RUB" "KZT" "USD" "EUR" "GPB" "KGS" "UZS" "AZN" "GEL" "TRY" "CNY" "AMD" Валюта платежа
stage	string Enum: "AUTH" "PREAUTH" Одно/дву - стадийный платеж, если не передан, платеж не требует подтверждения
required	object (ClientInfo) Информация о клиенте
required	object (PaymentData) Платежные данные
rememberCard	boolean Запомнить карту клиента. Только для платежных данных тип 'CardData'

Responses

Request samples

Payload

Content type

application/json

{"terminalId": "string",
"merchantTermUrl": "string",
"orderId": "string",
"orderDescription": "string",
"amount": 0,
"currency": "RUB",
"stage": "AUTH",
"clientInfo": {"ipAddress": "string",
"agentName": "string",
"browserInfo": "string",
"agentAcceptHeader": "string"
},
"paymentData": {"type": "RegisteredCardData"
},
"rememberCard": true
}

Response samples

200
400
500

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"amount": 0,
"currency": "RUB",
"rrn": "string",
"approvalCode": "string",
"cardMaskPan": "string",
"cardExpDate": "string",
"registeredCard": {"type": "RegisteredCardData",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": "string"
},
"threeDSData": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"md": "string",
"paReq": "string"
},
"threeDSDataV2": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"threeDSMethodData": "string",
"threeDSMethodURLServer": "string",
"threeDSSessionData": "string",
"creq": "string"
},
"resultCode": 0,
"resultMessage": "string"
}

OCT B2C перевод на карту

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

terminalId required	string Идентификатор терминала торговой точки в системе
orderId required	string Идентификатор заказа в торговой точке
orderDescription required	string Описание заказа
amount required	integer <int64> Сумма платежа в разменных денежных единицах
currency required	string Enum: "RUB" "KZT" "USD" "EUR" "GPB" "KGS" "UZS" "AZN" "GEL" "TRY" "CNY" "AMD" Валюта платежа
recipientPan required	string Номер карты получателя
	object (Recipient) Данные получателя

Responses

Request samples

Payload

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"orderDescription": "string",
"amount": 0,
"currency": "RUB",
"recipientPan": "string",
"recipientInfo": {"firstName": "string",
"lastName": "string"
}
}

Response samples

200
400
500

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"amount": 0,
"currency": "RUB",
"rrn": "string",
"approvalCode": "string",
"recipientMaskPan": "string",
"resultCode": 0,
"resultMessage": "string"
}

Вернуть средства

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

terminalId required	string Идентификатор терминала торговой точки в системе
paymentId required	string Идентификатор платежа в системе
amount required	integer <int64> Сумма средств к возврату, должна быть меньше или равна сумме указанной при создании платежа

Responses

Request samples

Payload

Content type

application/json

{"terminalId": "string",
"paymentId": "string",
"amount": 0
}

Response samples

200
400
500

Content type

application/json

{"resultCode": 0,
"resultMessage": "string"
}

Статус платежа

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

orderId	string Идентификатор заказа в торговой точке
paymentId	string Идентификатор платежа в системе

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"paymentId": "string"
}

Response samples

200
400
500

Content type

application/json

{"paymentinfo": {"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"paymentDataType": "CardData",
"state": "CREATED",
"amountAction": 0,
"amountAuthorization": 0,
"currency": "RUB",
"created": "2019-08-24T14:15:22Z",
"rrn": "string",
"approvalCode": "string",
"cardMaskPan": "string",
"cardExpDate": "string"
},
"resultCode": 0,
"resultMessage": "string"
}

Результат выполнения 3dsMethod

Authorizations:

basicAuth

header Parameters

RqUID

required

string

RqUID

Request Body schema: application/json

request

gatewaySessionId required	string <uuid> Идентификатор платежной сессии шлюза
threeDSMethodData required	string Данные, полученные в редиректе после прохождения 3ds method, если редирект не получен, то значение переданное на этапе авторизации
threeDSMethodState required	string Enum: "Y" "N" Y - если получены данные в редиректе от 3DS сервера в течение 10 секунд, N - если данные не получены

Responses

Request samples

Payload

Content type

application/json

{"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"threeDSMethodData": "string",
"threeDSMethodState": "Y"
}

Response samples

200
400
500

Content type

application/json

{"terminalId": "string",
"orderId": "string",
"paymentId": "string",
"amount": 0,
"currency": "RUB",
"rrn": "string",
"approvalCode": "string",
"cardMaskPan": "string",
"cardExpDate": "string",
"registeredCard": {"type": "RegisteredCardData",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": "string"
},
"threeDSData": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"md": "string",
"paReq": "string"
},
"threeDSDataV2": {"gatewaySessionId": "785e5fce-e3e5-411a-af25-0d77de98c22f",
"url": "string",
"threeDSMethodData": "string",
"threeDSMethodURLServer": "string",
"threeDSSessionData": "string",
"creq": "string"
},
"resultCode": 0,
"resultMessage": "string"
}