3.6. /api/v2/capture

Введение

Списание инициируется через запрос HTTPS POST на указанный ниже URL с использованием указанных параметров. Для аутентификации запроса используется SHA-1. Списание может быть вызвано только по предавторизации в конечном успешном статусе. См. Статусы транзакций.

API URL

Интеграционная среда

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

https://sandbox.payneteasy.com/paynet/api/v2/capture/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/capture/ENDPOINTID

https://sandbox.payneteasy.com/paynet/api/v2/capture/group/ENDPOINTGROUPID

https://gate.payneteasy.com/paynet/api/v2/capture/group/ENDPOINTGROUPID

Параметры запросаs

Note

Request must have content-type=application/x-www-form-urlencoded.

Параметры запроса

Описание

login

Логин Присоединяющейся Стороны

client_orderid

Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.

orderid

Номер заказа в системе Payneteasy

currency

Валюта, в которой проводится операция (см. Коды валют). Примеры значений: USD для доллара США, EUR для европейского евро, RUB для российского рубля.

amount

Сумма к оплате. Сумма должна быть указана в минимальных единицах с “.” разделителем. Например, 100.5 в RUB означает 100 российских рублей и 50 копеек. Если параметр не отправлен, сумма списания будет соответствовать сумме предавторизации.

control

Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. Параметр запроса: login.
2. Параметр запроса: merchant-order-id.
3. Параметр запроса: paynet-order-id.
4. Параметр запроса: amount в минимальных денежных единицах (если отправлен).
5. Параметр запроса: currency (если отправлена сумма).
6. merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в Payneteasy).

Параметры ответа

Note

Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра.

Параметры ответа

Описание

type

Тип ответа. Может принимать такие значения как - async-response, validation-error, error и т.д. Если тип - validation-error или error, параметры error, error-message и error-code будут содержать детали ошибки.

paynet-order-id

Номер заказа в системе gate.payneteasy.com.

merchant-order-id

Номер заказа в системе Присоединяющейся Стороны.

serial-number

Уникальный номер, присвоенный сервером Payneteasy конкретному запросу от Присоединяющейся Стороны.

error-message

Для транзакций в статусе error этот параметр будет содержать причину отклонения или сведения об ошибке.

error-code

Код ошибки для транзакций в статусе error.

end-point-id

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

Пример ответа

POST /paynet/api/v2/capture/39914 HTTP/1.1
Host: sandbox.payneteasy.com
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 119
Content-Type: application/x-www-form-urlencoded
Connection: close

login=TestMerchant
&client_orderid=902B4FF5
&orderid=6863088
&amount=345
&currency=USD
&control=da832c0fcff0105728e26465d5f99e6f83179a45

Пример успешного ответа

HTTP/1.1 200 OK
Server: server
Date: Mon, 22 Aug 2022 13:15:19 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: 140

type=async-response
&serial-number=00000000-0000-0000-0000-000002ddb06a
&merchant-order-id=902B4FF5
&paynet-order-id=6863088
&end-point-id=37211

Пример неуспешного ответа

HTTP/1.1 200 OK
Server: server
Date: Mon, 22 Aug 2022 12:59:09 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: 154

pe=validation-error
&serial-number=00000000-0000-0000-0000-000002ddb06b
&error-message=Can+not+make+capture+for+order+state+AUTH_3D_VALIDATING
&error-code=27

Коллекция Postman

Конструктор запросов

endpointid or groupid

input ENDPOINTID or ENDPOINTGROUPID

login
client_orderid

input Invoice Number

orderid
amount
currency
merchant_control

input Control Key

String to sign
Signature