Списание заблокированной/холдированной суммы (Settle)

Запрос Settle используется для подтверждение списания платежа Auth. Результатом обработки запроса является списание заблокированных ранее денежных средств с карты клиента. Операция доступна для транзакций Purchase и Charge(host-2-host) с типом merchantTr2483ansactionType = AUTH.

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

Запрос c необходимыми параметрами формируется на стороне торговца и передается методом POST по протоколу HTTP на URL https://api.wayforpay.com/api

В целях подтверждения валидности данных должна быть сгенерирована и передана в запросе HMAC_MD5 контрольная подпись с использованием SecretKey торговца.

Строка, подлежащая HMAC_MD5, генерируется путем конкатенации парамаетров merchantAccount, orderReference, amount, currency разделенных “;” (точка с запятой) в кодировке UTF-8

 

 

Параметр

Описание

Обязательное

transactionType

Тип запроса, принимает значение SETTLE

да

merchantAccount

Уникальный идентификатор продавца.

да

orderReference

Уникальный номер заказа в системе торговца

да

amount

Сумма подтверждения списания

да

currency

Валюта списания

да

merchantSignature

Подпись запроса

да

apiVersion

Версия протокола.

Значание по-умолчанию: 1

да

 

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

Строка, подлежащая HMAC_MD5, генерируется путем конкатенации параметров merchantAccount, orderReference, transactionStatus, reasonCode разделенных “;” (точка с запятой) в кодировке UTF-8

 

Параметр

Описание

Пример

merchantAccount

Идентификатор продавца

test_merch_n1

orderReference

Уникальный номер заказа в системе торговца

1212dd1

merchantSignature

hash_hmac

 

amount

Сумма подтверждения списания заблокированных средств.

Сумма может быть ≤ сумме AUTH

100

currency

Валюта

UAH

authCode

код авторизации - присваивается банком

324567

createdDate

дата создания запроса в psp

123456789

processingDate

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

12345678

cardPan

маскированный номер карты

42****4242

cardType

типа карты: Visa/MasterCard

Visa

issuerBankCountry

Страна карты

980

issuerBankName

Имя Банка карты

PrivatBank

recToken

токен платежа для рекаренговых списаний

121213321-3213213-3213213-321-3

transactionStatus

статус транзакции

Approved

reason

Причина отказа

Ok

reasonCode

Код отказа

1100

fee

Комиссия psp

0.00

paymentSystem

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

card

 

Пример запроса и ответа

Запрос:
{
"transactionType":"SETTLE",
"merchantAccount":"test_merchant",
"orderReference":"DH783023",
"amount":100,
"currency":"UAH",
"merchantSignature":"b95932786cbe243a76b014846b63fe92",
"apiVersion":1
}

 

Ответ:
{
"merchantAccount":"test_merch_n1",
"orderReference":"DH783023",
"merchantSignature":"",
"amount":100,
"currency":"UAH",
"authCode":"541963",
"createdDate":12345678,
"processingDate":12345678,
"cardPan":"41****8217",
"cardType":"visa",
"issuerBankCountry":"980",
"issuerBankName":"Privatbank",
"recToken":"",
"transactionStatus":"Approved",
"reason":"ok",
"reasonCode":"1100",
"fee":0,
"paymentSystem":"card"
}