3.3. /api/v2/create-card-ref
Введение
Регистрация ссылочного идентификатора инициируется через запрос HTTPS POST на указанный ниже URL с использованием указанных параметров. Для аутентификации запроса используется SHA-1. См. Статусы транзакций.
API URL
Интеграционная среда |
Производственная среда |
|---|---|
https://sandbox.connpay.com/paynet/api/v2/create-card-ref/ENDPOINTID |
https://gate.connpay.com/paynet/api/v2/create-card-ref/ENDPOINTID |
https://sandbox.connpay.com/paynet/api/v2/create-card-ref/group/ENDPOINTGROUPID |
https://gate.connpay.com/paynet/api/v2/create-card-ref/group/ENDPOINTGROUPID |
Параметры запроса
Note
Параметры запроса |
Описание |
|---|---|
login |
Логин Присоединяющейся стороны в Системе.
|
client_orderid |
Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.
|
orderid |
Идентификатор заказа, присвоенный Платёжным Шлюзом.
|
control |
Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. Параметр запроса: login
2. Параметр запроса: client_orderid
3. Параметр запроса: orderid
4. merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в ConnPay).
|
Присоединяющаяся сторона должна предоставить orderid и client_orderid первого платежа. Это подчеркивает необходимость проведения первого платежа для последующей регистрации платёжного метода и повторных оплат. Для списания средств информация о платёжном методе должна быть полной и первый платёж должен быть в финальном статусе.
Параметры ответа
Note
Параметры ответа |
Описание |
|---|---|
type |
Тип ответа. Может принимать такие значения как - async-response, validation-error, error и т.д.
Если тип равен validation-error или error, параметры error-message и error-code будут содержать сведения об ошибке.
|
serial-number |
Уникальный номер, присвоенный сервером ConnPay конкретному запросу от Присоединяющейся Стороны. |
card-ref-id |
Ссылочный идентификатор, для использования в повторных оплатах. |
unq-card-ref-id |
Уникальный ссылочный идентификатор для каждого уникального средства платежа (PAN, номер аккаунта). Может использоваться Присоединяющейся стороной для программ лояльности или защиты от мошенничества. |
status |
См. список статусов.
|
error-message |
Для транзакций в статусе declined или error этот параметр будет содержать причину отклонения или сведения об ошибке. |
error-code |
Код ошибки для транзакций в статусе declined или error. |
Пример запроса
POST /paynet/api/v2/create-card-ref/46750 HTTP/1.1
Host: https://sandbox.connpay.com
User-Agent: curl/7.85.0
Accept: */*
Content-Length: 100
Content-Type: application/x-www-form-urlencoded
Connection: close
login=login
&client_orderid=902B4FF5
&orderid=6937242
&control=717349cab3fcab2c13c93ff5770ae07a7b8e0727
Пример успешного ответа
HTTP/1.1 200
Server: server
Date: Tue, 07 Feb 2023 08:46:24 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 144
type=create-card-ref-response
&serial-number=00000000-0000-0000-0000-000002e110a2
&card-ref-id=1461670
&unq-card-ref-id=2463777
&status=approved
Пример неуспешного ответа
HTTP/1.1 200
Server: server
Date: Tue, 07 Feb 2023 08:55:26 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 123
type=validation-error
&serial-number=00000000-0000-0000-0000-000002e110ad
&error-message=INVALID_CONTROL_CODE
&error-code=2
Коллекция Postman
Конструктор запросов
| String to sign |
|---|
| Signature |
|---|
|