API интеграция

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

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

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


            curl -X 
            '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	Произвольное поле, переданное при формировании счета

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


            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	Произвольное поле, переданное при формировании счета

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


            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'

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	Внутренняя категория продукта. Примеры: steam, digital/stars, digital/subscription/xbox, digital/subscription/netflix
extra	array	{"steam_account": "jordas123"}	Объект с идентификатором аккаунта, связанным с покупкой. Набор обязательных полей зависит от категории товара. Если данных нет — поле необходимо полностью исключить из запроса, не передавать пустые или нулевые значения.
extra[steam_account]	string	jordas123	Логин Steam-аккаунта, на который производится пополнение. Обязателен для товаров категории Steam.
extra[telegram_username]	string	DurovunaDR	Username Telegram-аккаунта для пополнения Stars (например: DurovunaDR). Обязателен при продаже через веб-сайт и через Telegram-бот.
extra[telegram_id]	string	5099904440	Числовой идентификатор Telegram-аккаунта (например: 5099904440). Обязателен только при продаже через Telegram-бот.
extra[account]	string	user@example.com	Аккаунт или email, на который активируется услуга (например: user@example.com). Передавать только при наличии данных.

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

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

Название параметра	Обязательный параметр	Тип	Возможные значения	Пример	Описание
amount	Да	decimal		380.99	api-doc.bill-create.request-amount-field-description
shop_id	Да	string		LXZv3R7Q8B	Уникальный идентификатор магазина, к которому относится платеж. Без этого параметра не будет работать Success URL, Fail URL и Result URL
order_id	Нет	string		order-285394168	Уникальный идентификатор заказа. Будет возвращен в postback.
description	Нет	string		Order #285394168	Описание платежа
type	Нет	enum	normal multi	normal	Тип платежа. Одноразовый или многоразовый. Если выбран одноразовый, то второй раз оплатить не получится.
locale	Нет	enum	en ru	en	Локаль, язык в котором будет отображаться форма платежа
currency_in	Нет	enum	RUB USD EUR	RUB	Валюта, в которой оплачивается счет. Если не передана, то используется валюта магазина. Если shop_id не определен, то используется RUB.
account_currency	Нет	enum	RUB USD EUR	RUB	Валюта баланса, на который должен быть зачислен платёж. Если не передана, валюта баланса определяется автоматически.
custom	Нет	string		my-custom-string	Произвольное поле. Будет возвращено в postback.
payer_pays_commission	Нет	enum	1 0	1	Параметр, который указывает на то, кто будет оплачивать комиссию за входящий платёж.
payer_data[phone]	Нет	string		+79991234567	Номер телефона плательщика.
payer_data[email]	Нет	string		payer@email.com	Параметр, который заполняет email клиента на платёжной странице.
name	Нет	string		Donation	Название ссылки. Укажите, за что принимаете средства. Этот текст будет отображен в платежной форме.
ttl	Нет	integer		600	Время жизни счета на оплату в секундах.
return_url	Нет	string		https://exmpl.com/return	URL для кнопки "Назад в магазин" на странице оплаты. Домен должен совпадать с тем, что указан при добавлении магазина в систему
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		true	Флаг отправки уведомления мерчанту на email при изменении статуса счёта.
deactivate_on_fail	Нет	boolean		false	Деактивировать счёт после первой неуспешной оплаты: новых попыток оплаты по ссылке не будет. Если параметр не передан, действует настройка магазина, которую включает поддержка по заявке. Для типа счёта multi параметр не действует.

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
success	boolean		true false	true	Флаг успешности запроса
link_url	string	URL		https://cardlink.link/link/5QWlqB2kKJ	Ссылка на страницу с QR кодом
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	Внутренняя ошибка

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

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

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

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	Указатель на страницу

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	Счет не найден

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

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

Название параметра	Обязательный параметр	Тип	Пример	Описание
start_date	Нет	datetime	2025-01-01	Начальная датавремя для получения счетов в UTC
finish_date	Нет	datetime	2024-12-01 23:59:59	Конечная датавремя для получения счетов в UTC
shop_id	Нет	string	LXZv3R7Q8B	Уникальный идентификатор магазина
order_id	Нет	string	order-285394168	Уникальный идентификатор заказа на вашей стороне
per_page	Нет	integer	50	Количество элементов на странице
cursor	Нет	string	eyJpZCI6NzY1LCJfcG	Указатель на страницу

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

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

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


            curl -X GET
            'https://cardlink.link/api/v1/bill/search                ?start_date=2024-01-01&finish_date=2025-12-01&order_id=order-285394168
            ' \

                            -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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


            {
    "success": true,
    "data": [
        {
            "id": "LXZv3R7Q5B",
            "status": "NEW",
            "type": "MULTI",
            "amount": 100.05,
            "currency_in": "RUB",
            "created_at": "2020-11-11 14:46:20"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/bill/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/bill/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/bill/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

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

Код ответа	Ключ ошибки	Описание ошибки
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		Ошибка валидации входных данных

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

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

Название параметра	Обязательный параметр	Тип	Возможные значения	Пример	Описание
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	Флаг успешности запроса

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


            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		Ошибка валидации входных данных

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

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

Нет

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	Внутренняя ошибка

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
id	string			jZqmaPvl9W	Уникальный идентификатор платежа
bill_id	string			do5G93m	Уникальный идентификатор счета, которому принадлежит платеж
bill_order_id	string			order-285394168	Уникальный идентификатор заказа. Будет возвращен в postback.
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Статус платежа
amount	decimal			4039.65	Сумма платежа
bill_amount	decimal			4000.00	Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission)
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			532100123456	RRN операции
payment_purpose	string			Invoice #123123 payment	Назначение платежа

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

С помощью этого метода вы можете получить все платежи по магазину или за произвольный период времени.

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

Название параметра	Обязательный параметр	Тип	Пример	Описание
start_date	Нет	datetime	2025-01-01	Начальная датавремя для получения платежей в UTC
finish_date	Нет	datetime	2024-12-01 23:59:59	Конечная датавремя для получения платежей в UTC
shop_id	Нет	string	LXZv3R7Q8B	Уникальный идентификатор магазина
bill_order_id	Нет	string	order-285394168	Уникальный идентификатор заказа связанного счета
per_page	Нет	integer	50	Количество элементов на странице
cursor	Нет	string	eyJpZCI6NzY1LC	Указатель на страницу

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

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

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


            curl -X GET
            'https://cardlink.link/api/v1/payment/search                ?start_date=2024-01-01&finish_date=2025-12-01&bill_order_id=order-285394168
            ' \

                            -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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


            {
    "success": true,
    "data": [
        {
            "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 #12312312",
            "created_at": "2025-10-19 17:00:00"
        },
        {
            "id": "zeAmwP2d5Q",
            "bill_id": "do5G93m",
            "bill_order_id": "order-285394168",
            "status": "NEW",
            "amount": 3200,
            "bill_amount": 3200,
            "commission": 50,
            "account_amount": 3150,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "553691******4442",
            "account_bank": "TINKOFF",
            "currency_in": "RUB",
            "created_at": "2025-10-18 17:00:00"
        },
        {
            "id": "NDa7lNmdzx",
            "bill_id": "do5G93m",
            "bill_order_id": "order-285394168",
            "status": "FAIL",
            "amount": 26100,
            "bill_amount": 26100,
            "commission": 100,
            "account_amount": 26000,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "676454******7272",
            "account_bank": "SBERBANK",
            "currency_in": "RUB",
            "created_at": "2025-10-01 17:00:00",
            "error_code": 168,
            "error_message": "Failed by timeout"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/payment/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/payment/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/payment/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

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

Код ответа	Ключ ошибки	Описание ошибки
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		Ошибка валидации входных данных

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

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

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
id	string			jZqmaPvl9W	Уникальный идентификатор платежа
bill_id	string			do5G93m	Уникальный идентификатор счета, которому принадлежит платеж
bill_order_id	string			order-285394168	Уникальный идентификатор заказа. Будет возвращен в postback.
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Статус платежа
amount	decimal			4039.65	Сумма платежа
bill_amount	decimal			4000.00	Сумма, на которую выставлен счет. В отличие от amount, не включает комиссию, переложенную на плательщика (payer_pays_commission)
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			532100123456	RRN операции
payment_purpose	string			Invoice #123123 payment	Назначение платежа
success	boolean		true false	true	Флаг успешности запроса
refunds	array	Refund		[Refund Resource]	Массив рефандов. Если был передан refunds=true
chargeback	array	Chargeback		Chargeback Resource	Чарджбек. Если существует и если был передан chargeback=true

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


            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		Ошибка валидации входных данных

Название параметра	Тип	Возможные значения	Пример	Описание
currency	enum	USD RUB EUR	RUB	Валюта баланса
balance_available	decimal		93988.37000000	Доступный баланс
balance_locked	decimal		0.00000000	Заблокированный баланс во время выплаты средств
balance_hold	decimal		0.00000000	Временно удержанный баланс. Переходит в доступный спустя время

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

Нет

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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"
        }
    ],
    "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		Ошибка валидации входных данных

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
id	string			LXZv3R7Q8B	Уникальный идентификатор выплаты
status	enum		NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED	NEW	Статус выплаты
order_id	string			payout-19238465	Уникальный идентификатор заказа
account_identifier	string			+79123456789	Платежный аккаунт, на который производится выплата
amount	decimal			4000	В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
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	100000000032	Member ID банка в системе СБП
name	string	Ренессанс Кредит	Название банка
name_en	string	Renaissance Credit	Название банка на английском языке
bic	integer	44525135	БИК банка

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

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

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

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

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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": "676454******7272",
            "currency": "RUB",
            "created_at": "2020-10-19 17:00:00"
        }
    ],
    "success": true
}

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

Код ответа	Ключ ошибки	Описание ошибки
401	Unauthenticated	Неверный API Токен
400	api:error.invalid_amount	Неверная сумма
400	api:error.merchant_banned	Доступ для мерчанта запрещен
400	api:error.merchant_not_found	Мерчант не найден
400	api:error.payout_account_not_found	Платежный аккаунт не найден
400	api:error.payout_account_banned	Платежный аккаунт заблокирован
400	api:error.daily_payout_limit_exceeded	Превышен дневной лимит для аккаунта
400	api:error.monthly_payout_limit_exceeded	Превышен месячный лимит для аккаунта
400	api:error.balance_not_enough	Недостаточно баланса для выплаты
400	api:error.direction_not_available	Выплата на данный аккаунт недоступна
400	api:error.merchant_not_verified	Мерчант не верифицирован
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		+79123456789	Идентификатор аккаунта в зависимости от account_type: credit_card - номер карты sbp - номер телефона crypto - адрес кошелька steam - логин пользователя в Steam
account_bank	Да	integer		100000000032	Member ID банка для account_type=sbp. Список доступных банков вы можете получить в этом разделе
card_holder	Да	string		IVAN IVANOV	Держатель карты для account_type=credit_card. Как указано на карте.
account_network	Да	string	TRX ETH	TRX	Сеть для отправки криптовалюты/токенов для account_type=crypto. TRX - Tron сеть, ETH - Ethereum.
account_currency	Нет	enum	USD RUB EUR	RUB	Валюта баланса
recipient_pays_commission	Нет	boolean	true false	false	Параметр отвечающий за то, кто платит комиссию (true - комиссию платит получающий выплату, если false - то комиссия будет вычтена с баланса аккаунта)
order_id	Нет	string		payout-384685192	Уникальный идентификатор заказа.

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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": "676454******7272",
            "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	Недостаточно баланса для выплаты
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		LXZv3R7Q8B	Уникальный идентификатор выплаты. Обязателен, если не передан order_id
order_id	Да	string		payout-19238465	Уникальный идентификатор заказа. Обязателен, если не передан id

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
id	string			LXZv3R7Q8B	Уникальный идентификатор выплаты
status	enum		NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED	NEW	Статус выплаты
order_id	string			payout-19238465	Уникальный идентификатор заказа
account_identifier	string			+79123456789	Платежный аккаунт, на который производится выплата
amount	decimal			4000	В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
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": "676454******7272",
    "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	Внутренняя ошибка

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

Название параметра	Обязательный параметр	Тип	Пример	Описание
start_date	Нет	datetime	2025-01-01	Начальная датавремя для получения выплат в UTC
finish_date	Нет	datetime	2024-12-01 23:59:59	Конечная датавремя для получения выплат в UTC
per_page	Нет	integer	50	Количество элементов на странице
cursor	Нет	string	eyJpZCI6NzY1LCJfcG9	Указатель на страницу

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

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

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


            curl -X GET
            'https://cardlink.link/api/v1/payout/search                ?start_date=2024-01-01&finish_date=2025-12-01
            ' \

                            -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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


            {
    "success": true,
    "data": [
        {
            "id": "gY37jYr2b6",
            "status": "MODERATING",
            "amount": 1600,
            "commission": 100,
            "account_identifier": "676454******7272",
            "account_amount": 1600,
            "account_commission": 100,
            "currency": "RUB",
            "created_at": "2024-10-19 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/payout/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/payout/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/payout/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

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

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

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

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

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
id	string			LXZv3R7Q8B	Уникальный идентификатор выплаты
status	enum		NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED	NEW	Статус выплаты
order_id	string			payout-19238465	Уникальный идентификатор заказа
account_identifier	string			+79123456789	Платежный аккаунт, на который производится выплата
amount	decimal			4000	В случае recipient_pays_commission:false поле amount - сумма выплаты с учетом комиссии, в случае recipient_pays_commission:true поле amount - оригинальная сумма выплаты
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": "676454******7272",
    "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	Флаг успешности запроса

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


            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		Ошибка валидации входных данных

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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		fa982948-c58a-4fc0-a62d-a5125c907766	Идентификатор заказа на вашей стороне. Будет возвращен в postback.

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	fa982948-c58a-4fc0-a62d-a5125c907766	Идентификатор заказа на вашей стороне. Будет возвращен в postback.

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
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	Внутренняя ошибка

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

Название параметра	Обязательный параметр	Тип	Пример	Описание
payment_id	Нет	string	X5Pvg52096	ID платежа
start_date	Нет	datetime	2025-01-01	Начальная датавремя для получения возвратов в UTC
finish_date	Нет	datetime	2024-12-01 23:59:59	Конечная датавремя для получения возвратов в UTC
per_page	Нет	integer	50	Количество элементов на странице
cursor	Нет	string	eyJpZCI6NzY1LCJfcG9	Указатель на страницу

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

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
success	boolean		true false	true	Флаг успешности запроса
data	array	refund		См. описание Refund Resource	Информация о возвратах
links	array	Links		См. описание Pagination Links	Ссылки для пагинации
meta	array	Meta		См. описание Pagination Meta	Мета данные пагинации

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


            curl -X GET
            'https://cardlink.link/api/v1/refund/search                ?payment_id=LXZv3R7Q8B&start_date=2024-01-01&finish_date=2025-12-01
            ' \

                            -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

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


            {
    "success": true,
    "data": [
        {
            "id": "5QWlqB2kKJ",
            "status": "NEW",
            "amount": 1355.91,
            "currency": "RUB",
            "entity_type": "payment",
            "entity_id": "LXZv3R7Q8B",
            "created_at": "2024-10-19 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/refund/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/refund/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/refund/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

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

Код ответа	Ключ ошибки	Описание ошибки
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	Внутренняя ошибка

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

Название параметра	Обязательный параметр	Тип	Возможные значения	Пример	Описание
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	Флаг успешности запроса

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


            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	Внутренняя ошибка

В результате выполнения платежа, на 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		DC32D403CE6BD2E54D4D213278DB286C	Подпись запроса. Формируется следующим образом: `strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))`

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


            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		payout-19238465	Поле order_id, переданное при создании выплаты. Может быть null, если не передавалось
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		220220******7046	Идентификатор аккаунта в зависимости от AccountType: BANK_CARD - номер карты SBP - номер телефона
BalanceAmount	Нет	decimal		3150.00	Сумма, списанная с баланса
BalanceCommission	Нет	decimal		150.00	Комиссия системы, в валюте баланса
BalanceCurrency	Нет	enum	USD RUB EUR	RUB	Валюта баланса
CommissionApplyType	Нет	enum	sender recipient	sender	Кто платил комиссию
SignatureValue	Да	string		DC32D403CE6BD2E54D4D213278DB286C	Подпись запроса. Формируется следующим образом: `strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))`

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


            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		DC32D403CE6BD2E54D4D213278DB286C	Подпись запроса. Формируется следующим образом: `strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken))`

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


            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		DC32D403CE6BD2E54D4D213278DB286C	Подпись запроса. Формируется следующим образом: `strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken))`

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


            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		LXZv3R7Q8B	Уникальный идентификатор P2P-сделки
InvId	Да	string		p2p-19238465	Поле order_id, передаваемое при создании P2P-сделки
Status	Да	enum	NEW PROCESS SUCCESS FAIL	SUCCESS	Статус P2P-сделки
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		220220******7046	Идентификатор аккаунта в зависимости от AccountType: BANK_CARD - номер карты SBP - номер телефона
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		DC32DD4D2B286C	Подпись запроса. Формируется следующим образом: `strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))`

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


            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'

Название параметра	Тип	Формат	Возможные значения	Пример	Описание
prev	string			https://cardlink.link/api/v1/search?cursor=eyJpZCI6NzY1LCJf	Ссылка на предыдущую страницу
next	string			https://cardlink.link/api/v1/search?cursor=eyJpZCI6NzU2LCJd	Ссылка на следующую страницу

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

Как начать?

Bill

Currencies

Payment

Balance

Payout

Refund

Postback

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

Как начать?

Bill

Currencies

Payment

Balance

Payout

Refund

Postback

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