Перейти к содержанию

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

Алгоритм подписи

Параметр signature в create order запросе и ответе, а также в callbacks генерируется с помощью функции sha1. К строке, содержащей секретный ключ платежа мерчанта и все Параметры запроса или ответа, сгруппированные в алфавитном порядке и разделенные символом |.

Пример

Запрос мерчанта:

curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.payme.uz/api/checkout/url'

Строка, используемая для построения подписи:

test|1000|UZS|4056281|Test payment|TestOrder2|http://myshop/callback/

Где test — это секретный ключ платежей из тестовых данных test data

Если параметр отсутствует или пуст, нет необходимости добавлять символ |.

Пример проверки подписи для ответа POST на response_url и server_callback_url:

namespace Ipsp;
/**
 * Class Signature
   * @package Ipsp
   */
class Signature {
      /**
       * @var
       */
      private static $password;
      /**
       * @var
       */
      private static $merchant;
      /**
       * Set merchant password
       * @param String $password
       * @return mixed
       */
      public static function password($password){
          self::$password = $password;
      }
      /**
       * Set merchant id
       * @param String $merchant
       * @return mixed
       */
      public static function merchant( $merchant ){
          self::$merchant = $merchant;
      }
      /**
       * Generate request params signature
       * @param array $params
       * @return string
       */
      public static function generate(Array $params){
          $params['merchant_id'] = self::$merchant;
          $params = array_filter($params,'strlen');
          ksort($params);
          $params = array_values($params);
          array_unshift( $params , self::$password );
          $params = join('|',$params);
          return(sha1($params));
      }
      /**
       * Sign params with signature
       * @param array $params
       * @return array
       */
      public static function sign(Array $params){
          if(array_key_exists('signature',$params)) return $params;
          $params['signature'] = self::generate($params);
          return $params;
      }
      /**
       * Clean array params
       * @param array $data
       * @return array
       */
      public static function clean(Array $data){
          if( array_key_exists('response_signature_string',$data) )
              unset( $data['response_signature_string'] );
          unset( $data['signature'] );
          return $data;
      }
      /**
       * Check response params signature
       * @param array $response
       * @return bool
       */
      public static function check(Array $response){
          if(!array_key_exists('signature',$response)) return FALSE;
          $signature = $response['signature'];
          $response  = self::clean($response);
          return $signature == self::generate($response);
      }
}
from hashlib import sha1

def get_signature(secret_key, params):
    """
    :param secret_key: merchant secret
    :param params: POST parameters
    :return: signature string
    """
    data = [secret_key]
    data.extend([str(params[key]) for key in sorted(iter(params.keys()))
                 if params[key] != '' and not params[key] is None
                 and key != 'signature'])
    return sha1('|'.join(data).encode('utf-8')).hexdigest()

Решение проблем с генерацией и проверкой кодов signature

Существует два типичных случая, когда возникает ошибка проверки параметра signature.

Случай 1: в ответ на вызов API Payme

При запросе на создание заказа, отмену, получение статуса или любом другом запросе с параметром signature отправляется от мерчанта к API Payme, и возвращается ответ:

    {
        "response": {
            "error_code": 1014,
            "error_message": "Invalid signature",
            "request_id": "3mwpcKoenYZ0w",
            "response_status": "failure"
        }
    }

Если запрос отправляется в API Payme, а ответ возвращается как "error_message": "Invalid signature", Выполните следующие проверки:

  • Убедитесь, что вы использовали правильный секретный ключ платежей

  • если запрос содержит нелатинскую кодировку, то он отправляется в кодировке UTF-8

  • Убедитесь, что параметр со значением 0 не является нулевым в вашем языке программирования

  • Запишите в журнал строку в программном коде, к которой вы применяете SHA1 при генерации параметра подписи. Сравните её со строкой, возвращаемой в тексте ошибки (отмеченной красным): “Invalid signature signature: 6bd069be8a6e2f2bbe176df00ba63cc681ca38aa ; response_signature_string: **********|125|UZS|4056281|demo order 789|Demo123456 “. Обратите внимание, что в тексте ошибки Платежный ключ мерчанта будет замаскирован символом *

  • Проверьте, отправляете ли вы пустые параметры в запросе API. Если да, то в строке, участвующей в подписи, | Символ разделителя для каждого такого пустого параметра включать не нужно

  • Если вы разрабатываете на языке программирования PHP, воспользуйтесь примером функции php-inline public static function generate(Array $params):

  • Убедитесь, что результат функции SHA1 написан строчными буквами. Правильно: 6bd069be8a6e2f2bbe176df00ba63cc681ca38aa. Неправильно: 6BD069BE8A6E2F2BBE176DF00BA63CC681CA38AA

  • Убедитесь, что параметр signature не включен в расчет вашей подписи

  • Убедитесь, что при использовании конечной точки API /api/recurring, вы включаете в подпись только необходимые параметры, но не те, что из конечной точки /api/redirect

Случай 2: в обратном вызове на server_callback_url или перенаправлении на response_url

Когда сервер Paymeвернул ответ POST или обратный вызов на server_callback_url или response_url и вы пытаетесь сгенерировать собственную подпись и сравнить её с параметром signature из ответа POST, signatures, не совпадают

Если API Paymeвернул ответ POST на страницы, указанные в server_callback_url или response_url параметры, но когда вы пытаетесь сгенерировать подпись и сравнить её с параметром signature в ответе POST, подпись не совпадает

{
    "response": {
        "rrn": "",
        "masked_card": "",
        "sender_cell_phone": "",
        "sender_account": "",
        "currency": "UZS",
        "fee": "",
        "reversal_amount": "0",
        "settlement_amount": "0",
        "actual_amount": "",
        "response_description": "",
        "sender_email": "",
        "order_status": "expired",
        "response_status": "success",
        "order_time": "28.02.2018 19:18:16",
        "actual_currency": "",
        "order_id": "TestOrder2",
        "tran_type": "purchase",
        "eci": "",
        "settlement_date": "",
        "payment_system": "",
        "approval_code": "",
        "merchant_id": 4056281,
        "settlement_currency": "",
        "payment_id": 83456044,
        "card_bin": "",
        "response_code": "",
        "card_type": "",
        "amount": "1000",
        "signature": "268b8f189f97c85696134fe6ae0f7f5ab93f28d5",
        "product_id": "",
        "merchant_data": "",
        "rectoken": "",
        "rectoken_lifetime": "",
        "verification_status": "",
        "parent_order_id": "",
        "fee_oplata": "0",
        "additional_info": "{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": null, \"transaction_id\": null, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": null, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": null, \"card_product\": null, \"card_category\": null, \"timeend\": \"01.03.2018 05:18:17\", \"ipaddress_v4\": \"52.30.149.20\", \"payment_method\": null}",
        "response_signature_string": "**********|{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": null, \"transaction_id\": null, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": null, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": null, \"card_product\": null, \"card_category\": null, \"timeend\": \"01.03.2018 05:18:17\", \"ipaddress_v4\": \"52.30.149.20\", \"payment_method\": null}|1000|UZS|0|4056281|TestOrder2|expired|28.02.2018 19:18:16|83456044|success|0|0|purchase"
    }
}

Чтобы определить причину несоответствия подписи, выполните следующие действия:

  • Убедитесь, что параметр со значением 0 не преобразуется в пустую строку или значение null в вашем языке программирования
  • Убедитесь, что параметры response_signature_string и signature не включены в расчет подписи ( Параметр response_signature_string возвращается только в том случае, если мерчант находится в тестовом режиме, и содержит подсказку о том, как формируется подпись была создана в ответ)
  • если запрос содержит нелатинские символы, то он отправляется в кодировке UTF-8
  • В программном коде выделите строку, к которой вы применяете SHA1 при формировании параметра подписи. Сравните результат с строкой, возвращаемой в параметре response_signature_string
  • Проверьте, возвращаются ли в ответе пустые параметры. Если да, то в строке, которая участвует в подписи, Нет необходимости включать разделитель символов | для каждого пустого параметра
  • Убедитесь, что результат функции SHA1 написан строчными буквами. Правильно: 6bd069be8a6e2f2bbe176df00ba63cc681ca38aa. Неправильно: 6BD069BE8A6E2F2BBE176DF00BA63CC681CA38AA