PayQR. Справочник API

Получить счет

Метод для получения счета на оплату.

Метод реализован в синхронном режиме. Ответ на запрос приходит со статусом 200. Если счет на оплату не найден, то возвращается статус 404.

Пример команды:

GET https://payqr.ru/shop/api/1.0/invoices/<id объекта invoice>

Пример

curl -v -X GET -H "PQRSecretKey: k%H5xeaba75vkEMt4aA&" "https://payqr.ru/shop/api/1.0/invoices/inv_gKSaFJxIv8xydXdHl3f5qm"

{
  "object": "invoice",
  "id": "usr_inv_gKSaFJxIv8xydXdOl3f4fm",
  "payqrNumber": "3334445556667778",
  "created": "2015-03-17T15:24:04.311+03:00",
  "modified": "2015-05-17T17:10:08.107+03:00",
  "livemode": true,
  "payqrUserId": "000000000007",
  "scenario": "buy",
  "amount": 1000.00,
  "orderId": "26XGV91",
  "orderGroup": "",
  "cart": [{
    "article": "jl1uayq8",
    "name": "Историческая Книга",
    "imageUrl": "http://www.modastuff.ru/books/history-200x200.jpg",
    "quantity": "1",
    "amount": 650,
    "category": ""
  }],
  "customer": {
    "firstName": "Степан",
    "middleName": "Степанович",
    "lastName": "Степанов",
    "phone": "8-926-000-11-11",
    "email": "mail@mail.ru"
  },
  "delivery": {
    "country": "Россия",
    "region": "Москва",
    "city": "Москва",
    "zip": "115059",
    "street": "Партийный переулок",
    "house": "1",
    "unit": "46",
    "building": "",
    "flat": "217",
    "hallway": "",
    "floor": "4",
    "intercom": "",
    "comment": "Предварительно позвонить",
    "longitude": 37.237400,
    "latitude": 115.809000,
    "kladrId": "77000000000222600"
  },
  "deliveryСasesSelected": {
    "article": "eliv01_Sl",
    "name": "Срочная доставка курьером",
    "description": "Экспресс-доставка в течение часа",
    "amountFrom": 350,
    "amountTo": 350
  },
  "pickPointsSelected": {},
  "promoCode": {
    "article": "bunuscode",
    "description": "Промо-код",
    "value": "0000111100001111"
  },
  "promoCard": {
    "article": "malinacard",
    "description": "Карта лояльности",
    "value": "9999000099990000"
  },
  "message": {
    "article": "thanxmes",
    "text": "Спасибо за заказ! Доставка будет осуществлена в течение 01:00. Телефон справочной службы: +7 (495) 669-67-56.",
    "imageUrl": "http://modastuff.ru/thanks.jpeg",
    "url": "http://modastuff.ru"
  },
  "upSale": {
    "article": "Gsv2mX93kdhsi2",
    "name": "Конституция Российской Федерации",
    "imageUrl": "http://www.modastuff.ru/books/constitut-300x300.jpg",
    "quantity": "1",
    "amount": 500,
    "category": ""
  },
  "pollSelected": {},
  "userData": "82nZJKAKq2yyXU_1oQp2lffS",
  "validityInMinutes": 10080,
  "confirmWaitingInMinutes": 4320,
  "status": "paid",
  "confirmStatus": "transfered",
  "reverts": []
}

Атрибуты

id: строка

Досрочно подтвердить оплату

Предназначение:
Досрочно подтвердить оплату счета на оплату, не дожидаясь достижения момента автоматического подтверждения оплаты в соответствии со значением параметра confirmWaitingInMinutes, если оно было больше 0 (никогда не может превышать 4320, то есть три календарных дня).

Исполнить данную операцию можно только по счету на оплату со значением paid или revertedPartially в параметре status и со значением waiting в параметре confirmStatus.

Пример команды:

POST https://payqr.ru/shop/api/1.0/invoices/<id объекта invoice>/pay/confirm

Пример

curl -v -X POST -H "PQRSecretKey: k%H5xeaba75vkEMt4aA&" "https://payqr.ru/shop/api/1.0/invoices/inv_gKSaFJxIv8xydXdHl3f5qm/pay/confirm" -d

{
  "object": "invoice",
  "id": "usr_inv_gKSaFJxIv8lydXdHl3f5qm",
  "created": "2015-03-17T15:24:04.311+03:00",
  "modified": "2015-05-17T16:10:08.107+03:00",
  "livemode": true,
  "confirmStatus": "confirmedEarly"
}

Атрибуты

id: строка
ИД счета на оплату.

Направить сообщение

Предназначение:
Дослать/изменить сообщение по тому или иному объекту PayQR «Счет на оплату». Исполнить данную операцию можно только по счету на оплату со значением ordered, paid, revertedPartially или reverted в параметре status.

По одному счету на оплату можно направлять неограниченное количество сообщений, но возможность дослать/изменить сообщение сохраняется только в течение шести календарных месяцев, то есть 259200 минут с момента создания того или иного счета на оплату (с даты, указанной в значении параметра created).

Пример команды:

PUT https://payqr.ru/shop/api/1.0/invoices/<id объекта invoice>/message/ <объект message>

Пример

curl -v -XPUT -H "PQRSecretKey: k%H5xeaba75vkEMt4aA&" -H "Content-Type: application/json" "https://payqr.ru/shop/api/1.0/invoices/inv_gKSaFJxIv8xydXdHl3f5qm/message-d" '{\"article\": \"thanxmes\", \"text\": \"Спасибо за заказ! Доставка будет осуществлена в течение 01:00. Телефон службы заботы и поддержки клиентов: +7 (495) 669-67-56.\", \"imageUrl\": \"http://modastuff.ru/thanks.jpeg\", \"url\": \"http://modastuff.ru\" }'

{
  "object": "invoice",
  "id": "usr_inv_gKSaFJxIv8xydXdOl3f4fm",
  "created": "2015-03-17T15:24:04.311+03:00",
  "modified": "2015-05-17T17:10:08.107+03:00",
  "livemode": true,
  "message": {
    "article": "thanxmes",
    "text": "Спасибо за заказ! Доставка будет осуществлена в течение 01:00. Телефон справочной службы: +7 (495) 669-67-56.",
    "imageUrl": "http://modastuff.ru/thanks.jpeg",
    "url": "http://modastuff.ru"
  },
  "status": "reverted"
}

Атрибуты

id: строка
ИД счета на оплату.

Отменить до оплаты

Предназначение:
Предотвратить совершение списания денежных средств по конкретному объекту PayQR «Счет на оплату» и удалить соответствующий счет на оплату из мобильного приложения PayQR того или иного покупателя/плательщика (из его доступных для завершения счетов на оплату).

То же самое произойдет со счетом на оплату автоматически, когда будет достигнут срок, указанный в значении его параметра validityInMinutes. Требуется тогда, когда получателю денежных средств становится известно, что исполнить определенный заказ он не сможет (например, закончился товар на складе).

Исполнить данную операцию можно только по счету на оплату со значением personalized, ordered или paying в параметре status. Если данная операция будет исполнена, параметр statusпримет значение cancelled, а получатель денежных получит уведомление о событии invoice.cancelled от PayQR.

Пример команды:

POST https://payqr.ru/shop/api/1.0/invoices/<id объекта invoice>/cancel

Пример

curl -v -X   POST -H   "PQRSecretKey:   k%H5xeaba75vkEMt4aA&"  "https://payqr.ru/shop/api/1.0/invoices/inv_gKSaFJxIv8xydXdHl3f5qm/cancel" -d

{
  "object": "invoice",
  "id": "usr_inv_gKSaFJxIv8tgfXdHl3f5qm",
  "created": "2015-03-17T15: 24: 04.311+03: 00",
  "modified": "2015-05-17T18: 10: 08.107+03: 00",
  "livemode": true,
  "status": "cancelled"
}

Атрибуты

id: строка
ИД счета на оплату.

Отменить после оплаты

Предназначение:
Осуществить возврат той или иной суммы по объекту PayQR«Счет на оплату», по которому уже было обработано списание денежных средств с пользователя PayQR, то есть отменить счет на оплату после его полной оплаты.

Такой возврат можно осуществлять как на всю сумму счета на оплату (полный), так и на ее часть (частичный). По одному объекту «Счет на оплату» можно осуществлять неограниченное количество возвратов в пределах значения его параметра amount.

Исполнить данную операцию можно только по счету на оплату со значением paid или revertedPartially в параметре status. Когда сумма обработанных возвратов по тому или иному счету на оплату станет равна значению его параметра amount, параметр status этого счета на оплату примет значение reverted, а получатель денежных получит уведомление о событии invoice.reverted от PayQR.

Пример команды:

POST https://payqr.ru/shop/api/1.0/invoices/<id объекта invoice>/revert?amount=<сумма возврата>

Пример

curl -v -X POST -H "PQRSecretKey: k%H5xeaba75vkEMt4aA&" "https://payqr.ru/shop/api/1.0/invoices/inv_gKSaFJxIv8xydXdHl3f5qm/revert?amount=10" -d

{
  "object": "invoice",
  "id": "usr_inv_0lSaM2xIv8xydXdHl3f5qm",
  "created": "2015-03-17T15:24:04.311+03:00",
  "modified": "2015-05-17T19:10:08.107+03:00",
  "livemode": true,
  "amount": 13000.00,
  "status": "revertedPartially",
  "reverts": [{
    "id": "rvt_hBNxk8ktYrHb58B2jCurOG"
  }]
}

Атрибуты

id: строка
ИД счета на оплату.
amount: число
Сумма возврата.
Если не указана, то полный возврат.

Методы для счетов

Получить счет

Атрибуты

Досрочно подтвердить оплату

Атрибуты

Направить сообщение

Атрибуты

Отменить до оплаты

Атрибуты

Отменить после оплаты

Атрибуты