API

Общая информация

Запросы

Структура запроса

Ответы

Структура ответа

Справочник статусов финансовой операции

Общий алгоритм определения результата операции

Справочник кодов ошибок процессора (ISO8583)

Справочник кодов ошибок PSP

Коллбэки

Подпись запроса/ответа

method=c2b,fin_instrument=acquiring,id_client=test,id_request=e5d50146-04d1-4071,currency=643,amount=970.0,pan_src=5547810000004672,exp_month_src=03,exp_year_src=2023,cvc_src=123,return_url_success=https:/mysite.com/success,return_url_fail=https://mysite.com/fail,callback_url=https://mysite.com/callback

Алгоритм взаимодействия плательщика, мерчанта и PSP при выполнении платежа

Финансовые операции

Определение результата финансовой операции

Эквайринг

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 256
method=c2b&fin_instrument=acquiring&id_client=test&id_request=202205161942&amount=11.11&desc_public=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B0&pan_src=4146577820125130&exp_month_src=11&exp_year_src=2024&cvc_src=764&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"auth_ext_ready",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "rrn":"",
   "auth_code":"",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "auth_ext_url":"https://api.pay2me.com/public/?id=auth_ext&id_auth_ext_session=gutw1scol6t2u9iw",
   "sign":"signature"
}

AFT

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 255
method=c2b&fin_instrument=transfer&id_client=test&id_request=202205161942&amount=11.11&desc_public=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B0&pan_src=4146577820125130&exp_month_src=11&exp_year_src=2024&cvc_src=764&sign=signature

{ 
"id_request": "202205161942", 
"id_order": "123456", 
"state_fin_operation": "auth_ext_ready", 
"amount": 11.11, 
"amount_authorized": 0, 
"amount_captured": 0, 
"amount_cancelled": 0, 
"amount_refunded": 0, 
"processor_transaction_id": "5CEA2D50295C1FAE", 
"rrn": "", 
"auth_code": "", 
"response_code": 0, 
"response_desc": "success", 
"processor_name": "ПромСвязьБанк", 
"auth_ext_url": "https://api.pay2me.com/public/?id=auth_ext&id_auth_ext_session=gutw1scol6t2u9iw", 
"sign": "signature" 
}

OCT

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 126
method=b2c&fin_instrument=transfer&id_client=test&id_request=202205161942&amount=11.11&pan_dst=4146577820125130&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"captured",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":11.11,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "rrn":"123456789012",
   "auth_code":"123456",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "processor_code":[
      0,
      0
   ],
   "processor_desc":[
      "Approved"
   ],
   "sign":"signature"
}

Перевод C2C

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 280
method=c2c&fin_instrument=transfer&id_client=test&id_request=202205161942&amount=11.11&desc_public=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B0&pan_src=4146577820125130&exp_month_src=11&exp_year_src=2024&cvc_src=764&pan_dst=4146577834487385&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"auth_ext_ready",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "rrn":"",
   "auth_code":"",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "auth_ext_url":"https://api.pay2me.com/public/?id=auth_ext&id_auth_ext_session=gutw1scol6t2u9iw",
   "sign":"signature"
}

Оплата C2B через СБП

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 178
method=c2b&fin_instrument=sbp&id_client=test&id_request=202205161942&amount=11.11&desc_public=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B0&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"pending",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "sbp_qr_id":"AD100074RGN88G1L9EJATRAIGR2FKO6B",
   "sbp_transaction_id":"",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "sbp_link":"https://qr.nspk.ru/AD10002RND70DAGM90B84THR5BTHI72A?type=02&bank=100000000015&sum=1000&cur=RUB&crc=BAEB",
   "sbp_qr_media_type":"image/png",
   "sbp_qr":"iVBORw0KGgoAAAANSUhEUgAAASwAAA…",
   "sign":"signature"
}

Выплата B2C через СБП

POST /psp HTTP/1.1
  Host: api.pay2me.com
  Content-Type: application/x-www-form-urlencoded
  Content-Length: 144
  method=b2c&fin_instrument=sbp&id_client=test&id_request=202205161942&amount=11.11&bank_id_dst=123456789012&msisdn_dst=79998887766&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"captured",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":11.11,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "sbp_transaction_id":"A2153153147429010000056517BE1DD5",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "processor_code":[
      0,
      0
   ],
   "processor_desc":[
      "Approved"
   ],
   "sign":"signature"
}

Отмена

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 108
method=cancel&id_client=test&id_request=202205161942&id_request_parent=202205161941&amount=10&sign=signature

{
   "id_request":"202205161942",
   "id_request_parent":"202205161941",
   "id_order ":"123456",
   "id_order_parent":"123456",
   "state_fin_operation":"captured",
   "amount":10,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "rrn":"123456789012",
   "auth_code":"123456",
   "state_fin_operation_parent":"cancelled_partially",
   "amount_parent":11.11,
   "amount_authorized_parent":0,
   "amount_captured_parent":1.11,
   "amount_cancelled_parent":10,
   "amount_refunded_parent":0,
   "processor_transaction_id_parent":"5CEA2D50295C1FAE",
   "rrn_parent":"123456789012",
   "auth_code_parent":"123456",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "processor_code":[
      0,
      0
   ],
   "processor_desc":[
      "Approved"
   ],
   "processor_code_parent":[
      0,
      0
   ],
   "processor_desc_parent":[
      "Approved"
   ],
   "sign":"signature"
}

Возврат

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 108
method=refund&id_client=test&id_request=202205161942&id_request_parent=202205161941&amount=10&sign=signature

{
   "id_request":"202205161942",
   "id_request_parent":"202205161941",
   "id_order ":"123456",
   "id_order_parent":"123456",
   "state_fin_operation":"captured",
   "amount":10,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"5CEA2D50295C1FAE",
   "rrn":"123456789012",
   "auth_code":"123456",
   "state_fin_operation_parent":"refunded_partially",
   "amount_parent":11.11,
   "amount_authorized_parent":0,
   "amount_captured_parent":1.11,
   "amount_cancelled_parent":0,
   "amount_refunded_parent":10,
   "processor_transaction_id_parent":"5CEA2D50295C1FAE",
   "rrn_parent":"123456789012",
   "auth_code_parent":"123456",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "processor_code":[
      0,
      0
   ],
   "processor_desc":[
      "Approved"
   ],
   "processor_code_parent":[
      0,
      0
   ],
   "processor_desc_parent":[
      "Approved"
   ],
   "sign":"signature"
}

Запрос баланса

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 121

method=balance&id_request=20230808064556912&id_client=test&sign=signature

{
 "id_request": "2023-08-08T06:45:56.912Z",
 "response_code": 0,
 "response_desc": "success",
 "processor_name": "ПромСвязьБанк",
 "balance": "99013921.73",
 "sign": "signature"
}

Сервисные операции

Определение сервисной операции

Запрос статуса

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 98
method=status&id_client=test&id_request=202205161942&id_request_parent=202205161941&sign=signature

{
   "id_request":"202205161942",
   "id_request_parent":"202205161941",
   "id_order ":"123456",
   "id_order_parent":"123456",
   "state_fin_operation_parent":"cancelled_partially",
   "amount_parent":11.11,
   "amount_authorized_parent":0,
   "amount_captured_parent":1.11,
   "amount_cancelled_parent":10,
   "amount_refunded_parent":0,
   "processor_transaction_id_parent":"5CEA2D50295C1FAE",
   "rrn_parent":"123456789012",
   "auth_code_parent":"123456",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "processor_code_parent":[
      0,
      0
   ],
   "processor_desc_parent":[
      "Approved"
   ],
   "sign":"signature"
}

Запрос списка банков-участников СБП

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 89
method=bank_list&fin_instrument=sbp&id_client=test&id_request=202205161942&sign=signature

{
   "id_request":"202205161942",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "bank_list":[
      "…"
   ],
   "sign":"signature"
}

Создание заказа

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 89
method=create_order&id_client=test&id_request=202205161942&id_order=123456&amount=11.11&desc_public=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B0&sign=signature

{
   "id_request":"202205161942",
   "id_order":"123456",
   "state_fin_operation":"initiated",
   "amount":11.11,
   "amount_authorized":0,
   "amount_captured":0,
   "amount_cancelled":0,
   "amount_refunded":0,
   "processor_transaction_id":"",
   "rrn":"",
   "auth_code":"",
   "response_code":0,
   "response_desc":"success",
   "processor_name":"ПромСвязьБанк",
   "payment_page_url":"https://api.pay2me.com/public/?id=payment_page&id_payment_page_session=1ofegrhy9x9z4q5f",
   "sign":"signature"
}

Создание ссылки на оплату заказа

POST /psp HTTP/1.1
Host: api.pay2me.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 89
method=create_payment_page_url&id_client=test&id_request=202205161942&id_order_parent=123456&sign=signature

{
   "id_request":"202205161942",
   "id_request_parent":"202205161941",
   "id_order_parent":"123456",
   "state_fin_operation_parent":"initiated",
   "amount_parent":11.11,
   "amount_authorized_parent":0,
   "amount_captured_parent":0,
   "amount_cancelled_parent":0,
   "amount_refunded_parent":0,
   "processor_transaction_id":"",
   "rrn_parent":"",
   "auth_code_parent":"",
   "response_code":0,
   "response_desc":"success",
   "payment_page_url":"https://api.pay2me.com/public/?id=payment_page&id_payment_page_session=1ofegrhy9x9z4q5f",
   "sign":"signature"
}

Параметр receipt

{
	"params":{
		"customer_contact":"Адрес электронной почты защищен от спам-ботов. Для просмотра адреса в браузере должен быть включен Javascript.", 					// E-mail или телефон в формате +7XXXXXXXXXX, на который придет чек
		"tax_mode":"TAX_MODE_SIMPLIFIED_INCOME_MINUS_EXPENSE" 	// Режим налогообложения, может принимать значения, описанные в таблице 2. Не обязательное, по умолчанию берется из кассы либо из настроек шлюза.
		"place":"www.site.ru"									// Параметр места расчетов, по умолчанию то, которое заданно при регистрации кассы в этом поле можно указать адресс сайта либо физический адрес.
		'document_type'=>"DOCUMENT_TYPE_DEBIT"					// Тип чека, по умолчанию значение в зависимости от типа операции разрешенной на терминале. допустимые знаяения в таблице 6.
	},
	"items":[ // позиции чека
		{
			"price":"9999.99", 									// Сумма
			"description":"Оплата курса 1", 					// Название товарной позиции
			"pay_attribute": "PAY_ATTRIBUTE_FULL_PAYMENT" 		// Признак способа расчёта, может принимать значения, описанные в таблице 3. По умолчанию PAY_ATTRIBUTE_FULL_PAYMENT
			"line_attribute": "LINE_ATTRIBUTE_SERVICE"			// Признак предмета расчёта, может принимать значения, описанные в таблице 5. По умолчанию LINE_ATTRIBUTE_SERVICE
			"tax_id":"TAX_ID_VAT_20" 							// Ставка НДС, может принимать значения, описанные в таблице 1. По умолчанию TAX_ID_NO_VAT
		},
		{
			"price":"20010.52",									// Сумма
			"description":"Оплата курса 2",						// Название товарной позиции
			"qty":2 											// Количество, 1 - если не указывать
			"agent_mode":"AGENT_MODE_BANK_AGENT",				// Признак агента, может принимать значения, описанные в таблице 4. Поле не обязательно.
			"agent_data":{										// Если установлено agent_mode
				"phone":"+7XXXXXXXXXX",							// Телефон агента в формате +7XXXXXXXXXX
				"operation":"Например выдача наличных"			// Описание операции
			}
			"supplier_data":{									// Данные поставщика
				"phone":"+7XXXXXXXXXX",							// Телефон в формате +7XXXXXXXXXX
				"name":"Иванов Иван Иванович"					// Название поставщика
				"inn":"10-12 chars"								// ИНН поставщика
			}
		}
	],
	"payments" : {												// Не обязательно, сумарные значения.
		"cash":9999.99,											// Сумма оплаты наличными
		"non_cash":20010.52,									// Сумма безналичной оплаты
		"advance_payment":5000.00,								// Предварительная оплата (зачет аванса и (или) предыдущих платежей)
		"credit":1000.00, 										// Постоплата, указывается общая сумма рассрочки, применяется только для первого платежа (если в items есть хотя бы один элемент pay_attribute со значением "PAY_ATTRIBUTE_PARTIAL_PAYMENT")
		"consideration":500.00									// Сумма оплаты встречным предоставлением
	}
}

// Таблица 1. Ставка НДС
TAX_ID_VAT_20 								- ставка НДС 20%
TAX_ID_VAT_10 								- ставка НДС 10%
TAX_ID_BET_20_120 							- ставка НДС расч. 20/120
TAX_ID_BET_10_110 							- ставка НДС расч. 10/110
TAX_ID_VAT_0 								- ставка НДС 0%
TAX_ID_NO_VAT 								- НДС не облагается

// Таблица 2. Режим налогообложения
TAX_MODE_COMMON								- Общая, ОСН
TAX_MODE_SIMPLIFIED_INCOME					- Упрощенная доход, УСН доход
TAX_MODE_SIMPLIFIED_INCOME_MINUS_EXPENSE	- Упрощенная доход минус расход, УСН доход - расход
TAX_MODE_SINGLE_AGRICULTURAL_TAX			- Единый сельскохозяйственный налог, ЕСН
TAX_MODE_PATENT_TAXATION					- Патентная система налогообложения, Патент

// Таблица 3. Признак способа расчёта
PAY_ATTRIBUTE_FULL_PREPAYMENT				- Предоплата 100%
PAY_ATTRIBUTE_PREPAYMENT					- Частичная предоплата
PAY_ATTRIBUTE_ADVANCE						- Аванс
PAY_ATTRIBUTE_FULL_PAYMENT					- Полный расчет
PAY_ATTRIBUTE_PARTIAL_PAYMENT				- Частичный расчет и кредит
PAY_ATTRIBUTE_CREDIT						- Передача в кредит
PAY_ATTRIBUTE_CREDIT_PAYMENT				- оплата кредита

// Таблица 4. Признак агента
AGENT_MODE_BANK_AGENT						- банковский платежный агент
AGENT_MODE_BANK_SUBAGENT					- банковский платежный субагент
AGENT_MODE_PAYMENT_AGENT					- платежный агент
AGENT_MODE_PAYMENT_SUBAGENT					- платежный субагент
AGENT_MODE_ATTORNEY							- поверенный
AGENT_MODE_COMMISSION						- комиссионер
AGENT_MODE_ANOTHER							- иной агент

// Таблица 5. Признак предмета расчёта
LINE_ATTRIBUTE_GOODS						- Товар
LINE_ATTRIBUTE_EXCISABLE					- Подакцизный товар
LINE_ATTRIBUTE_WORK							- Работа
LINE_ATTRIBUTE_SERVICE						- Услуга
LINE_ATTRIBUTE_BETTING						- Ставка азартной игры
LINE_ATTRIBUTE_BETTING_WIN					- Выигрыш азартной игры
LINE_ATTRIBUTE_LOTTERY						- Лотерейный билет
LINE_ATTRIBUTE_LOTTERY_WIN					- Выигрыш лотереи
LINE_ATTRIBUTE_GRANTING_RIGHTS				- Предоставление РИД
LINE_ATTRIBUTE_PREPAID						- Платеж
LINE_ATTRIBUTE_REWARD						- Агентское вознаграждение
LINE_ATTRIBUTE_ITEMS						- Выплата
LINE_ATTRIBUTE_NON_ITEMS					- Иной предмет расчета
LINE_ATTRIBUTE_TRANSFER_PROPERTY_RIGHTS		- Имущественное право
LINE_ATTRIBUTE_NON_OPERATING_INCOME			- Внереализационный доход
LINE_ATTRIBUTE_TAX_REDUCTION				- Иные платежи и взносы
LINE_ATTRIBUTE_TRADE_FEE					- Торговый сбор
LINE_ATTRIBUTE_RESORT_FEE					- Курортный сбор
LINE_ATTRIBUTE_DEPOSIT						- Залог
LINE_ATTRIBUTE_EXPENSE						- Расход
LINE_ATTRIBUTE_OPS_IP						- Взносы на обязательное пенсионное страхование ИП
LINE_ATTRIBUTE_OPS							- Взносы на обязательное пенсионное страхование
LINE_ATTRIBUTE_OMS_IP						- Взносы на обязательное медицинское страхование ИП
LINE_ATTRIBUTE_OMS							- Взносы на обязательное медицинское страхование
LINE_ATTRIBUTE_OSS							- Взносы на обязательное социальное страхование
LINE_ATTRIBUTE_CASINO						- Платеж казино
LINE_ATTRIBUTE_PAYMENT						- Выдача денежных средств
LINE_ATTRIBUTE_ATNM							- АТНМ (не имеющем кода маркировки)
LINE_ATTRIBUTE_ATM							- АТМ (имеющем код маркировки)
LINE_ATTRIBUTE_TNM							- ТНМ
LINE_ATTRIBUTE_TM 							- ТМ

// Таблица 6. Тип чека
DOCUMENT_TYPE_DEBIT							- Приход
DOCUMENT_TYPE_DEBIT_REFUND					- Возврат прихода
DOCUMENT_TYPE_CREDIT						- Расход