Поиск транзакций Вход Регистрация

API интеграция

Авторизация

Для того чтобы обратиться к нужным методам, вам необходимо в заголовке Authorization передавать токен:

Authorization: Bearer <token>

Иначе сервер вернет ошибку авторизации 401.

Токен вы можете получить на странице API интеграций в личном кабинете

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

curl-X GET https://palych.io/api/v1/payment/status?id=lGPmp4mYeE \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен

Пример ответа с ошибкой

{
  "message": "Unauthenticated."
}

Смена токена

В случае, когда вам нужно изменить токен, вы можете сделать это в Личном кабинете.

Для этого вам нужно зайти на страницу API интеграция и нажать на "Обновить API токен".

POST /api/v1/bill/create

Для того чтобы провести оплату необходимо создать счет. Если тип счета многоразовый, то по одному счету можно произвести несколько платежей.

Домен в shop_url должен совпадать с доментом success_url и fail_url.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
amount да decimal     123.45 Сумма платежа.
order_id нет string     321 Уникальный идентификатор заказа. Будет возвращен в postback.
description нет string     Оплата заказа №321 Описание платежа
type нет enum   normal
multi
normal Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится.
shop_id да string     LXZv3R7Q8B Уникальный идентификатор магазина, к которому относится платеж. Без этого параметра не будет работать Success URL, Fail URL и Result URL
currency_in нет enum RUB
USD
EUR
RUB Валюта, в которой оплачивается счет. Если не передана, то используется валюта магазина. Если shop_id не определен, то используется RUB.
custom нет string     любая строка/json Произвольное поле. Будет возвращено в postback.
payer_pays_commission нет enum 1   1 или 0 Параметр, который указывает на то, кто будет оплачивать комиссию за входящий платёж.
payer_email нет string     [email protected] Параметр, который заполняет email клиента на платёжно странице.
name нет string   Донат любая строка Название ссылки. Укажите, за что принимаете средства. Этот текст будет отображен в платежной форме.
success_url нет string     https://exmpl/order_321/success Страница успешной оплаты.
fail_url нет string     https://exmpl/order_321/fail Страница неуспешной оплаты.

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

Название параметра Тип Формат Возможные значения Пример Описание
success bool   true/false true Флаг успешности запроса
link_url string URL   https://palych.io/link/5QWlqB2kKJ Ссылка на страницу с QR кодом
link_page_url string URL   https://palych.io/transfer/5QWlqB2kKJ Ссылка на оплату
bill_id string     5QWlqB2kKJ Уникальный идентификатор счета.

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

curl -X POST 'https://palych.io/api/v1/bill/create'
-H 'Authorization: Bearer 69|oBCB7Z3SmUm1gvkpEdScSR2q1ERHpG4vD3DNBmuT' \
-d 'amount=100.05' \
-d 'description=Some desc' \
-d 'order_id=15' \
-d 'type=multi' \
-d 'shop_id=EG8Rz' \
-d 'custom=123' \
-d 'currency_in=RUB' \

Ответ

{
  "success": "true",
  "link_url": "https://palych.io/link/GkLWvKx3",
  "link_page_url": "https://palych.io/transfer/GkLWvKx3",
  "bill_id": "GkLWvKx3"
}

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.invalid_amount Неверная сумма
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.merchant_not_found Мерчант не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.shop_not_found Магазин не найден
403 api:error.shop_not_enabled Магазин имеет не активный статус
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.rate-not-found Направление недоступно
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка

POST /bill/toggle_activity

Статья рассказывает, как использовать api для активации и деактивации счета (платежной ссылки).
Для авторизации в api используется merchant token.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
id да string

LXZv3R7Q8B Уникальный идентификатор счета
active да bool
0
1
0 0 - деактивировать счет
1 - активировать счет

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

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор счета
active bool
true/false true Флаг активности счета
status enum
NEW
PROCESS
UNDERPAID
SUCCESS
OVERPAID
FAIL
NEW Статус счета
amount decimal

24600.05 Сумма, на которую выставлен счет
type enum
MULTI
NORMAL
MULTI Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится.
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания счета
currency_in enum
USD
RUB
EUR
USD Валюта, в которой оплачивается счет.
success bool
true/false true Флаг успешности запроса

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

curl -X POST 'https://palych.io/api/v1/bill/toggle_activity' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'id=LXZv3R7Q5B' \
-d 'active=1'

Ответ

{
 "id": "LXZv3R7Q5B",
 "activity": "false",
 "status": "NEW",
 "type": "MULTI",
 "amount": 100.05,
 "currency_in": "USD",
 "created_at": "2020-11-11 14:46:20",
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
422 api:error.bill_not_found Счет не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.merchant_not_found Мерчант не найден
403 api:error.bill_is_finished Счет уже оплачен (При типе счета "Одноразовый")
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка

GET /api/v1/bill/payments

Используйте этот метод для получения всех платежей по счету.

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

Название параметра

Обязательный параметр

Тип

Формат

Возможные значения

Пример

Описание

id да string

LXZv3R7Q8B Уникальный идентификатор счета

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

Название параметра Тип Формат Возможные значения Пример Описание
data array Payment
cм. описание Payment Информация о платежах
success bool
true/false true Результат выполнения запроса

Payment

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор платежа
bill_id string

5QWlqB2kKJ Уникальный идентификатор счета, к которому принадлежит платеж
status enum
NEW
PROCESS
UNDERPAID
SUCCESS
OVERPAID
FAIL
NEW Статус платежа
amount decimal
24600.05 Сумма платежа
from_card string card
671254******7272 Номер карты, с которой произошла оплата
currency_in enum RUB RUB Валюта, в которой оплачивается счет
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания платежа

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

curl -X GET 'https://palych.io/api/v1/bill/payments?id=LXZv3R7Q8B' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Ответ

{
 "data": [
  {
    "id": "PQX2XD25a0",
    "bill_id": "5QWlqB2kKJ",
    "status": "SUCCESS",
    "amount": 35400,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
  {
    "id": "zeAmwP2d5Q",
    "bill_id": "5QWlqB3kKJ",
    "status": "NEW",
    "amount": 3200,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-18 17:00:00"
  },
  {
    "id": "NDa7lNmdzx",
    "bill_id": "5QWlqB4kKJ",
    "status": "FAIL",
    "amount": 26100,
    "from_card": "553691******4442",
    "currency_in": "RUB",
    "created_at": "2020-10-01 17:00:00"
  }
 ],
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
400 api:error.too_many_payments Запрос пытается получить слишком много платежей.
401 Unauthenticated Неверный API Токен
403 api:error.merchant_not_found Мерчант не найден
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.bill_not_found Счет не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
422 Ошибка валидации входных данных

GET /api/v1/bill/status

Используйте этот метод для проверки статуса счета.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
id да string

LXZv3R7Q8B Уникальный идентификатор счета

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

Bill

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор счета
status enum
NEW
PROCESS
UNDERPAID
SUCCESS
OVERPAID
FAIL
NEW Статус счета
amount decimal

24600.05 Сумма, на которую выставлен счет
type enum
MULTI
NORMAL
MULTI Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится.
currency_in enum RUB RUB Валюта, в которой оплачивается счет
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания счета
success bool
true/false true Флаг успешности запроса

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

curl-X GET 'https://palych.io/api/v1/bill/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Ответ

{
  "id": "LXZv3R7Q5B",
  "status": "NEW",
  "type": "MULTI",
  "amount": 100.05,
  "currency_in": "RUB",
  "created_at": "2020-11-11 14:46:20",
  "success": true
}

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
422 api:error.bill_not_found Счет не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.merchant_not_found Мерчант не найден
422 Ошибка валидации входных данных

GET /api/v1/payment/status

Для того чтобы узнать статус конкретного платежа, используйте этот метод.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
id да string

LXZv3R7Q8B Уникальный идентификатор платежа

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

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор платежа
bill_id string

do5G93m Уникальный идентификатор счета, к которому принадлежит платеж
status enum
NEW
PROCESS
UNDERPAID
SUCCESS
OVERPAID
FAIL
NEW Статус платежа
amount decimal
4204.65 Сумма платежа
commission decimal
423.34 Комиссия
account_amount decimal
RUB Валюта зачисления на баланс
account_currency_code decimal
4204.65 Сумма зачисления на баланс
from_card string card
671254******7272 Номер карты, с которой произошла оплата
currency_in enum RUB RUB Валюта, в которой оплачивается счет
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания платежа
error_code int

400 Код ошибки
error_message string

Превышены лимиты Описание ошибки

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

curl-X GET 'https://palych.io/api/v1/payment/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Ответ

{
 "id": "LXZv3R7Q8B",
 "bill_id": "do5G93m",
 "status": "NEW",
 "amount": 0,
 "from_card": "676454******7272",
 "currency_in": "RUB",
 "created_at": "2020-11-03 06:43:36",
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
422 api:error.payment_not_found Платеж не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.merchant_not_found Мерчант не найден
422 Ошибка валидации входных данных

GET /api/v1/merchant/balance

Статья рассказывает, как и использовать API для получения баланса учётной записи. Для авторизации используется API токен.

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

Нет

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

Название параметра Тип Формат Возможные значения Пример Описание
balances array Balance
cм. Balance описание Информация о балансах
success bool
true/false true Результат выполнения запроса

Balance

Название параметра Тип Формат Возможные значения Пример Описание
currency enum
USD
RUB
EUR
RUB Валюта баланса
balance_available decimal

1000.01 Доступный баланс
balance_locked decimal

900.09 Заблокированный баланс для вывода
balance_hold decimal

200.02 Комиссия

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

curl -X GET 'https://palych.io/api/v1/merchant/balance' \
-H 'Authorization: Bearer 1|gdzr1215Z5EO3nGSVFBGdTG4APuG5tngYCqk69RbdPKYkTfK1LZg2rgakKWx3JI14kKEFLZGwijI'

Ответ

{
  "success": "true",
  "balances": [
   {
    "currency": "RUB",
    "balance_available": "93988.37000000",
    "balance_locked": "0.00000000",
    "balance_hold": "0.00000000"
   }
  ]
}

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
422 api:error.bill_not_found Счет не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.merchant_not_found Мерчант не найден
422 Ошибка валидации входных данных

POST /api/v1/payout/personal/create

Для того чтобы вывести средства с баланса системы необходимо создать выплату. Запрос на выплату может разбиться на несколько выплат в зависимости от используемого аккаунта. В этом случае, в ответе вы получите список с несколькими выплатами.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
amount да decimal

193.85 Сумма выплаты
payout_account_id да string

LXZv3R7Q8B Уникальный идентификатор платежного аккаунта, на который будет произведена выплата.
account_currency нет enum
USD
RUB
EUR
RUB Валюта баланса, с которого необходимо списать средства за выплату.
recipient_pays_commission нет bool
true/false false Параметр отвечающий за то, кто платит комиссию (true-комиссию платит получающий выплату, если false-то комиссия будет вычтена с баланса аккаунта)
order_id нет string

18364 Уникальный идентификатор заказа.

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

Название параметра Тип Формат Возможные значения Пример Описание
data array Payout
cм. Payout описание Информация о выплате
success bool
true/false true Результат выполнения запроса

Payout

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор выплаты
status enum
NEW
MODERATING
PROCESS
SUCCESS
FAIL
ERROR
DECLINED
NEW Статус выплаты
amount decimal
24600.05 Сумма выплаты
account_amount decimal

3651.30Сумма, списанная с баланса
commission decimal

100 Комиссия
commission decimal

10 Комиссия сервиса, в валюте баланса
account_identifier string
671254******7272 Аккаунт, на который производится выплата
currency enum RUB RUB Валюта выплаты
account_currency

RUB RUB Валюта баланса
error_code int

14 Код ошибки
error_message string

Превышены лимиты Описание ошибки
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания выплаты

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

curl -X POST 'https://palych.io/api/v1/payout/personal/create' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'amount=1500' \
-d 'payout_account_id=EG8Rz'

Ответ

{
 "data": [
  {
    "id": "gY37jYr2b6",
    "status": "MODERATING",
    "amount": 1500,
    "commission": 100,
    "account_identifier": "676454******7272",
    "currency": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
 ],
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки
401 Unauthenticated Неверный API Токен
400 api:error.invalid_amount Неверная сумма
400 api:error.merchant_banned Доступ для мерчанта запрещен
400 api:error.merchant_not_found Мерчант не найден
400 api:error.merchant_subscription_inactive Подписка неактивна
400 api:error.merchant_subscription_not_found Мерчант не имеет подписки
400 api:error.payout_account_not_found Платежный аккаунт не найден
400 api:error.payout_account_banned Платежный аккаунт заблокирован
400 api:error.daily_payout_limit_exceeded Превышен дневной лимит для аккаунта
400 api:error.monthly_payout_limit_exceeded Превышен месячный лимит для аккаунта
400 api:error.balance_not_enough Недостаточно баланса для выплаты
400 api:error.direction_not_available Выплата на данный аккаунт недоступна
400 api:error.merchant_not_verified Продавец не прошел верификацию
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка

POST /api/v1/payout/regular/create

Важно: API предоставляется по запросу через службу поддержки.

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

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
amount да decimal

193.85 Сумма отправки
currency да enum
RUB RUB Валюта
account_type да enum
credit_card
qiwi
crypto
sbp
credit_card Тип аккаунта, на который отправляются средства
account_identifier да string
671254******7272
+79123456789
Идентификатор аккаунта в зависимости от account_type:
credit_card - номер карты
qiwi - номер телефона
sbp - номер телефона
account_bank да integer
100000000032 Member ID банка. Только для account_type=sbp. Список доступных банков вы можете получить в этом разделе
card_holder да string
IVAN IVANOV Держатель карты. Для account_type=credit_card. Как указано на карте.
account_network да string
TRX ETH TRX Сеть для отправки криптовалюты/токенов. Для account_type=crypto. TRX - Tron сеть, ETH - Ethereum.
account_currency нет enum
USD
RUB
EUR
USDT
RUB Валюта баланса
recipient_pays_commission нет bool
true/false false Параметр отвечающий за то, кто платит комиссию (true-комиссию платит получающий выплату, если false-то комиссия будет вычтена с баланса аккаунта)
order_id нет string

18364 Уникальный идентификатор заказа.

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

Название параметра Тип Формат Возможные значения Пример Описание
data array  массив Payout
cм. Payout описание Информация об отправке
success bool
true/false true Результат выполнения запроса

Payout

id string

jZqmaPvl9W Уникальный идентификатор выплаты
status enum
NEW
MODERATING
PROCESS
SUCCESS
FAIL
ERROR
DECLINED
NEW Статус выплаты
amount decimal
24600.05 Сумма выплаты
account_amount decimal

3651.30/td> Сумма, списанная с баланса
commission decimal

100 Комиссия
commission decimal

10 Комиссия сервиса, в валюте баланса
account_identifier string
671254******7272 Аккаунт, на который производится выплата
currency enum RUB RUB Валюта выплаты
account_currency

RUB RUB Валюта баланса
error_code int

14 Код ошибки
error_message string

Превышены лимиты Описание ошибки
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания выплаты

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

curl -X POST 'https://palych.io/api/v1/payout/regular/create' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'amount=1500' \
-d 'currency=RUB'\
-d 'account_type=credit_card'\
-d 'account_identifier=4242424242424242'\
-d 'card_holder=IVAN IVANOV'\
-d 'account_currency=RUB'\
-d 'recipient_pays_commission=0'

Ответ

{
 "data": [
  {
    "id": "gY37jYr2b6",
    "status": "MODERATING",
    "amount": 1600,
    "commission": 100,
    "account_identifier": "676454******7272",
    "currency": "RUB",
    "account_amount": null,
    "account_commission": null,
    "account_currency": RUB,
    "created_at": "2020-10-19 17:00:00"
  },
 ],
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки
401 Unauthenticated Неверный API Токен
400 api:error.invalid_amount Неверная сумма
400 api:error.merchant_banned Доступ для мерчанта запрещен
400 api:error.merchant_not_found Мерчант не найден
400 api:error.merchant_subscription_inactive Подписка неактивна
400 api:error.merchant_subscription_not_found Мерчант не имеет подписки
400 api:error.payout_account_not_found Платежный аккаунт не найден
400 api:error.payout_account_banned Платежный аккаунт заблокирован
400 api:error.daily_payout_limit_exceeded Превышен дневной лимит для аккаунта
400 api:error.monthly_payout_limit_exceeded Превышен месячный лимит для аккаунта
400 api:error.balance_not_enough Недостаточно баланса для выплаты
400 api:error.direction_not_available Выплата на данный аккаунт недоступна
400 api:error.merchant_not_verified Продавец не прошел верификацию
422 Ошибка валидации входных данных
403 This action is unauthorized API недоступен продавцу. Обратитесь в службу поддержки.
500 api:error.general_error Внутренняя ошибка

GET /api/v1/payout/status

Получить статус конкретной выплаты/отправки средств.

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

Название параметра Обязательный параметр Тип Формат Возможные значения Пример Описание
id да, если не указан order_id string

LXZv3R7Q8B Уникальный идентификатор выплаты
order_id да, если не указан id string

18364 Уникальный идентификатор заказа.

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

Payout

Название параметра Тип Формат Возможные значения Пример Описание
id string

jZqmaPvl9W Уникальный идентификатор выплаты
status enum
NEW
MODERATING
PROCESS
SUCCESS
FAIL
ERROR
DECLINED
NEW Статус выплаты
amount decimal
24600.05 Сумма выплаты
account_amount decimal

3651.30/td> Сумма, списанная с баланса
commission decimal

100 Комиссия
commission decimal

10 Комиссия сервиса, в валюте баланса
account_identifier string
671254******7272 Аккаунт, на который производится выплата
currency enum RUB RUB Валюта выплаты
account_currency

RUB RUB Валюта баланса
error_code int

14 Код ошибки
created_at datetime Y-m-d H:i:s
2020-10-19 17:00:00 Дата и время создания выплаты

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

curl-X GET 'https://palych.io/api/v1/payout/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Ответ

{
 "id": "lGPmp4mYeE",
 "status": "MODERATING",
 "amount": 1600,
 "commission": 100,
 "account_identifier": "676454******7272",
 "currency": "RUB",
 "account_amount": 1600,
 "account_commission": 100,
 "account_currency": "RUB",
 "created_at": "2020-10-19 17:00:00"
 "success": true
}

Возможные ошибки

Код ответа Ключ ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.merchant_not_found Мерчант не найден
422 api:error.payout_not_found Выплата не найдена
422 Ошибка валидации входных данных

Описание Postback по платежам

В результате выполнения платежа, на result url, указанный в настройках магазина, отправляется POST запрос с информацией о платеже. Запрос отправляется в формате "application/x-www-form-urlencoded".

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

Название параметра Тип Формат Возможные значения Пример Описание
InvId string

193 Уникальный идентификатор заказа, переданный при формировании счета
OutSum decimal

18364 Сумма платежа
Commission decimal
12 Комиссия с платежа
TrsId string
LXZv3R7Q8B Уникальный идентификатор платежа
Status enum SUCCESS
UNDERPAID
OVERPAID
FAIL
SUCCESS Статус платежа
CurrencyIn enum RUB RUB Валюта, в которой оплачивался счет
custom string additional_information Произвольное поле, переданное при формировании счета
AccountType string

BANK_CARD Метод оплаты
AccountNumber string

220220******7046 Дополнительная информация о методе оплаты
BalanceAmount decimal

12.3 Сумма, которая зачислена на баланс
BalanceCurrency string

RUB Валюта, в которой было зачисление денежных средств на баланс
ErrorCode enum

666 Код ошибки
ErrorMessage string

General error Описание ошибки
SignatureValue string strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken)) BACBC4AE7C964A591B131EF5D5553A3A Подпись

Пример запроса по успешному платежу

{
 "InvId": 123,
 "OutSum": 12345,
 "CurrencyIn": "RUB",
 "Commission": 123,
 "TrsId": "AbxvAM6vJk",
 "Status": "SUCCESS",
 "custom": "custom_information",
 "AccountType": "BANK_CARD",
 "AccountNumber": "220220******7046",
 "BalanceAmount": "123",
 "BalanceCurrency": "RUB",
 "SignatureValue": "398320589F8E31ACE27CC681BCBD8BDA"
}

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

"Status=SUCCESS&InvId=987654321&Commission=4.29&CurrencyIn=RUB&OutSum=20.79&TrsId=Lm4wexRdvK&AccountType=BANK_CARD&AccountNumber=220220%2A%2A%2A%2A%2A%2A7046&BalanceAmount=16.50&BalanceCurrency=RUB&custom=%D0%9F%D1%80%D0%BE%D0%B8%D0%B7%D0%B2%D0%BE%D0%BB%D1%8C%D0%BD%D1%8B%D0%B9+%D1%82%D0%B5%D0%BA%D1%81%D1%82&SignatureValue=DC6D2CA93959FA2512BA476D2441F43C"


Пример запроса по неуспешному платежу

{
 "InvId": 123,
 "OutSum": 12345,
 "CurrencyIn": "RUB",
 "Commission": 123,
 "TrsId": "AbxvAM6vJk",
 "Status": "FAIL",
 "custom": "custom_information",
 "AccountType": "BANK_CARD",
 "AccountNumber": "220220******7046",
 "BalanceAmount": "",
 "BalanceCurrency": "RUB",
 "ErrorCode": "666",
 "ErrorMessage": "General error",
 "SignatureValue": "398320589F8E31ACE27CC681BCBD8BDA"
}

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

"Status=FAIL&InvId=987654321&Commission=4.30&CurrencyIn=RUB&OutSum=20.90&TrsId=8vrByOqbvL&AccountType=BANK_CARD&AccountNumber=220220%2A%2A%2A%2A%2A%2A7046&BalanceAmount=&BalanceCurrency=RUB&custom=%D0%9F%D1%80%D0%BE%D0%B8%D0%B7%D0%B2%D0%BE%D0%BB%D1%8C%D0%BD%D1%8B%D0%B9+%D1%82%D0%B5%D0%BA%D1%81%D1%82&ErrorCode=666&ErrorMessage=General+error&SignatureValue=2E063F836B973D192B50ACDCA698D67F"

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

В результате выполнения выплаты, если в настройках указан Payout webhook url, отправляется POST запрос с информацией о выплате.

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

Название параметра Тип Формат Возможные значения Пример Описание
TrsId string

ZqmawDQ9B7l Уникальный идентификатор выплаты
Amount decimal

50010.00 Сумма выплаты вместе с комиссией
IsAuto boolean
true
false
true Флаг автоматической выплаты
Status enum
DECLINED
SUCCESS
FAIL
SUCCESS Статус выплаты
Currency enum
USD
RUB
EUR
USDT
RUB Валюта, в которой производится выплата
Commission decimal
10.00 Комиссия системы в валюте выплаты
AccountType enum
QIWI
BANK_CARD
BANK_CARD Тип аккаунта, на который отправляются средства
AccountNumber string
671254******7272
+79999999999
Идентификатор аккаунта в зависимости от AccountType:
BANK_CARD - номер карты
QIWI - номер телефона
BalanceAmount decimal
50010.00 Сумма, списанная с баланса
BalanceCommission decimal
10.00 Комиссия системы, в валюте баланса
BalanceCurrency enum
USD
RUB
EUR
USD Валюта баланса
CommissionApplyType enum
sender
recipient
sender Кто платил комиссию
SignatureValue string strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken)) 5FC958AE222AF2E49881DEB815B8E8A2 Подпись запроса

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

{
 "TrsId": "ZqmawDQ9B7l",
 "Amount": "50010.00000000",
 "IsAuto": false,
 "Status": "SUCCESS",
 "Currency": "RUB",
 "Commission": "10.00000000",
 "AccountType": "QIWI",
 "AccountNumber": "+79999999999",
 "BalanceAmount": "50010.00000000",
 "SignatureValue": "5FC958AE222AF2E49881DEB815B8E8A2",
 "BalanceCurrency": "RUB",
 "BalanceCommission": "10.00000000",
 "CommissionApplyType": "sender"
}

Описание Fail POST запроса

В результате выполнения неуспешного платежа, пользователь перенаправляется на Fail URL, указанный в настройках магазина. Перенаправление идет в виде POST запроса на Fail URL.

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

Название параметра Тип Формат Возможные значения Пример Описание
InvId string

193 Уникальный идентификатор заказа, переданный при формировании счета
OutSum decimal

18364 Сумма платежа
CurrencyIn enum RUB RUB Валюта, в которой оплачивался счет
custom string additional_information Произвольное поле, переданное при формировании счета
SignatureValue string strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken)) BACBC4AE7C964A591B131EF5D5553A3A Подпись

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

{
 "InvId": 193,
 "OutSum": 18364,
 "custom": "additional_information",
 "CurrencyIn": "RUB",
 "SignatureValue": "BACBC4AE7C964A591B131EF5D5553A3A"
}

Описание Success POST запроса

В результате выполнения успешного платежа, пользователь перенаправляется на Success URL, указанный в настройках магазина. Перенаправление идет в виде POST запроса на Success URL.

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

Название параметра Тип Формат Возможные значения Пример Описание
InvId string

193 Уникальный идентификатор заказа, переданный при формировании счета
OutSum decimal

18364 Сумма платежа
CurrencyIn enum RUB RUB Валюта, в которой оплачивался счет
custom string additional_information Произвольное поле, переданное при формировании счета
SignatureValue string strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken)) BACBC4AE7C964A591B131EF5D5553A3A Подпись

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

{
 "InvId": 193,
 "OutSum": 18364,
 "custom": "additional_information",
 "CurrencyIn": "RUB",
 "SignatureValue": "BACBC4AE7C964A591B131EF5D5553A3A"
}

Базовый пример использования API

Для базового подключения к palych.io вам нужно научиться работать с одним видом запроса и обрабатывать postback.


Основной  запрос, который вам нужен для начала работы - это

https://palych.io/api/v1/bill/create


Например

curl --location --request POST 'https://palych.io/api/v1/bill/create' \

--header 'Authorization: Bearer 123|q4uNcWNKMNZoSFSY1XTxp36nsM0kUMSu0otSA95' \

--form 'amount="16"' \

--form 'order_id="Заказ 123"' \

--form 'description="Описание ссылки"' \

--form 'type="normal"' \

--form 'shop_id="G1vrEyX0LR"' \

--form 'currency_in="RUB"' \

--form 'custom="кастомное поле со свободным текстом"' \

--form 'payer_pays_commission="1"' \

--form 'name="Платёж"'


И вы получите такой ответ

{

    "success": "true",

    "link_url": "https://palych.io/link/3P1p2rgW7Y",

    "link_page_url": "https://palych.io/transfer/3P1p2rgW7Y",

    "bill_id": "3P1p2rgW7Y"

}


Далее вам нужно или показыть ссылку из поля "link_page_url" пользователю, чтобы он сам на неё нажал и перешёл на оплату.

Лучше перенаправить плательщика автоматически на платёжную страницу по ссылке вида

https://palych.io/transfer/3P1p2rgW7Y


После того, как вы отправили пользователя на платёжную страницу, вам нужно дождаться его по Success или Fail URL, а так же получить и обработать postback, который придёт на Result URL.


На Success или Fail URL вы получите такой запрос

{

    "OutSum": "18.54",

    "SignatureValue": "5A41374P24C99A2156D1D306C800B53C",

    "CurrencyIn": "RUB",

    "InvId": "Заказ 123",

    "custom": "кастомное поле со свободным текстом"

  }

 

После редиректа на Success или Fail URL пользователь должен увидеть сообщение со статусом платежа.

Так как вы можете получить order_id обратно, и в пример выше - это поле InvId, то можно сразу показать сообщение вида

"Ваш заказ InvId успешно оплачен. Благодарим за платёж!"

или

"Оплата по заказу InvId не прошла. Пожалуйста, попробуйте ещё раз или обратитесь в службу поддержки"


Ещё на Result URL вы получите postback  с таким содержимым.

{

    "Status": "SUCCESS",

    "InvId": "Заказ 123",

    "Commission": "2.54",

    "CurrencyIn": "RUB",

    "OutSum": "18.54",

    "TrsId": "3P1p2rgW7Y",

    "custom": "кастомное поле со свободным текстом",

    "SignatureValue": "4A41373E24C99A2656D1D306C800B53C"

}


На основе этого postback вам нужно поменять статус в своей CMS/сайте.


Получив статус SUCCESS вы в своей базе меняете статус заказа на "ОПЛАЧЕНО".

Получив статус FAIL вы соотвественно меняете у себя статус заказа на "НЕ ОПЛАЧЕНО".


Описанного выше достаточно, чтобы начать принимать платежи.

GET /api/v1/payout/dictionaries/sbp_banks

Метод для получения списка доступных банков для СБП.

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

Нет

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

Название параметра Тип Формат Возможные значения Пример Описание
data array SBP bank
см. описание SBP Bank Список доступных банков для СБП
success bool
true/false true Результат выполнения запроса

SBP Bank

Название параметра Тип Формат Возможные значения Пример Описание
member_id integer

100000000032 Member ID банка в системе СБП
name string

Ренессанс Кредит Название банка
name_en string

Renaissance Credit Название банка на английском языке
bic integer

44525135 БИК банка

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

curl -X GET 'https://palych.io/api/v1/payout/dictionaries/sbp_banks' \
-H 'Authorization: Bearer 1|gdzr1215Z5EO3nGSVFBGdTG4APuG5tngYCqk69RbdPKYkTfK1LZg2rgakKWx3JI14kKEFLZGwijI'

Ответ

{
  "success": "true",
  "data": [
   {
    "member_id": 100000000202,
    "name": "Норвик Банк",
    "name_en": "Norvik Bank",
    "bic": 43304728
   },
   {
    "member_id": 100000000032,
    "name": "Ренессанс Кредит",
    "name_en": "Renaissance Credit",
    "bic": 44525135
   }
  ]
}

Возможные ошибки

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.merchant_banned Доступ для мерчанта запрещен
422 Ошибка валидации входных данных

У вас появились вопросы по Вашему платежу?

Мы поможем разобраться с этим. Пожалуйста, заполните форму и в течение 48 часов мы Вам ответим.

Ваша заявка скоро будет обработана. Обычно это занимает до 48 часов