Перейти к содержимому

API интеграция

Как начать?

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

Authorization: Bearer {token}
Иначе сервер вернет ошибку авторизации 401.
Токен вы можете получить на странице API интеграций в личном кабинете

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

curl 'https://cardlink.link/api/v1/bill/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

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

Для базового подключения к сервису вам нужно научиться работать с одним видом запроса и обрабатывать postback.
Основной запрос, который вам нужен для начала работы - /api/v1/bill/create

Пример запроса:
curl --location --request POST 'https://cardlink.link/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="my_custom_data"' \
--form 'payer_pays_commission=1' \
--form 'name="Платёж"'

Пример ответа:
{
  "success": "true",
  "link_url": "https://cardlink.link/link/3P1p2rgW7Y",
  "link_page_url": "https://cardlink.link/transfer/3P1p2rgW7Y",
  "bill_id": "3P1p2rgW7Y
}

Далее вам необходимо направить пользователя на ссылку, указанную в "link_page_url". После оплаты пользователь будет перенаправлен на страницу, указанную в Success/Fail URL в зависимости от статуса платежа.

Перенаправление пользователя происходит посредством POST запроса следующего формата:
{
  "OutSum": "18.54",
  "CurrencyIn": "RUB",
  "InvId": "Заказ 123",
  "custom": "my_custom_data"
}

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

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

Оплата по заказу InvId не прошла. Пожалуйста, попробуйте ещё раз или обратитесь в службу поддержки
Так же вы получите Postback на указанный в настройках магазина Result URL. Формат данных следующий:
{
  "Status": "SUCCESS",
  "InvId": "Заказ 123",
  "Commission": "2.54",
  "CurrencyIn": "RUB",
  "OutSum": "18.54",
  "TrsId": "3P1p2rgW7Y",
  "custom": "my_custom_data",
  "SignatureValue": "4A41373E24C99A2656D1D306C800B53C"
}

На основе этого Postback вам нужно сменить статус заказа в вашей системе.
Получив статус SUCCESS вы в своей базе меняете статус заказа на "ОПЛАЧЕНО"
Получив статус FAIL вы соотвественно меняете у себя статус заказа на "НЕ ОПЛАЧЕНО"
Описанного выше достаточно, чтобы начать принимать платежи.

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

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

Название параметра Тип Описание Возможные значения Пример
InvId обязательный string Уникальный идентификатор заказа, переданный при формировании счета payment-19238465
OutSum обязательный decimal Сумма платежа 380.55
CurrencyIn обязательный enum Валюта, в которой оплачивался счет USD RUB EUR RUB
custom string Произвольное поле, переданное при формировании счета additional_information
  • InvId string обязательный
    Уникальный идентификатор заказа, переданный при формировании счета
    Пример: payment-19238465
  • OutSum decimal обязательный
    Сумма платежа
    Пример: 380.55
  • CurrencyIn enum обязательный
    Валюта, в которой оплачивался счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • custom string
    Произвольное поле, переданное при формировании счета
    Пример: additional_information

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

curl -X POST 'https://cardlink.link/redirect/payment/success' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'InvId=123' \
-d 'OutSum=12345' \
-d 'CurrencyIn=RUB' \
-d 'custom=custom_information'

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

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

Название параметра Тип Описание Возможные значения Пример
InvId обязательный string Уникальный идентификатор заказа, переданный при формировании счета payment-19238465
OutSum обязательный decimal Сумма платежа 380.55
CurrencyIn обязательный enum Валюта, в которой оплачивался счет USD RUB EUR RUB
custom string Произвольное поле, переданное при формировании счета additional_information
  • InvId string обязательный
    Уникальный идентификатор заказа, переданный при формировании счета
    Пример: payment-19238465
  • OutSum decimal обязательный
    Сумма платежа
    Пример: 380.55
  • CurrencyIn enum обязательный
    Валюта, в которой оплачивался счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • custom string
    Произвольное поле, переданное при формировании счета
    Пример: additional_information

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

curl -X POST 'https://cardlink.link/redirect/payment/fail' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'InvId=123' \
-d 'OutSum=12345' \
-d 'CurrencyIn=RUB' \
-d 'custom=custom_information'

Bill

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор счета jZqmaPvl9W
order_id string Уникальный идентификатор заказа на вашей стороне order-285394168
active boolean Флаг активности счета 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
ttl enum Время жизни счета на оплату в секундах. 600
  • id string
    Уникальный идентификатор счета
    Пример: jZqmaPvl9W
  • order_id string
    Уникальный идентификатор заказа на вашей стороне
    Пример: order-285394168
  • active boolean
    Флаг активности счета
    Возможные значения: 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
  • ttl enum
    Время жизни счета на оплату в секундах.
    Пример: 600

Важно: передача пустой строки ("") или строки "NULL" в любом поле является недопустимой. Если данные для поля отсутствуют — поле необходимо полностью исключить из запроса.
Название параметра Тип Описание Возможные значения Пример
name string Наименование товара или услуги Steam
price decimal Стоимость позиции в виде строки с двумя знаками после запятой (например: 500.00) 500.00
quantity decimal Количество единиц товара в виде строки (например: 1) 1
category string Внутренняя категория продукта. Примеры: steam, digital/stars, digital/subscription/xbox, digital/subscription/netflix steam
extra array Объект с идентификатором аккаунта, связанным с покупкой. Набор обязательных полей зависит от категории товара. Если данных нет — поле необходимо полностью исключить из запроса, не передавать пустые или нулевые значения. {"steam_account": "jordas123"}
extra[steam_account] string Логин Steam-аккаунта, на который производится пополнение. Обязателен для товаров категории Steam. jordas123
extra[telegram_username] string Username Telegram-аккаунта для пополнения Stars (например: DurovunaDR). Обязателен при продаже через веб-сайт и через Telegram-бот. DurovunaDR
extra[telegram_id] string Числовой идентификатор Telegram-аккаунта (например: 5099904440). Обязателен только при продаже через Telegram-бот. 5099904440
extra[account] string Аккаунт или email, на который активируется услуга (например: user@example.com). Передавать только при наличии данных. user@example.com
  • name string
    Наименование товара или услуги
    Пример: Steam
  • price decimal
    Стоимость позиции в виде строки с двумя знаками после запятой (например: 500.00)
    Пример: 500.00
  • quantity decimal
    Количество единиц товара в виде строки (например: 1)
    Пример: 1
  • category string
    Внутренняя категория продукта. Примеры: steam, digital/stars, digital/subscription/xbox, digital/subscription/netflix
    Пример: steam
  • extra array
    Объект с идентификатором аккаунта, связанным с покупкой. Набор обязательных полей зависит от категории товара. Если данных нет — поле необходимо полностью исключить из запроса, не передавать пустые или нулевые значения.
    Пример: {"steam_account": "jordas123"}
  • extra[steam_account] string
    Логин Steam-аккаунта, на который производится пополнение. Обязателен для товаров категории Steam.
    Пример: jordas123
  • extra[telegram_username] string
    Username Telegram-аккаунта для пополнения Stars (например: DurovunaDR). Обязателен при продаже через веб-сайт и через Telegram-бот.
    Пример: DurovunaDR
  • extra[telegram_id] string
    Числовой идентификатор Telegram-аккаунта (например: 5099904440). Обязателен только при продаже через Telegram-бот.
    Пример: 5099904440
  • extra[account] string
    Аккаунт или email, на который активируется услуга (например: user@example.com). Передавать только при наличии данных.
    Пример: user@example.com

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

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

Название параметра Тип Описание Возможные значения Пример
amount обязательный decimal Сумма счёта 380.99
shop_id обязательный string Уникальный идентификатор магазина, к которому относится платеж. Без этого параметра не будет работать Success URL, Fail URL и Result URL LXZv3R7Q8B
order_id string Уникальный идентификатор заказа. Будет возвращен в postback. order-285394168
description string Описание платежа Order #285394168
type enum Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится. normal multi normal
locale enum Локаль, язык в котором будет отображаться форма платежа en ru en
currency_in enum Валюта, в которой оплачивается счет. Если не передана, то используется валюта магазина. Если shop_id не определен, то используется RUB. RUB USD EUR RUB
account_currency enum Валюта баланса, на который должен быть зачислен платёж. Если не передана, валюта баланса определяется автоматически. RUB USD EUR RUB
custom string Произвольное поле. Будет возвращено в postback. my-custom-string
payer_pays_commission enum Параметр, который указывает на то, кто будет оплачивать комиссию за входящий платёж. 1 0 1
payer_data[phone] string Номер телефона плательщика. +79991234567
payer_data[email] string Параметр, который заполняет email клиента на платёжной странице. payer@email.com
name string Название ссылки. Укажите, за что принимаете средства. Этот текст будет отображен в платежной форме. Donation
ttl integer Время жизни счета на оплату в секундах. 600
return_url string URL для кнопки "Назад в магазин" на странице оплаты. Домен должен совпадать с тем, что указан при добавлении магазина в систему https://exmpl.com/return
success_url string Страница успешной оплаты. https://exmpl.com/order-285394168/success
fail_url string Страница неуспешной оплаты. https://exmpl.com/order-285394168/fail
payment_method enum Если указан этот параметр, то при переходе на платежную форму этот способ оплаты будет выбран автоматически, без возможности выбора другого способ оплаты. BANK_CARD SBP SBP
request_fields[email] boolean Обязательный запрос электронной почты у плательщика false
request_fields[phone] boolean Обязательный запрос номера телефона у плательщика false
request_fields[name] boolean Обязательный запрос ФИО у плательщика false
request_fields[comment] boolean Обязательный запрос комментария у плательщика false
items array Список товаров Order Item Resource
show_converted_amount boolean Флаг отображения суммы, конвертированной в валюту баланса, на форме оплаты, если валюта счёта отличается от валюты баланса. true
notification[mail] boolean Флаг отправки уведомления мерчанту на email при изменении статуса счёта. true
deactivate_on_fail boolean Деактивировать счёт после первой неуспешной оплаты: новых попыток оплаты по ссылке не будет. Если параметр не передан, действует настройка магазина, которую включает поддержка по заявке. Для типа счёта multi параметр не действует. false
  • amount decimal обязательный
    Сумма счёта
    Пример: 380.99
  • shop_id string обязательный
    Уникальный идентификатор магазина, к которому относится платеж. Без этого параметра не будет работать Success URL, Fail URL и Result URL
    Пример: LXZv3R7Q8B
  • order_id string
    Уникальный идентификатор заказа. Будет возвращен в postback.
    Пример: order-285394168
  • description string
    Описание платежа
    Пример: Order #285394168
  • type enum
    Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится.
    Возможные значения: normal multi
    Пример: normal
  • locale enum
    Локаль, язык в котором будет отображаться форма платежа
    Возможные значения: en ru
    Пример: en
  • currency_in enum
    Валюта, в которой оплачивается счет. Если не передана, то используется валюта магазина. Если shop_id не определен, то используется RUB.
    Возможные значения: RUB USD EUR
    Пример: RUB
  • account_currency enum
    Валюта баланса, на который должен быть зачислен платёж. Если не передана, валюта баланса определяется автоматически.
    Возможные значения: RUB USD EUR
    Пример: RUB
  • custom string
    Произвольное поле. Будет возвращено в postback.
    Пример: my-custom-string
  • payer_pays_commission enum
    Параметр, который указывает на то, кто будет оплачивать комиссию за входящий платёж.
    Возможные значения: 1 0
    Пример: 1
  • payer_data[phone] string
    Номер телефона плательщика.
    Пример: +79991234567
  • payer_data[email] string
    Параметр, который заполняет email клиента на платёжной странице.
    Пример: payer@email.com
  • name string
    Название ссылки. Укажите, за что принимаете средства. Этот текст будет отображен в платежной форме.
    Пример: Donation
  • ttl integer
    Время жизни счета на оплату в секундах.
    Пример: 600
  • return_url string
    URL для кнопки "Назад в магазин" на странице оплаты. Домен должен совпадать с тем, что указан при добавлении магазина в систему
    Пример: https://exmpl.com/return
  • success_url string
    Страница успешной оплаты.
    Пример: https://exmpl.com/order-285394168/success
  • fail_url string
    Страница неуспешной оплаты.
    Пример: https://exmpl.com/order-285394168/fail
  • payment_method enum
    Если указан этот параметр, то при переходе на платежную форму этот способ оплаты будет выбран автоматически, без возможности выбора другого способ оплаты.
    Возможные значения: BANK_CARD SBP
    Пример: SBP
  • request_fields[email] boolean
    Обязательный запрос электронной почты у плательщика
    Пример: false
  • request_fields[phone] boolean
    Обязательный запрос номера телефона у плательщика
    Пример: false
  • request_fields[name] boolean
    Обязательный запрос ФИО у плательщика
    Пример: false
  • request_fields[comment] boolean
    Обязательный запрос комментария у плательщика
    Пример: false
  • items array
    Список товаров
    Пример: Order Item Resource
  • show_converted_amount boolean
    Флаг отображения суммы, конвертированной в валюту баланса, на форме оплаты, если валюта счёта отличается от валюты баланса.
    Пример: true
  • notification[mail] boolean
    Флаг отправки уведомления мерчанту на email при изменении статуса счёта.
    Пример: true
  • deactivate_on_fail boolean
    Деактивировать счёт после первой неуспешной оплаты: новых попыток оплаты по ссылке не будет. Если параметр не передан, действует настройка магазина, которую включает поддержка по заявке. Для типа счёта multi параметр не действует.
    Пример: false

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

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

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

curl -X POST 'https://cardlink.link/api/v1/bill/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'amount=100.05' \
-d 'description=Some desc' \
-d 'order_id=15' \
-d 'type=multi' \
-d 'shop_id=LXZv3R7Q8B' \
-d 'custom=123' \
-d 'currency_in=RUB' \
-d 'account_currency=RUB'

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

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

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

Код ответа Ключ ошибки Описание ошибки
400 api:error.transaction_rejected Транзакция отклонена
401 Unauthenticated Неверный API Токен
403 api:error.invalid_amount Неверная сумма
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.merchant_not_found Мерчант не найден
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.rate-not-found Направление недоступно
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка
503 api:error.payment_method_temporarily_unavailable Способ оплаты временно недоступен (открыт предохранитель процессинга); повторите через число секунд из заголовка Retry-After

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

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

Название параметра Тип Описание Возможные значения Пример
id обязательный string Уникальный идентификатор счета LXZv3R7Q8B
active обязательный boolean 0 - деактивировать счет, 1 - активировать счет 0 1 0
  • id string обязательный
    Уникальный идентификатор счета
    Пример: LXZv3R7Q8B
  • active boolean обязательный
    0 - деактивировать счет, 1 - активировать счет
    Возможные значения: 0 1
    Пример: 0

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор счета jZqmaPvl9W
order_id string Уникальный идентификатор заказа на вашей стороне order-285394168
active boolean Флаг активности счета 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
ttl enum Время жизни счета на оплату в секундах. 600
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор счета
    Пример: jZqmaPvl9W
  • order_id string
    Уникальный идентификатор заказа на вашей стороне
    Пример: order-285394168
  • active boolean
    Флаг активности счета
    Возможные значения: 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
  • ttl enum
    Время жизни счета на оплату в секундах.
    Пример: 600
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/bill/toggle_activity' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-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 Доступ для мерчанта запрещен
403 api:error.merchant_not_found Мерчант не найден
403 api:error.bill_not_found Счет не найден
403 api:error.merchant_subscription_inactive Подписка неактивна
403 api:error.merchant_subscription_not_found Мерчант не имеет подписки
403 api:error.bill_is_finished Счет уже оплачен (При типе счета "Одноразовый")
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка

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

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

Название параметра Тип Описание Возможные значения Пример
id обязательный string Уникальный идентификатор счета LXZv3R7Q8B
per_page integer Количество элементов на странице 50
cursor string Указатель на страницу eyJpZCI6NzY1LCJfcG
  • id string обязательный
    Уникальный идентификатор счета
    Пример: LXZv3R7Q8B
  • per_page integer
    Количество элементов на странице
    Пример: 50
  • cursor string
    Указатель на страницу
    Пример: eyJpZCI6NzY1LCJfcG

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

Название параметра Тип Описание Возможные значения Пример
success boolean Флаг успешности запроса true false true
data array Payment Массив платежей, относящихся к этому счету на оплату См. описание Payment
links array Links Ссылки для пагинации См. описание Pagination Links
meta array Meta Мета данные пагинации См. описание Pagination Meta
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true
  • data array, Payment
    Массив платежей, относящихся к этому счету на оплату
    Пример: См. описание Payment
  • links array, Links
    Ссылки для пагинации
    Пример: См. описание Pagination Links
  • meta array, Meta
    Мета данные пагинации
    Пример: См. описание Pagination Meta

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

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

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

{
    "success": true,
    "data": [
        {
            "id": "PQX2XD25a0",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "SUCCESS",
            "amount": 35400,
            "bill_amount": 35400,
            "commission": 400,
            "account_amount": 35000,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "676454******7272",
            "account_bank": "SBERBANK",
            "currency_in": "RUB",
            "created_at": "2020-10-19 17:00:00"
        },
        {
            "id": "zeAmwP2d5Q",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "NEW",
            "amount": 3200,
            "bill_amount": 3200,
            "commission": 50,
            "account_amount": 3150,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "676454******7272",
            "account_bank": "SBERBANK",
            "currency_in": "RUB",
            "created_at": "2020-10-18 17:00:00"
        },
        {
            "id": "NDa7lNmdzx",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "FAIL",
            "amount": 26100,
            "bill_amount": 26100,
            "commission": 100,
            "account_amount": 26000,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "553691******4442",
            "account_bank": "TINKOFF",
            "currency_in": "RUB",
            "created_at": "2020-10-01 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/bill/payments?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/bill/payments?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/bill/payments",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

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

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

Если счет имеет тип MULTI, то его статус не будет изменяться.

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

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

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор счета jZqmaPvl9W
order_id string Уникальный идентификатор заказа на вашей стороне order-285394168
active boolean Флаг активности счета 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
ttl enum Время жизни счета на оплату в секундах. 600
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор счета
    Пример: jZqmaPvl9W
  • order_id string
    Уникальный идентификатор заказа на вашей стороне
    Пример: order-285394168
  • active boolean
    Флаг активности счета
    Возможные значения: 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
  • ttl enum
    Время жизни счета на оплату в секундах.
    Пример: 600
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X GET 'https://cardlink.link/api/v1/bill/status?id=LXZv3R7Q5B' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

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

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

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_not_found Мерчант не найден
403 api:error.bill_not_found Счет не найден
403 api:error.shop_not_found Магазин не найден. Возникает только в случае, если shop_id был передан
422 Ошибка валидации входных данных

Currencies

Возвращает список актуальных курсов из источников, доступных для вашей учётной записи. Набор источников и валютных пар настраивается индивидуально.

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

Нет

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

Название параметра Тип Описание Возможные значения Пример
success boolean Флаг успешности запроса true false true
data array Объект с ключами — названиями источников. Каждое значение — объект с ключами-кодами исходных валют, содержащий коды целевых валют и их курсы. {"steam": {"USD": {"RUB": 100.50}}}
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true
  • data array
    Объект с ключами — названиями источников. Каждое значение — объект с ключами-кодами исходных валют, содержащий коды целевых валют и их курсы.
    Пример: {"steam": {"USD": {"RUB": 100.50}}}

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

curl -X GET 'https://cardlink.link/api/v1/currencies/quote-rates' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

{
    "success": true,
    "data": {
        "first_exchange_rate": {
            "USD": {
                "RUB": 100.5
            }
        },
        "second_exchange_rate": {
            "USD": {
                "EUR": 0.92,
                "RUB": 100.5
            }
        }
    }
}

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

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
400 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
500 api:error.general_error Внутренняя ошибка

Payment

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор платежа jZqmaPvl9W
bill_id string Уникальный идентификатор счета, которому принадлежит платеж do5G93m
bill_order_id string Уникальный идентификатор заказа. Будет возвращен в postback. order-285394168
status enum Статус платежа NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL NEW
amount decimal Сумма платежа 4039.65
bill_amount decimal Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission) 4000.00
commission decimal Комиссия 39.65
account_amount decimal Сумма зачисления на баланс 4000.00
account_currency_code string Валюта зачисления на баланс RUB
refunded_amount decimal Сумма возвратов по платежу 0
from_card string Номер карты, с которой произошла оплата (При оплате банковской картой) 671254******7272
account_bank string Банк счета пользователя, с которого произошла оплата SBERBANK
currency_in enum Валюта, в которой оплачивается счет USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Дата и время создания платежа 2024-12-19 17:32:55
payer_phone string Телефон плательщика 79112223344
payer_email string Почта плательщика payer@example.com
payer_name string Имя плательщика Ivan
payer_comment string Комментарий плательщика Payment comment
error_code integer Код ошибки 400
error_message string Описание ошибки Превышены лимиты
description string Описание Invoice #123123
rrn string RRN операции 532100123456
payment_purpose string Назначение платежа Invoice #123123 payment
  • id string
    Уникальный идентификатор платежа
    Пример: jZqmaPvl9W
  • bill_id string
    Уникальный идентификатор счета, которому принадлежит платеж
    Пример: do5G93m
  • bill_order_id string
    Уникальный идентификатор заказа. Будет возвращен в postback.
    Пример: order-285394168
  • status enum
    Статус платежа
    Возможные значения: NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL
    Пример: NEW
  • amount decimal
    Сумма платежа
    Пример: 4039.65
  • bill_amount decimal
    Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission)
    Пример: 4000.00
  • commission decimal
    Комиссия
    Пример: 39.65
  • account_amount decimal
    Сумма зачисления на баланс
    Пример: 4000.00
  • account_currency_code string
    Валюта зачисления на баланс
    Пример: RUB
  • refunded_amount decimal
    Сумма возвратов по платежу
    Пример: 0
  • from_card string
    Номер карты, с которой произошла оплата (При оплате банковской картой)
    Пример: 671254******7272
  • account_bank string
    Банк счета пользователя, с которого произошла оплата
    Пример: SBERBANK
  • currency_in enum
    Валюта, в которой оплачивается счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания платежа
    Пример: 2024-12-19 17:32:55
  • payer_phone string
    Телефон плательщика
    Пример: 79112223344
  • payer_email string
    Почта плательщика
    Пример: payer@example.com
  • payer_name string
    Имя плательщика
    Пример: Ivan
  • payer_comment string
    Комментарий плательщика
    Пример: Payment comment
  • error_code integer
    Код ошибки
    Пример: 400
  • error_message string
    Описание ошибки
    Пример: Превышены лимиты
  • description string
    Описание
    Пример: Invoice #123123
  • rrn string
    RRN операции
    Пример: 532100123456
  • payment_purpose string
    Назначение платежа
    Пример: Invoice #123123 payment

Название параметра Тип Описание Возможные значения Пример
id string Чарджбэк ID jZqmaPvl9W
payment_id string ID Платежа do5G93m
status enum Статус NEW PROCESS SUCCESS FAIL NEW
created_at datetime Y-m-d H:i:s Дата/время создания 2024-12-19 17:32:55
  • id string
    Чарджбэк ID
    Пример: jZqmaPvl9W
  • payment_id string
    ID Платежа
    Пример: do5G93m
  • status enum
    Статус
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: NEW
  • created_at datetime, Y-m-d H:i:s
    Дата/время создания
    Пример: 2024-12-19 17:32:55

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

Название параметра Тип Описание Возможные значения Пример
id обязательный string Уникальный идентификатор платежа LXZv3R7Q8B
refunds boolean Включить в ответ информацию по рефандам 1
chargeback boolean Включить в ответ информацию по чарджбэкам 0
  • id string обязательный
    Уникальный идентификатор платежа
    Пример: LXZv3R7Q8B
  • refunds boolean
    Включить в ответ информацию по рефандам
    Пример: 1
  • chargeback boolean
    Включить в ответ информацию по чарджбэкам
    Пример: 0

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор платежа jZqmaPvl9W
bill_id string Уникальный идентификатор счета, которому принадлежит платеж do5G93m
bill_order_id string Уникальный идентификатор заказа. Будет возвращен в postback. order-285394168
status enum Статус платежа NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL NEW
amount decimal Сумма платежа 4039.65
bill_amount decimal Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission) 4000.00
commission decimal Комиссия 39.65
account_amount decimal Сумма зачисления на баланс 4000.00
account_currency_code string Валюта зачисления на баланс RUB
refunded_amount decimal Сумма возвратов по платежу 0
from_card string Номер карты, с которой произошла оплата (При оплате банковской картой) 671254******7272
account_bank string Банк счета пользователя, с которого произошла оплата SBERBANK
currency_in enum Валюта, в которой оплачивается счет USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Дата и время создания платежа 2024-12-19 17:32:55
payer_phone string Телефон плательщика 79112223344
payer_email string Почта плательщика payer@example.com
payer_name string Имя плательщика Ivan
payer_comment string Комментарий плательщика Payment comment
error_code integer Код ошибки 400
error_message string Описание ошибки Превышены лимиты
description string Описание Invoice #123123
rrn string RRN операции 532100123456
payment_purpose string Назначение платежа Invoice #123123 payment
success boolean Флаг успешности запроса true false true
refunds array Refund Массив рефандов. Если был передан refunds=true [Refund Resource]
chargeback array Chargeback Чарджбек. Если существует и если был передан chargeback=true Chargeback Resource
  • id string
    Уникальный идентификатор платежа
    Пример: jZqmaPvl9W
  • bill_id string
    Уникальный идентификатор счета, которому принадлежит платеж
    Пример: do5G93m
  • bill_order_id string
    Уникальный идентификатор заказа. Будет возвращен в postback.
    Пример: order-285394168
  • status enum
    Статус платежа
    Возможные значения: NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL
    Пример: NEW
  • amount decimal
    Сумма платежа
    Пример: 4039.65
  • bill_amount decimal
    Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission)
    Пример: 4000.00
  • commission decimal
    Комиссия
    Пример: 39.65
  • account_amount decimal
    Сумма зачисления на баланс
    Пример: 4000.00
  • account_currency_code string
    Валюта зачисления на баланс
    Пример: RUB
  • refunded_amount decimal
    Сумма возвратов по платежу
    Пример: 0
  • from_card string
    Номер карты, с которой произошла оплата (При оплате банковской картой)
    Пример: 671254******7272
  • account_bank string
    Банк счета пользователя, с которого произошла оплата
    Пример: SBERBANK
  • currency_in enum
    Валюта, в которой оплачивается счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания платежа
    Пример: 2024-12-19 17:32:55
  • payer_phone string
    Телефон плательщика
    Пример: 79112223344
  • payer_email string
    Почта плательщика
    Пример: payer@example.com
  • payer_name string
    Имя плательщика
    Пример: Ivan
  • payer_comment string
    Комментарий плательщика
    Пример: Payment comment
  • error_code integer
    Код ошибки
    Пример: 400
  • error_message string
    Описание ошибки
    Пример: Превышены лимиты
  • description string
    Описание
    Пример: Invoice #123123
  • rrn string
    RRN операции
    Пример: 532100123456
  • payment_purpose string
    Назначение платежа
    Пример: Invoice #123123 payment
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true
  • refunds array, Refund
    Массив рефандов. Если был передан refunds=true
    Пример: [Refund Resource]
  • chargeback array, Chargeback
    Чарджбек. Если существует и если был передан chargeback=true
    Пример: Chargeback Resource

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

curl -X GET 'https://cardlink.link/api/v1/payment/status?id=lGPmp4mYeE' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

{
    "id": "PQX2XD25a0",
    "bill_id": "do5G93m",
    "bill_order_id": "order-285394168",
    "status": "SUCCESS",
    "amount": 35400,
    "bill_amount": 35400,
    "commission": 400,
    "account_amount": 35000,
    "account_currency_code": "RUB",
    "refunded_amount": 0,
    "from_card": "676454******7272",
    "account_bank": "SBERBANK",
    "currency_in": "RUB",
    "description": "Invoice #123123",
    "created_at": "2025-10-19 17:00:00",
    "success": true,
    "refunds": [],
    "chargeback": []
}

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

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

Balance

Название параметра Тип Описание Возможные значения Пример
currency enum Валюта баланса USD RUB EUR RUB
balance_available decimal Доступный баланс 93988.37000000
balance_locked decimal Заблокированный баланс во время выплаты средств 0.00000000
balance_hold decimal Временно удержанный баланс. Переходит в доступный спустя время 0.00000000
balance_min decimal Порог расходования. Больше нуля — неснижаемый остаток, меньше нуля — разрешённый овердрафт, 0 — без порога 0.00000000
balance_spendable decimal Доступно к расходованию: баланс за вычетом порога расходования. Может быть меньше нуля 93988.37000000
  • currency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • balance_available decimal
    Доступный баланс
    Пример: 93988.37000000
  • balance_locked decimal
    Заблокированный баланс во время выплаты средств
    Пример: 0.00000000
  • balance_hold decimal
    Временно удержанный баланс. Переходит в доступный спустя время
    Пример: 0.00000000
  • balance_min decimal
    Порог расходования. Больше нуля — неснижаемый остаток, меньше нуля — разрешённый овердрафт, 0 — без порога
    Пример: 0.00000000
  • balance_spendable decimal
    Доступно к расходованию: баланс за вычетом порога расходования. Может быть меньше нуля
    Пример: 93988.37000000

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

Нет

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

Название параметра Тип Описание Возможные значения Пример
balances array Balance Массив, содержащий информацию о балансах мерчанта См. описание Balance Resource
success boolean Флаг успешности запроса true false true
  • balances array, Balance
    Массив, содержащий информацию о балансах мерчанта
    Пример: См. описание Balance Resource
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X GET 'https://cardlink.link/api/v1/merchant/balance' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

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

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

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

Payout

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор выплаты LXZv3R7Q8B
status enum Статус выплаты NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Уникальный идентификатор заказа payout-19238465
account_identifier string Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address 2202201234567046
account_bank string Банк получателя. Присутствует для карт и СБП, если банк известен Sberbank
amount decimal В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты 4000
account_amount decimal Сумма, списанная с баланса 4039.65
commission decimal Комиссия сервиса 39.65
account_commission decimal Комиссия сервиса в валюте баланса 39.65
currency enum Валюта выплаты USD RUB EUR RUB
account_currency enum Валюта баланса USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Дата и время создания выплаты 2024-12-19 17:32:55
error_code integer Код ошибки 400
error_message string Описание ошибки Превышены лимиты
  • id string
    Уникальный идентификатор выплаты
    Пример: LXZv3R7Q8B
  • status enum
    Статус выплаты
    Возможные значения: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Пример: NEW
  • order_id string
    Уникальный идентификатор заказа
    Пример: payout-19238465
  • account_identifier string
    Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address
    Пример: 2202201234567046
  • account_bank string
    Банк получателя. Присутствует для карт и СБП, если банк известен
    Пример: Sberbank
  • amount decimal
    В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
    Пример: 4000
  • account_amount decimal
    Сумма, списанная с баланса
    Пример: 4039.65
  • commission decimal
    Комиссия сервиса
    Пример: 39.65
  • account_commission decimal
    Комиссия сервиса в валюте баланса
    Пример: 39.65
  • currency enum
    Валюта выплаты
    Возможные значения: USD RUB EUR
    Пример: RUB
  • account_currency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания выплаты
    Пример: 2024-12-19 17:32:55
  • error_code integer
    Код ошибки
    Пример: 400
  • error_message string
    Описание ошибки
    Пример: Превышены лимиты

Название параметра Тип Описание Возможные значения Пример
member_id integer Member ID банка в системе СБП 100000000032
name string Название банка Ренессанс Кредит
name_en string Название банка на английском языке Renaissance Credit
bic integer БИК банка 44525135
  • member_id integer
    Member ID банка в системе СБП
    Пример: 100000000032
  • name string
    Название банка
    Пример: Ренессанс Кредит
  • name_en string
    Название банка на английском языке
    Пример: Renaissance Credit
  • bic integer
    БИК банка
    Пример: 44525135

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

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

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

Название параметра Тип Описание Возможные значения Пример
amount обязательный decimal Сумма выплаты 380.99
payout_account_id обязательный string Уникальный идентификатор платежного аккаунта, на который будет произведена выплата. LXZv3R7Q8B
currency enum Валюта выплаты, в которой указана сумма amount. USD RUB EUR USDT RUB
account_currency enum Валюта баланса, с которого необходимо списать средства за выплату. USD RUB EUR RUB
recipient_pays_commission boolean Параметр отвечающий за то, кто платит комиссию (true-комиссию платит получающий выплату, если false-то комиссия будет вычтена с баланса аккаунта) true false false
order_id string Уникальный идентификатор заказа. payout-384685192
  • amount decimal обязательный
    Сумма выплаты
    Пример: 380.99
  • payout_account_id string обязательный
    Уникальный идентификатор платежного аккаунта, на который будет произведена выплата.
    Пример: LXZv3R7Q8B
  • currency enum
    Валюта выплаты, в которой указана сумма amount.
    Возможные значения: USD RUB EUR USDT
    Пример: RUB
  • account_currency enum
    Валюта баланса, с которого необходимо списать средства за выплату.
    Возможные значения: USD RUB EUR
    Пример: RUB
  • recipient_pays_commission boolean
    Параметр отвечающий за то, кто платит комиссию (true-комиссию платит получающий выплату, если false-то комиссия будет вычтена с баланса аккаунта)
    Возможные значения: true false
    Пример: false
  • order_id string
    Уникальный идентификатор заказа.
    Пример: payout-384685192

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

Название параметра Тип Описание Возможные значения Пример
data array Payout Информация о выплате См. описание Payout Resource
success boolean Флаг успешности запроса true false true
  • data array, Payout
    Информация о выплате
    Пример: См. описание Payout Resource
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/payout/personal/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'amount=1500' \
-d 'payout_account_id=EG8Rz3R7Q8B'

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

{
    "data": [
        {
            "id": "gY37jYr2b6",
            "status": "MODERATING",
            "amount": 1500,
            "commission": 100,
            "account_identifier": "6764540000007272",
            "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.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 Недостаточно средств для выплаты. В errors.balance — фактический баланс, в errors.available — сумма, доступная к расходованию с учётом порога
400 api:error.direction_not_available Выплата на данный аккаунт недоступна
400 api:error.merchant_not_verified Мерчант не верифицирован
400 api:error.rub_payout_offer_not_accepted Владелец кабинета не принял оферту для рублёвых выплат: выплаты на российские карты и по СБП недоступны до её принятия в личном кабинете
403 This action is unauthorized Мерчант не верифицирован
422 Ошибка валидации входных данных
500 api:error.general_error Внутренняя ошибка

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

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

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

Название параметра Тип Описание Возможные значения Пример
amount обязательный decimal Сумма выплаты 380.99
currency обязательный enum Валюта USD RUB EUR RUB
account_type обязательный enum Тип аккаунта, на который отправляются средства credit_card sbp crypto steam credit_card
account_identifier обязательный string Идентификатор аккаунта в зависимости от account_type:
credit_card - номер карты
sbp - номер телефона
crypto - адрес кошелька
steam - логин пользователя в Steam
+79123456789
account_bank обязательный integer Member ID банка для account_type=sbp. Список доступных банков вы можете получить в этом разделе 100000000032
card_holder обязательный string Держатель карты для account_type=credit_card. Как указано на карте. IVAN IVANOV
account_network обязательный string Сеть для отправки криптовалюты/токенов для account_type=crypto. TRX - Tron сеть, ETH - Ethereum. TRX ETH TRX
account_currency enum Валюта баланса USD RUB EUR RUB
recipient_pays_commission boolean Параметр отвечающий за то, кто платит комиссию (true - комиссию платит получающий выплату, если false - то комиссия будет вычтена с баланса аккаунта) true false false
order_id string Уникальный идентификатор заказа. payout-384685192
  • amount decimal обязательный
    Сумма выплаты
    Пример: 380.99
  • currency enum обязательный
    Валюта
    Возможные значения: USD RUB EUR
    Пример: RUB
  • account_type enum обязательный
    Тип аккаунта, на который отправляются средства
    Возможные значения: credit_card sbp crypto steam
    Пример: credit_card
  • account_identifier string обязательный
    Идентификатор аккаунта в зависимости от account_type:
    credit_card - номер карты
    sbp - номер телефона
    crypto - адрес кошелька
    steam - логин пользователя в Steam
    Пример: +79123456789
  • account_bank integer обязательный
    Member ID банка для account_type=sbp. Список доступных банков вы можете получить в этом разделе
    Пример: 100000000032
  • card_holder string обязательный
    Держатель карты для account_type=credit_card. Как указано на карте.
    Пример: IVAN IVANOV
  • account_network string обязательный
    Сеть для отправки криптовалюты/токенов для account_type=crypto. TRX - Tron сеть, ETH - Ethereum.
    Возможные значения: TRX ETH
    Пример: TRX
  • account_currency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • recipient_pays_commission boolean
    Параметр отвечающий за то, кто платит комиссию (true - комиссию платит получающий выплату, если false - то комиссия будет вычтена с баланса аккаунта)
    Возможные значения: true false
    Пример: false
  • order_id string
    Уникальный идентификатор заказа.
    Пример: payout-384685192

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

Название параметра Тип Описание Возможные значения Пример
data array Payout Информация о выплате См. описание Payout Resource
success boolean Флаг успешности запроса true false true
  • data array, Payout
    Информация о выплате
    Пример: См. описание Payout Resource
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/payout/regular/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-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": "4242424242424242",
            "currency": "RUB",
            "account_amount": null,
            "account_commission": null,
            "account_currency": "RUB",
            "created_at": "2024-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.payout_account_banned Платежный аккаунт заблокирован
400 api:error.daily_payout_limit_exceeded Превышен дневной лимит для аккаунта
400 api:error.monthly_payout_limit_exceeded Превышен месячный лимит для аккаунта
400 api:error.balance_not_enough Недостаточно средств для выплаты. В errors.balance — фактический баланс, в errors.available — сумма, доступная к расходованию с учётом порога
400 api:error.direction_not_available Выплата на данный аккаунт недоступна
400 api:error.merchant_not_verified Мерчант не верифицирован
400 api:error.rub_payout_offer_not_accepted Владелец кабинета не принял оферту для рублёвых выплат: выплаты на российские карты и по СБП недоступны до её принятия в личном кабинете
403 This action is unauthorized Мерчант не верифицирован
422 Ошибка валидации входных данных
422 api:error.validation Выплата с таким order_id уже существует: в errors только ключ order_id
500 api:error.general_error Внутренняя ошибка

Отменяет выплату, ожидающую модерации (статус MODERATING). Заблокированная сумма возвращается на доступный баланс. Выплаты в любом другом статусе отменить нельзя.

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

Название параметра Тип Описание Возможные значения Пример
id обязательный string Уникальный идентификатор выплаты. Обязателен, если не передан order_id LXZv3R7Q8B
order_id обязательный string Уникальный идентификатор заказа. Обязателен, если не передан id payout-19238465
  • id string обязательный
    Уникальный идентификатор выплаты. Обязателен, если не передан order_id
    Пример: LXZv3R7Q8B
  • order_id string обязательный
    Уникальный идентификатор заказа. Обязателен, если не передан id
    Пример: payout-19238465

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор выплаты LXZv3R7Q8B
status enum Статус выплаты NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Уникальный идентификатор заказа payout-19238465
account_identifier string Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address 2202201234567046
account_bank string Банк получателя. Присутствует для карт и СБП, если банк известен Sberbank
amount decimal В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты 4000
account_amount decimal Сумма, списанная с баланса 4039.65
commission decimal Комиссия сервиса 39.65
account_commission decimal Комиссия сервиса в валюте баланса 39.65
currency enum Валюта выплаты USD RUB EUR RUB
account_currency enum Валюта баланса USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Дата и время создания выплаты 2024-12-19 17:32:55
error_code integer Код ошибки 400
error_message string Описание ошибки Превышены лимиты
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор выплаты
    Пример: LXZv3R7Q8B
  • status enum
    Статус выплаты
    Возможные значения: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Пример: NEW
  • order_id string
    Уникальный идентификатор заказа
    Пример: payout-19238465
  • account_identifier string
    Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address
    Пример: 2202201234567046
  • account_bank string
    Банк получателя. Присутствует для карт и СБП, если банк известен
    Пример: Sberbank
  • amount decimal
    В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
    Пример: 4000
  • account_amount decimal
    Сумма, списанная с баланса
    Пример: 4039.65
  • commission decimal
    Комиссия сервиса
    Пример: 39.65
  • account_commission decimal
    Комиссия сервиса в валюте баланса
    Пример: 39.65
  • currency enum
    Валюта выплаты
    Возможные значения: USD RUB EUR
    Пример: RUB
  • account_currency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания выплаты
    Пример: 2024-12-19 17:32:55
  • error_code integer
    Код ошибки
    Пример: 400
  • error_message string
    Описание ошибки
    Пример: Превышены лимиты
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/payout/cancel' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'id=lGPmp4mYeE'

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

{
    "id": "lGPmp4mYeE",
    "status": "DECLINED",
    "amount": 1600,
    "commission": 100,
    "account_identifier": "6764540000007272",
    "currency": "RUB",
    "account_amount": 1600,
    "account_commission": 100,
    "account_currency": "RUB",
    "created_at": "2024-10-19 17:00:00",
    "success": true
}

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

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
400 api:error.payout_cannot_be_cancelled Выплату нельзя отменить в текущем статусе. Отменить можно только выплату, ожидающую модерации
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_not_found Мерчант не найден
422 api:error.validation Выплата не найдена
500 api:error.general_error Внутренняя ошибка

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

Название параметра Тип Описание Возможные значения Пример
id обязательный string Уникальный идентификатор выплаты. Обязателен, если не передан order_id LXZv3R7Q8B
order_id обязательный string Уникальный идентификатор заказа. Обязателен, если не передан id payout-19238465
  • id string обязательный
    Уникальный идентификатор выплаты. Обязателен, если не передан order_id
    Пример: LXZv3R7Q8B
  • order_id string обязательный
    Уникальный идентификатор заказа. Обязателен, если не передан id
    Пример: payout-19238465

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор выплаты LXZv3R7Q8B
status enum Статус выплаты NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Уникальный идентификатор заказа payout-19238465
account_identifier string Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address 2202201234567046
account_bank string Банк получателя. Присутствует для карт и СБП, если банк известен Sberbank
amount decimal В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты 4000
account_amount decimal Сумма, списанная с баланса 4039.65
commission decimal Комиссия сервиса 39.65
account_commission decimal Комиссия сервиса в валюте баланса 39.65
currency enum Валюта выплаты USD RUB EUR RUB
account_currency enum Валюта баланса USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Дата и время создания выплаты 2024-12-19 17:32:55
error_code integer Код ошибки 400
error_message string Описание ошибки Превышены лимиты
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор выплаты
    Пример: LXZv3R7Q8B
  • status enum
    Статус выплаты
    Возможные значения: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Пример: NEW
  • order_id string
    Уникальный идентификатор заказа
    Пример: payout-19238465
  • account_identifier string
    Платежный аккаунт, на который производится выплата, без маски: полный номер карты, полный номер телефона; crypto - сеть и полный адрес кошелька в виде network:address
    Пример: 2202201234567046
  • account_bank string
    Банк получателя. Присутствует для карт и СБП, если банк известен
    Пример: Sberbank
  • amount decimal
    В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
    Пример: 4000
  • account_amount decimal
    Сумма, списанная с баланса
    Пример: 4039.65
  • commission decimal
    Комиссия сервиса
    Пример: 39.65
  • account_commission decimal
    Комиссия сервиса в валюте баланса
    Пример: 39.65
  • currency enum
    Валюта выплаты
    Возможные значения: USD RUB EUR
    Пример: RUB
  • account_currency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания выплаты
    Пример: 2024-12-19 17:32:55
  • error_code integer
    Код ошибки
    Пример: 400
  • error_message string
    Описание ошибки
    Пример: Превышены лимиты
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X GET 'https://cardlink.link/api/v1/payout/status?id=lGPmp4mYeE' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

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

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

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_not_found Мерчант не найден
422 api:error.validation Выплата не найдена: в errors ключ id или order_id — в зависимости от переданного параметра
422 api:error.validation Ошибка валидации входных данных

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

Нет

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

Название параметра Тип Описание Возможные значения Пример
data array SBP Bank Массив банков См. описание SBP Bank Resource
success boolean Флаг успешности запроса true false true
  • data array, SBP Bank
    Массив банков
    Пример: См. описание SBP Bank Resource
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X GET 'https://cardlink.link/api/v1/payout/dictionaries/sbp_banks' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

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

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

Код ответа Ключ ошибки Описание ошибки
401 Unauthenticated Неверный API Токен
403 api:error.access_denied Мерчант не имеет доступ до магазина
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_not_found Мерчант не найден
422 Ошибка валидации входных данных

Refund

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор возврата 5QWlqB2kKJ
status string Статус возврата NEW PROCESS SUCCESS FAIL NEW
amount decimal Сумма возврата 1355.91
currency enum Валюта USD RUB EUR RUB
entity_type string Тип возврата payment payment
entity_id string Уникальный идентификатор платежа, по которому производится возврат LXZv3R7Q8B
operation_id string Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Дата и время создания возврата 2024-12-19 17:32:55
  • id string
    Уникальный идентификатор возврата
    Пример: 5QWlqB2kKJ
  • status string
    Статус возврата
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: NEW
  • amount decimal
    Сумма возврата
    Пример: 1355.91
  • currency enum
    Валюта
    Возможные значения: USD RUB EUR
    Пример: RUB
  • entity_type string
    Тип возврата
    Возможные значения: payment
    Пример: payment
  • entity_id string
    Уникальный идентификатор платежа, по которому производится возврат
    Пример: LXZv3R7Q8B
  • operation_id string
    Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам
    Пример: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания возврата
    Пример: 2024-12-19 17:32:55

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

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

Название параметра Тип Описание Возможные значения Пример
payment_id обязательный string Уникальный идентификатор платежа LXZv3R7Q8B
order_id string Идентификатор заказа на вашей стороне. Будет возвращен в postback. fa982948-c58a-4fc0-a62d-a5125c907766
  • payment_id string обязательный
    Уникальный идентификатор платежа
    Пример: LXZv3R7Q8B
  • order_id string
    Идентификатор заказа на вашей стороне. Будет возвращен в postback.
    Пример: fa982948-c58a-4fc0-a62d-a5125c907766

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор возврата 5QWlqB2kKJ
status string Статус возврата NEW PROCESS SUCCESS FAIL NEW
amount decimal Сумма возврата 1355.91
currency enum Валюта USD RUB EUR RUB
entity_type string Тип возврата payment payment
entity_id string Уникальный идентификатор платежа, по которому производится возврат LXZv3R7Q8B
operation_id string Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Дата и время создания возврата 2024-12-19 17:32:55
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор возврата
    Пример: 5QWlqB2kKJ
  • status string
    Статус возврата
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: NEW
  • amount decimal
    Сумма возврата
    Пример: 1355.91
  • currency enum
    Валюта
    Возможные значения: USD RUB EUR
    Пример: RUB
  • entity_type string
    Тип возврата
    Возможные значения: payment
    Пример: payment
  • entity_id string
    Уникальный идентификатор платежа, по которому производится возврат
    Пример: LXZv3R7Q8B
  • operation_id string
    Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам
    Пример: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания возврата
    Пример: 2024-12-19 17:32:55
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/refund/full/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'payment_id=LXZv3R7Q8B'

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

{
    "id": "5QWlqB2kKJ",
    "status": "NEW",
    "amount": 1355.91,
    "currency": "RUB",
    "entity_type": "payment",
    "entity_id": "LXZv3R7Q8B",
    "created_at": "2024-10-19 17:00:00",
    "success": true
}

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

Код ответа Ключ ошибки Описание ошибки
400 api:error.balance_not_enough Недостаточно баланса для выплаты
400 api:error.refund_tariff_not_found Тариф возврата для магазина не настроен
401 Unauthenticated Неверный API Токен
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.merchant_not_found Мерчант не найден
403 This action is unauthorized Мерчант не верифицирован
500 api:error.general_error Внутренняя ошибка

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

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

Название параметра Тип Описание Возможные значения Пример
payment_id обязательный string Уникальный идентификатор платежа LXZv3R7Q8B
amount обязательный decimal Сумма частичного возврата 1355.91
order_id string Идентификатор заказа на вашей стороне. Будет возвращен в postback. fa982948-c58a-4fc0-a62d-a5125c907766
  • payment_id string обязательный
    Уникальный идентификатор платежа
    Пример: LXZv3R7Q8B
  • amount decimal обязательный
    Сумма частичного возврата
    Пример: 1355.91
  • order_id string
    Идентификатор заказа на вашей стороне. Будет возвращен в postback.
    Пример: fa982948-c58a-4fc0-a62d-a5125c907766

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор возврата 5QWlqB2kKJ
status string Статус возврата NEW PROCESS SUCCESS FAIL NEW
amount decimal Сумма возврата 1355.91
currency enum Валюта USD RUB EUR RUB
entity_type string Тип возврата payment payment
entity_id string Уникальный идентификатор платежа, по которому производится возврат LXZv3R7Q8B
operation_id string Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Дата и время создания возврата 2024-12-19 17:32:55
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор возврата
    Пример: 5QWlqB2kKJ
  • status string
    Статус возврата
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: NEW
  • amount decimal
    Сумма возврата
    Пример: 1355.91
  • currency enum
    Валюта
    Возможные значения: USD RUB EUR
    Пример: RUB
  • entity_type string
    Тип возврата
    Возможные значения: payment
    Пример: payment
  • entity_id string
    Уникальный идентификатор платежа, по которому производится возврат
    Пример: LXZv3R7Q8B
  • operation_id string
    Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам
    Пример: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания возврата
    Пример: 2024-12-19 17:32:55
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X POST 'https://cardlink.link/api/v1/refund/partial/create' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'payment_id=LXZv3R7Q8B'

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

{
    "id": "5QWlqB2kKJ",
    "status": "NEW",
    "amount": 1355.91,
    "currency": "RUB",
    "entity_type": "payment",
    "entity_id": "LXZv3R7Q8B",
    "created_at": "2024-10-19 17:00:00",
    "success": true
}

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

Код ответа Ключ ошибки Описание ошибки
400 api:error.balance_not_enough Недостаточно баланса для выплаты
400 api:error.refund_tariff_not_found Тариф возврата для магазина не настроен
401 Unauthenticated Неверный API Токен
403 api:error.ip_access_denied IP не внесен в вайтлист
403 api:error.merchant_banned Доступ для мерчанта запрещен
403 api:error.merchant_not_found Мерчант не найден
403 This action is unauthorized Мерчант не верифицирован
500 api:error.general_error Внутренняя ошибка

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

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

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

Название параметра Тип Описание Возможные значения Пример
id string Уникальный идентификатор возврата 5QWlqB2kKJ
status string Статус возврата NEW PROCESS SUCCESS FAIL NEW
amount decimal Сумма возврата 1355.91
currency enum Валюта USD RUB EUR RUB
entity_type string Тип возврата payment payment
entity_id string Уникальный идентификатор платежа, по которому производится возврат LXZv3R7Q8B
operation_id string Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Дата и время создания возврата 2024-12-19 17:32:55
success boolean Флаг успешности запроса true false true
  • id string
    Уникальный идентификатор возврата
    Пример: 5QWlqB2kKJ
  • status string
    Статус возврата
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: NEW
  • amount decimal
    Сумма возврата
    Пример: 1355.91
  • currency enum
    Валюта
    Возможные значения: USD RUB EUR
    Пример: RUB
  • entity_type string
    Тип возврата
    Возможные значения: payment
    Пример: payment
  • entity_id string
    Уникальный идентификатор платежа, по которому производится возврат
    Пример: LXZv3R7Q8B
  • operation_id string
    Идентификатор операции списания, по которой сделан возврат. Возвращается только у возвратов по двухстадийным платежам
    Пример: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Дата и время создания возврата
    Пример: 2024-12-19 17:32:55
  • success boolean
    Флаг успешности запроса
    Возможные значения: true false
    Пример: true

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

curl -X GET 'https://cardlink.link/api/v1/refund/status?id=LXZv3R7Q8B' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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

{
    "id": "5QWlqB2kKJ",
    "status": "NEW",
    "amount": 1355.91,
    "currency": "RUB",
    "entity_type": "payment",
    "entity_id": "LXZv3R7Q8B",
    "created_at": "2024-10-19 17:00:00",
    "success": true
}

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

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

Postback

В результате выполнения платежа, на Result URL, указанный в настройках магазина, отправляется POST запрос с информацией о платеже. Запрос отправляется в формате 'application/x-www-form-urlencoded'. Если по какой-либо причине ваш сервер не ответил кодом 200, то уведомление будет отправлено еще раз. Стратегия переотправки postback экспоненциальная: 1 раз в 10 ^ номер попытки секунд (10 сек, 100 сек, 1000 сек...). Всего 5 попыток переотправки.

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

Название параметра Тип Описание Возможные значения Пример
InvId обязательный string Уникальный идентификатор заказа, переданный при формировании счета payment-19238465
OutSum обязательный decimal Сумма платежа 380.55
Commission обязательный decimal Комиссия с платежа 30.55
TrsId обязательный string Уникальный идентификатор счета LXZv3R7Q8B
Status обязательный enum Статус платежа SUCCESS UNDERPAID OVERPAID FAIL SUCCESS
CurrencyIn обязательный enum Валюта, в которой оплачивался счет USD RUB EUR RUB
custom string Произвольное поле, переданное при формировании счета additional_information
AccountType enum Метод оплаты BANK_CARD SBP BANK_CARD
AccountNumber string Дополнительная информация о методе оплаты 220220******7046
BalanceAmount decimal Сумма, которая зачислена на баланс 350.00
BalanceCurrency enum Валюта, в которой было зачисление денежных средств на баланс USD RUB EUR RUB
PayerPhone string Телефон плательщика 79112223344
PayerEmail string Почта плательщика payer@example.com
PayerName string Имя плательщика Ivan
PayerComment string Комментарий плательщика Payment comment
ErrorCode integer Код ошибки 666
ErrorMessage string Описание ошибки General error
SignatureValue обязательный string Подпись запроса. Формируется следующим образом: strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • InvId string обязательный
    Уникальный идентификатор заказа, переданный при формировании счета
    Пример: payment-19238465
  • OutSum decimal обязательный
    Сумма платежа
    Пример: 380.55
  • Commission decimal обязательный
    Комиссия с платежа
    Пример: 30.55
  • TrsId string обязательный
    Уникальный идентификатор счета
    Пример: LXZv3R7Q8B
  • Status enum обязательный
    Статус платежа
    Возможные значения: SUCCESS UNDERPAID OVERPAID FAIL
    Пример: SUCCESS
  • CurrencyIn enum обязательный
    Валюта, в которой оплачивался счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • custom string
    Произвольное поле, переданное при формировании счета
    Пример: additional_information
  • AccountType enum
    Метод оплаты
    Возможные значения: BANK_CARD SBP
    Пример: BANK_CARD
  • AccountNumber string
    Дополнительная информация о методе оплаты
    Пример: 220220******7046
  • BalanceAmount decimal
    Сумма, которая зачислена на баланс
    Пример: 350.00
  • BalanceCurrency enum
    Валюта, в которой было зачисление денежных средств на баланс
    Возможные значения: USD RUB EUR
    Пример: RUB
  • PayerPhone string
    Телефон плательщика
    Пример: 79112223344
  • PayerEmail string
    Почта плательщика
    Пример: payer@example.com
  • PayerName string
    Имя плательщика
    Пример: Ivan
  • PayerComment string
    Комментарий плательщика
    Пример: Payment comment
  • ErrorCode integer
    Код ошибки
    Пример: 666
  • ErrorMessage string
    Описание ошибки
    Пример: General error
  • SignatureValue string обязательный
    Подпись запроса. Формируется следующим образом: strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))
    Пример: DC32D403CE6BD2E54D4D213278DB286C

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

curl -X POST 'https://cardlink.link/callback/payment/success' \
-d 'InvId=123' \
-d 'OutSum=12345' \
-d 'CurrencyIn=RUB' \
-d 'Commission=123' \
-d 'TrsId=AbxvAM6vJk' \
-d 'Status=SUCCESS' \
-d 'custom=custom_information' \
-d 'AccountType=BANK_CARD' \
-d 'AccountNumber=220220******7046' \
-d 'BalanceAmount=123' \
-d 'BalanceCurrency=RUB' \
-d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

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

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

Название параметра Тип Описание Возможные значения Пример
TrsId обязательный string Уникальный идентификатор выплаты LXZv3R7Q8B
InvId string Поле order_id, переданное при создании выплаты. Может быть null, если не передавалось payout-19238465
Amount обязательный decimal Сумма выплаты вместе с комиссией 3150.00
IsAuto обязательный boolean Флаг автоматической выплаты true false false
Status обязательный enum Статус выплаты SUCCESS DECLINED FAIL SUCCESS
Currency обязательный enum Валюта, в которой производится выплата USD RUB EUR USDT RUB
Commission обязательный decimal Комиссия системы в валюте выплаты 150.00
AccountType enum Тип аккаунта, на который отправляются средства BANK_CARD SBP CRYPTO BANK_CARD
AccountNumber string Идентификатор аккаунта в зависимости от AccountType:
BANK_CARD - полный номер карты
SBP - полный номер телефона
CRYPTO - сеть и полный адрес кошелька в виде network:address
2202201234567046
BalanceAmount decimal Сумма, списанная с баланса 3150.00
BalanceCommission decimal Комиссия системы, в валюте баланса 150.00
BalanceCurrency enum Валюта баланса USD RUB EUR RUB
CommissionApplyType enum Кто платил комиссию sender recipient sender
SignatureValue обязательный string Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • TrsId string обязательный
    Уникальный идентификатор выплаты
    Пример: LXZv3R7Q8B
  • InvId string
    Поле order_id, переданное при создании выплаты. Может быть null, если не передавалось
    Пример: payout-19238465
  • Amount decimal обязательный
    Сумма выплаты вместе с комиссией
    Пример: 3150.00
  • IsAuto boolean обязательный
    Флаг автоматической выплаты
    Возможные значения: true false
    Пример: false
  • Status enum обязательный
    Статус выплаты
    Возможные значения: SUCCESS DECLINED FAIL
    Пример: SUCCESS
  • Currency enum обязательный
    Валюта, в которой производится выплата
    Возможные значения: USD RUB EUR USDT
    Пример: RUB
  • Commission decimal обязательный
    Комиссия системы в валюте выплаты
    Пример: 150.00
  • AccountType enum
    Тип аккаунта, на который отправляются средства
    Возможные значения: BANK_CARD SBP CRYPTO
    Пример: BANK_CARD
  • AccountNumber string
    Идентификатор аккаунта в зависимости от AccountType:
    BANK_CARD - полный номер карты
    SBP - полный номер телефона
    CRYPTO - сеть и полный адрес кошелька в виде network:address
    Пример: 2202201234567046
  • BalanceAmount decimal
    Сумма, списанная с баланса
    Пример: 3150.00
  • BalanceCommission decimal
    Комиссия системы, в валюте баланса
    Пример: 150.00
  • BalanceCurrency enum
    Валюта баланса
    Возможные значения: USD RUB EUR
    Пример: RUB
  • CommissionApplyType enum
    Кто платил комиссию
    Возможные значения: sender recipient
    Пример: sender
  • SignatureValue string обязательный
    Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))
    Пример: DC32D403CE6BD2E54D4D213278DB286C

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

curl -X POST 'https://cardlink.link/callback/payout/success' \
-d 'TrsId=ZqmawDQ9B7l' \
-d 'InvId=payout-19238465' \
-d 'Amount=50010.00000000' \
-d 'IsAuto=false' \
-d 'Status=SUCCESS' \
-d 'Currency=RUB' \
-d 'Commission=10.00000000' \
-d 'AccountType=QIWI' \
-d 'AccountNumber=+79999999999' \
-d 'BalanceAmount=50010.00000000' \
-d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2' \
-d 'BalanceCurrency=RUB' \
-d 'BalanceCommission=10.00000000' \
-d 'CommissionApplyType=sender'

В результате выполнения рефанда, если в настройках магазина указан Refund URL, отправляется POST запрос с информацией о рефанде.

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

Название параметра Тип Описание Возможные значения Пример
Id обязательный string Уникальный идентификатор рефанда LXZv3R7Q8B
Amount обязательный decimal Сумма рефанда 3150.00
Currency обязательный enum Валюта, в которой производится рефанд USD RUB EUR USDT RUB
Status обязательный enum Статус рефанда SUCCESS FAIL SUCCESS
InvId обязательный string Уникальный идентификатор заказа, переданный при формировании счета, рефанд которого выполняется payment-19238465
BillId обязательный string Уникальный идентификатор счета на оплату KSvv3R7123
PaymentId обязательный string Уникальный идентификатор платежа на который произошел рефанд QSvv3R7123
SignatureValue обязательный string Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • Id string обязательный
    Уникальный идентификатор рефанда
    Пример: LXZv3R7Q8B
  • Amount decimal обязательный
    Сумма рефанда
    Пример: 3150.00
  • Currency enum обязательный
    Валюта, в которой производится рефанд
    Возможные значения: USD RUB EUR USDT
    Пример: RUB
  • Status enum обязательный
    Статус рефанда
    Возможные значения: SUCCESS FAIL
    Пример: SUCCESS
  • InvId string обязательный
    Уникальный идентификатор заказа, переданный при формировании счета, рефанд которого выполняется
    Пример: payment-19238465
  • BillId string обязательный
    Уникальный идентификатор счета на оплату
    Пример: KSvv3R7123
  • PaymentId string обязательный
    Уникальный идентификатор платежа на который произошел рефанд
    Пример: QSvv3R7123
  • SignatureValue string обязательный
    Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken))
    Пример: DC32D403CE6BD2E54D4D213278DB286C

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

curl -X POST 'https://cardlink.link/callback/refund/success' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'Id=ZqmawDQ9B7l' \
-d 'Amount=50010.00000000' \
-d 'Currency=RUB' \
-d 'Status=SUCCESS' \
-d 'InvId=payment-19238465' \
-d 'BillId=KSvv3R7123' \
-d 'PaymentId=QSvv3R7123' \
-d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2'

В результате выполнения чарджбэка, если в настройках магазина указан Chargeback URL, отправляется POST запрос с информацией о чарджбэке.

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

Название параметра Тип Описание Возможные значения Пример
Id обязательный string Уникальный идентификатор чарджбэка LXZv3R7Q8B
Status обязательный enum Статус чарджбэка SUCCESS FAIL SUCCESS
InvId обязательный string Уникальный идентификатор заказа, переданный при формировании счета, чарджбэка которого выполняется payment-19238465
BillId обязательный string Уникальный идентификатор счета на оплату KSvv3R7123
PaymentId обязательный string Уникальный идентификатор платежа на который произошел чарджбэк QSvv3R7123
SignatureValue обязательный string Подпись запроса. Формируется следующим образом: strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • Id string обязательный
    Уникальный идентификатор чарджбэка
    Пример: LXZv3R7Q8B
  • Status enum обязательный
    Статус чарджбэка
    Возможные значения: SUCCESS FAIL
    Пример: SUCCESS
  • InvId string обязательный
    Уникальный идентификатор заказа, переданный при формировании счета, чарджбэка которого выполняется
    Пример: payment-19238465
  • BillId string обязательный
    Уникальный идентификатор счета на оплату
    Пример: KSvv3R7123
  • PaymentId string обязательный
    Уникальный идентификатор платежа на который произошел чарджбэк
    Пример: QSvv3R7123
  • SignatureValue string обязательный
    Подпись запроса. Формируется следующим образом: strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken))
    Пример: DC32D403CE6BD2E54D4D213278DB286C

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

curl -X POST 'https://cardlink.link/callback/chargeback/success' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'Id=ZqmawDQ9B7l' \
-d 'Status=SUCCESS' \
-d 'InvId=payment-19238465' \
-d 'BillId=KSvv3R7123' \
-d 'PaymentId=QSvv3R7123' \
-d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2'

В результате выполнения P2P сделки, на Result URL, указанный в настройках магазина, отправляется POST запрос с информацией о платеже. Запрос отправляется в формате 'application/x-www-form-urlencoded'. Если по какой-либо причине ваш сервер не ответил кодом 200, то уведомление будет отправлено еще раз. Стратегия переотправки postback экспоненциальная: 1 раз в 10 ^ номер попытки секунд (10 сек, 100 сек, 1000 сек...). Всего 5 попыток переотправки.

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

Название параметра Тип Описание Возможные значения Пример
TrsId обязательный string Уникальный идентификатор P2P-сделки LXZv3R7Q8B
InvId обязательный string Поле order_id, передаваемое при создании P2P-сделки p2p-19238465
Status обязательный enum Статус P2P-сделки NEW PROCESS SUCCESS FAIL SUCCESS
Amount decimal Сумма сделки 350.00
Currency enum Валюта сделки USD RUB EUR RUB
BalanceAmount decimal Сумма, зачисленная на баланс 350.00
BalanceCurrency enum Валюта, в которой были зачислены средства на баланс USD RUB EUR RUB
Payment array Информация о платеже []
Payment[TrsId] обязательный string Уникальный идентификатор счета LXZv3R7Q8B
Payment[Status] обязательный enum Статус платежа SUCCESS UNDERPAID OVERPAID FAIL SUCCESS
Payment[AccountType] enum Метод оплаты BANK_CARD SBP BANK_CARD
Payment[AccountNumber] string Дополнительная информация о методе оплаты 220220******7046
Payment[AccountBank] string Банк используемого метода оплаты BoA
Payment[OutSum] decimal Сумма платежа 380.55
Payment[Commission] decimal Комиссия с платежа 30.55
Payment[CommissionApplyType] enum Кто платил комиссию payer recipient payer
Payment[CurrencyIn] обязательный enum Валюта, в которой оплачивался счет USD RUB EUR RUB
Payment[ErrorCode] integer Код ошибки 666
Payment[ErrorMessage] string Описание ошибки General error
Payout array Информация о выплате []
Payout[TrsId] обязательный string Уникальный идентификатор выплаты LXZv3R7Q8B
Payout[Status] обязательный enum Статус выплаты SUCCESS DECLINED FAIL SUCCESS
Payout[AccountType] enum Тип аккаунта, на который отправляются средства BANK_CARD SBP CRYPTO STEAM BANK_CARD
Payout[AccountNumber] string Идентификатор аккаунта в зависимости от AccountType:
BANK_CARD - номер карты
SBP - номер телефона
220220******7046
Payout[Amount] обязательный decimal Сумма выплаты вместе с комиссией 3150.00
Payout[Commission] обязательный decimal Комиссия системы в валюте выплаты 150.00
Payout[CommissionApplyType] обязательный enum Кто платил комиссию sender recipient sender
Payout[Currency] обязательный enum Валюта, в которой производится выплата USD RUB EUR USDT RUB
Payout[ErrorCode] integer Код ошибки 666
Payout[ErrorMessage] string Описание ошибки General error
SignatureValue обязательный string Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken)) DC32DD4D2B286C
  • TrsId string обязательный
    Уникальный идентификатор P2P-сделки
    Пример: LXZv3R7Q8B
  • InvId string обязательный
    Поле order_id, передаваемое при создании P2P-сделки
    Пример: p2p-19238465
  • Status enum обязательный
    Статус P2P-сделки
    Возможные значения: NEW PROCESS SUCCESS FAIL
    Пример: SUCCESS
  • Amount decimal
    Сумма сделки
    Пример: 350.00
  • Currency enum
    Валюта сделки
    Возможные значения: USD RUB EUR
    Пример: RUB
  • BalanceAmount decimal
    Сумма, зачисленная на баланс
    Пример: 350.00
  • BalanceCurrency enum
    Валюта, в которой были зачислены средства на баланс
    Возможные значения: USD RUB EUR
    Пример: RUB
  • Payment array
    Информация о платеже
    Пример: []
  • Payment[TrsId] string обязательный
    Уникальный идентификатор счета
    Пример: LXZv3R7Q8B
  • Payment[Status] enum обязательный
    Статус платежа
    Возможные значения: SUCCESS UNDERPAID OVERPAID FAIL
    Пример: SUCCESS
  • Payment[AccountType] enum
    Метод оплаты
    Возможные значения: BANK_CARD SBP
    Пример: BANK_CARD
  • Payment[AccountNumber] string
    Дополнительная информация о методе оплаты
    Пример: 220220******7046
  • Payment[AccountBank] string
    Банк используемого метода оплаты
    Пример: BoA
  • Payment[OutSum] decimal
    Сумма платежа
    Пример: 380.55
  • Payment[Commission] decimal
    Комиссия с платежа
    Пример: 30.55
  • Payment[CommissionApplyType] enum
    Кто платил комиссию
    Возможные значения: payer recipient
    Пример: payer
  • Payment[CurrencyIn] enum обязательный
    Валюта, в которой оплачивался счет
    Возможные значения: USD RUB EUR
    Пример: RUB
  • Payment[ErrorCode] integer
    Код ошибки
    Пример: 666
  • Payment[ErrorMessage] string
    Описание ошибки
    Пример: General error
  • Payout array
    Информация о выплате
    Пример: []
  • Payout[TrsId] string обязательный
    Уникальный идентификатор выплаты
    Пример: LXZv3R7Q8B
  • Payout[Status] enum обязательный
    Статус выплаты
    Возможные значения: SUCCESS DECLINED FAIL
    Пример: SUCCESS
  • Payout[AccountType] enum
    Тип аккаунта, на который отправляются средства
    Возможные значения: BANK_CARD SBP CRYPTO STEAM
    Пример: BANK_CARD
  • Payout[AccountNumber] string
    Идентификатор аккаунта в зависимости от AccountType:
    BANK_CARD - номер карты
    SBP - номер телефона
    Пример: 220220******7046
  • Payout[Amount] decimal обязательный
    Сумма выплаты вместе с комиссией
    Пример: 3150.00
  • Payout[Commission] decimal обязательный
    Комиссия системы в валюте выплаты
    Пример: 150.00
  • Payout[CommissionApplyType] enum обязательный
    Кто платил комиссию
    Возможные значения: sender recipient
    Пример: sender
  • Payout[Currency] enum обязательный
    Валюта, в которой производится выплата
    Возможные значения: USD RUB EUR USDT
    Пример: RUB
  • Payout[ErrorCode] integer
    Код ошибки
    Пример: 666
  • Payout[ErrorMessage] string
    Описание ошибки
    Пример: General error
  • SignatureValue string обязательный
    Подпись запроса. Формируется следующим образом: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))
    Пример: DC32DD4D2B286C

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

curl -X POST 'https://cardlink.link/callback/p2p-deal/success' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'TrsId=AbxvAM6vJk' \
-d 'InvId=123' \
-d 'Status=SUCCESS' \
-d 'Amount=123' \
-d 'Currency=RUB' \
-d 'BalanceAmount=123' \
-d 'BalanceCurrency=RUB' \
-d 'Payment=' \
-d 'Payout=' \
-d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

Дополнительно

Название параметра Тип Описание Возможные значения Пример
path string Ссылка на страницу без курсора https://cardlink.link/api/v1/search
per_page integer Количество элементов на странице 1000
prev_cursor string Указатель на предыдущую страницу eyJpZCI6NzU2LCJfcG9pbnRzVG9O
next_cursor string Указатель на следующую страницу eyJpZCI6NzY1LCJfcG9pbnRzVG91
  • path string
    Ссылка на страницу без курсора
    Пример: https://cardlink.link/api/v1/search
  • per_page integer
    Количество элементов на странице
    Пример: 1000
  • prev_cursor string
    Указатель на предыдущую страницу
    Пример: eyJpZCI6NzU2LCJfcG9pbnRzVG9O
  • next_cursor string
    Указатель на следующую страницу
    Пример: eyJpZCI6NzY1LCJfcG9pbnRzVG91

Это действие необратимо