15. Ежедневная проверка статуса привязки к маркетплейсу с контролем прав

Запрос на проверку прав платформы.

https://my.payanyway.ru/npdapi/getgrantedpermissions

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

Принимаемые параметры:

  • key - (security_key) (строка, до 32-х символов)

  • inn - ИНН самозанятого (строка до 12-ти символов)

  • signature - подпись запроса (строка, до 32-х символов)

Ответ на запрос:

  • requestId - ID запроса (число, до 11-ти знаков)

  • methodName - имя запроса (строка, до 32-х символов)

  • requestStatus - статус запроса - может иметь одно из значений: NEW (создан новый запрос), ACTIVE - запрос сработал, DONE - запрос завершен и NO_MESSAGE_ID (не был получен ID сообщения от АИС “Налог-3” - в этом случае запрос до АИС “Налог-3” будет повторяться автоматически до получения ID сообщения от АИС “Налог-3”, но не более 300-т раз) (строка, до 32-х символов)

  • methodId - ID сообщения от АИС “Налог-3” (строка, до 50-ти символов)

  • debugData - данные для отладки - массив json, имеющий следующую структуру:

    • token - (строка, до 32-х символов)

    • userIdentity - (строка, до 255-ти символов)

  • result - массив json

    • Body - массив json

      • GetMessageResponse - массив json

        • ProcessingStatus - (строка, до 32-х символов)

        • Message - массив json

          • GetGrantedPermissionsResponse - массив json

            • GrantedPermissionsList - массив строк, например: ["CANCEL_INCOME","INCOME_REGISTRATION","PAYMENT_INFORMATION","TAX_PAYMENT"] (до 16384 символов)

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

{
   "requestId":15933,
   "methodName":"getgrantedpermissions",
   "requestStatus":"ACTIVE",
   "methodId":"e2d24678-bd7c-4081-8adb-8c36807b278a",
   "debugData":{
      "token":"4bf48104295c41daa5772d7cc2e19102",
      "userIdentity":"aW5zdGE="
   },
   "result":{
      "Body":{
         "GetMessageResponse":{
            "ProcessingStatus":"COMPLETED",
            "Message":{
               "GetGrantedPermissionsResponse":{
                  "GrantedPermissionsList":[
                     "CANCEL_INCOME",
                     "INCOME_REGISTRATION",
                     "PAYMENT_INFORMATION",
                     "TAX_PAYMENT"
                  ]
               }
            },
            "FileLinks":[
               
            ]
         }
      }
   }
}

Данный запрос может выполняться с задержкой по времени. После выполнения придет url-уведомление со следующими параметрами:

  • requestId - ID запроса (число, до 11-ти знаков)

  • requestMessageId - ID сообщения от АИС “Налог-3” (строка, до 50-ти символов)

  • debugData - данные для отладки - массив json, имеющий следующую структуру:

    • token - (строка, до 32-х символов)

    • userIdentity - (строка, до 255-ти символов)

  • result - массив json

    • Body - массив json

      • GetMessageResponse - массив json

        • ProcessingStatus - (строка, до 32-х символов)

        • Message - массив json

          • GetGrantedPermissionsResponse - массив json

            • GrantedPermissionsList - массив строк, например: ["CANCEL_INCOME","INCOME_REGISTRATION","PAYMENT_INFORMATION","TAX_PAYMENT"] (до 16384 символов)

Пример url-уведомления:

{
   "requestId":15933,
   "requestMessageId":"e2d24678-bd7c-4081-8adb-8c36807b278a",
   "result":{
      "Body":{
         "GetMessageResponse":{
            "ProcessingStatus":"COMPLETED",
            "Message":{
               "GetGrantedPermissionsResponse":{
                  "GrantedPermissionsList":[
                     "CANCEL_INCOME",
                     "INCOME_REGISTRATION",
                     "PAYMENT_INFORMATION",
                     "TAX_PAYMENT"
                  ]
               }
            },
            "FileLinks":[
               
            ]
         }
      }
   },
   "debugData":{
      "token":"4bf48104295c41daa5772d7cc2e19102",
      "userIdentity":"aW5zdGE="
   }
}

Минимально необходимое для работы право: INCOME_REGISTRATION.

Last updated