Skip to content

README.MERCHANT_API.md

Latest commit

 

History

History
227 lines (159 loc) · 4.03 KB

README.MERCHANT_API.md

File metadata and controls

227 lines (159 loc) · 4.03 KB

CURL API Examples

Формат запроса

Все POST-запросы должны содержать json и content-type должен быть указан application/json

Формат ответа

Ответ содерржи несколько полей:

  • payload - данные соответствующие запросу
  • status - статус ответа, см. список статусов ответа

Account

[POST] /api/v1/users - User Registration

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

  • email
  • password
  • mobile_phone - TODO

Request

curl 'http://merchant.rocketpay.ru/api/v1/users' \
    -X POST \
    -H 'Content-Type: application/json' \
    -d '{"email": "example@email.com", "password": "password"}'

Response

{}

[POST] /api/v1/users/password_reset - Password reset

Отправка кода на email или sms

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

  • email
  • mobile_phone - TODO

Request

curl 'http://merchant.rocketpay.ru/api/v1/users/password_reset' \
    -X POST \
    -H 'Content-Type: application/json' \
    -d '{"email": "example@email.com"}'

или

curl 'http://merchant.rocketpay.ru/api/v1/users/password_reset' \
    -X POST \
    -H 'Content-Type: application/json' \
    -d '{"mobile_phone": "79154747270"}'

Response

{}

[PUT] /api/v1/users/password_reset

Если токена

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

  • code
  • password
curl 'http://merchant.rocketpay.ru/api/v1/users/password_reset' \
    -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
        "code": "877739ce-d368-11e8-8b17-87c00c06382d",
        "password": "password"
    }'

Response

{}

Tokens

[POST] /api/v1/tokens - Create new Token

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

  • email
  • password
  • mobile_phone - TODO
curl 'http://merchant.rocketpay.ru/api/v1/tokens' \
    -X POST \
    -H 'Content-Type: application/json' \
    -d '{"email": "example@email.com", "password": "password"}'

Response

{}

Merchants

[GET] /api/v1/merchants - Get Merchants

Request

curl 'http://merchant.rocketpay.ru/api/v1/merchants' \
    -X GET \
    -H 'X-Token: ...'

Response

{}

[POST] /api/v1/merchants - Create merchant

Request

curl 'http://merchant.rocketpay.ru/api/v1/merchants' \
    -X POST \
    -H 'Content-Type: application/json' \
    -H 'X-Token: ...' \
    -d '{"email": "example@email.com", "password": "password"}'

Response

{}

[PUT] /api/v1/merchants/{int:merchant_id} - Update merchant details

Request

curl 'http://merchant.rocketpay.ru/api/v1/merchants/1' \
    -X PUT \
    -H 'X-Token: ...' \
    -H 'Content-Type: application/json' \
    -d '{"url_website": "https://gocloud.ru"}'

Response

{}

Reports

Настройка отчетов. Механизм отправки реестров платежей для проведения сверки.

[GET] /api/v1/merchants/{int:merchant_id}/reports

Вывод текущих настроек отправки реестров платежей.

Описание полей ответа

  • enable: integer. 1 - включено, 0 - выключено.
  • email: string. адрес электронной почты.
  • frequency: enum. day, week, month
  • format: enum. xml, cvs

Request

curl 'http://merchant.rocketpay.ru/api/v1/merchants/1/reports' \
    -X GET \
    -H 'X-Token: ...'

Response

{
    "payload": {
        "email": "test@rocketpay.ru",
        "frequency": "day",
        "format": "xml"
    },
    ...
}

[PUT] /api/v1/merchants/{int:merchant_id}/reports

Request

curl 'http://merchant.rocketpay.ru/api/v1/merchants/1/reports' \
    -X PUT \
    -H 'X-Token: ...' \
    -H 'Content-Type: application/json' \
    -d '{"enable": 1}'

Response

{}