Квадратные платежи (независимый издатель) (предварительная версия)

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

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Website	https://squareup.com/
Политика конфиденциальности	https://squareup.com/us/en/legal/general/privacy
Категории	Торговля; Продажи и CRM

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Возврат средств в терминале поиска	Извлекает отфильтрованный список запросов на возмещение средств в терминале Interac, созданных продавцом, выполняющего запрос.
Возобновление подписки	Возобновляет деактивированную подписку.
Вывод списка сегментов клиентов	Извлекает список сегментов клиентов бизнеса.
Вывод списка событий подписки	Выводит список всех событий для определенной подписки.
Вычисление порядка (бета-версия)	Позволяет приложениям предварительно просматривать цены на заказы без создания заказа.
Добавление группы в клиент	Добавляет членство в группе клиенту. Клиент определяется значением customer_id, а группа клиентов определяется значением group_id.
Завершение оплаты	Завершает (фиксирует) платеж. По умолчанию платежи устанавливаются сразу после их создания.
Заказ на оплату (бета-версия)	Оплачивайте заказ с помощью одного или нескольких утвержденных платежей или урегулирует заказ в общей сложности 0. Общее количество payment_ids, перечисленных в запросе, должно быть равно общей сумме заказа. Заказы с общим количеством 0 можно пометить как платные, указав пустой массив payment_ids в запросе.
Заказы на поиск	Выполните поиск всех заказов для одного или нескольких расположений. Заказы включают все продажи, возвраты и обмены независимо от того, как они вошли в экосистему Square (например, точка продажи, счета и интерфейсы API подключения).
Заказы на получение пакетной службы	Извлекает набор заказов по идентификаторам. Если заданный идентификатор заказа не существует, идентификатор игнорируется вместо создания ошибки.
Инвентаризация пакетных изменений	Применяет корректировки и подсчеты к указанным количествам элементов. При успешном выполнении возвращает текущие вычисляемые счетчики для всех объектов, на которые ссылается запрос.
Каталог списка	Возвращает список catalogObjects, который включает все объекты набора требуемых типов (например, все объекты CatalogItem и CatalogTax) в каталоге. ListCatalog не возвращает удаленные элементы каталога.
Количество инвентаризаций в пакетной службе	Возвращает текущие счетчики для предоставленных catalogObjects в запрошенных расположениях.
Обновление группы клиентов	Обновляет группу клиентов.
Обновление клиента	Обновляет профиль клиента. Чтобы изменить атрибут, укажите новое значение. Чтобы удалить атрибут, укажите значение как пустую строку или пустой объект.
Обновление налогов на элементы	Обновляет объекты CatalogTax, которые применяются к целевому каталогуItem, не выполняя upsert во всем элементе.
Обновление платежа	Обновляет платеж с состоянием APPROVED. Вы можете обновить amount_money и tip_money с помощью этой конечной точки.
Обновление подписки	Обновляет подписку. Можно задать, изменить и очистить значения полей подписки.
Обновление списков модификаторов элементов	Обновляет объекты CatalogModifierList, которые применяются к целевому CatalogItem, не выполняя upsert во всем элементе.
Обновление счета	Обновляет счет, изменяя поля, очищая поля или оба.
Объект каталога Upsert	Создает или обновляет целевой catalogObject.
Объекты каталога пакетного удаления	Удаляет набор catalogItems на основе предоставленного списка целевых идентификаторов и возвращает набор успешно удаленных идентификаторов в ответе.
Объекты каталога пакетной службы upsert	Создает или обновляет до 10 000 целевых объектов на основе предоставленного списка объектов. Целевые объекты группируются в пакеты, и каждый пакет вставляется или обновляется без изменений. Если объект в пакете неправильно сформирован или нарушает ограничение базы данных, весь пакет, содержащий этот элемент, будет игнорироваться. Однако другие пакеты в том же запросе по-прежнему могут завершиться успешно. Каждый пакет может содержать до 1000 объектов, и пакеты будут обрабатываться в порядке, если общее количество объектов для запроса (элементы, варианты, списки модификаторов, скидки и налоги) не более 10 000.
Объекты каталога пакетной службы извлечения	Возвращает набор объектов на основе предоставленного идентификатора. Каждый CatalogItem, возвращаемый в наборе, включает все дочерние сведения, включая все его объекты CatalogItemVariation, ссылки на объекты CatalogModifierList и идентификаторы всех объектов CatalogTax, применяемых к нему.
Отключение карточки	Отключает карту, предотвращая дальнейшие обновления или расходы. Отключение уже отключенной карточки разрешено, но не влияет.
Отмена возврата терминала	Отменяет запрос на возврат средств в терминале Interac по идентификатору запроса на возврат, если он разрешает его состояние.
Отмена выхода терминала	Отменяет запрос на получение терминала, если состояние запроса разрешает его.
Отмена оплаты	Отменяет (voids) платеж. Эту конечную точку можно использовать для отмены оплаты с состоянием APPROVED.
Отмена оплаты по ключу idempotency	Отменяет (voids) платеж, определенный ключом идемпотентности, указанным в запросе. Используйте этот метод, если состояние запроса CreatePayment неизвестно (например, после отправки запроса CreatePayment возникает сетевая ошибка, и вы не получите ответ). В этом случае можно направить квадрат, чтобы отменить оплату с помощью этой конечной точки. В запросе укажите тот же ключ идемпотентности, который вы указали в запросе CreatePayment, который требуется отменить. После отмены оплаты вы можете снова отправить запрос CreatePayment. Обратите внимание, что если платеж с указанным ключом идемпотентности не найден, действие не выполняется, а конечная точка успешно возвращается.
Отмена подписки	Задает поле canceled_date до конца активного периода выставления счетов. После этой даты состояние изменяется с ACTIVE на CANCELED.
Отмена счета	Отменяет счет. Продавец не может собирать платежи за отмененный счет.
Отправка доказательств	Отправляет доказательства банку держателя карт. Перед отправкой доказательств квадрат компилирует все доступные доказательства. К ним относятся доказательства, отправленные с помощью конечных точек CreateDisputeEvidenceFile и CreateDisputeEvidenceText, которые автоматически предоставляются квадратом, когда они доступны.
Пакетная служба извлекает изменения инвентаризации	Возвращает исторические физические счетчики и корректировки на основе предоставленных критериев фильтра.
Перечисление возмещения платежей	Извлекает список возвратов для учетной записи, выполняя запрос. Результаты в конечном итоге согласованы, и новые возвраты или изменения в возврате могут занять несколько секунд.
Перечисление групп клиентов	Извлекает список групп клиентов бизнеса.
Перечисление доказательств спора	Возвращает список доказательств, связанных с спором.
Перечисление клиентов	Список профилей клиентов, связанных с учетной записью Square. В обычных условиях эксплуатации только что созданные или обновленные профили клиентов становятся доступными для операции перечисления в течение 30 секунд. Иногда распространение новых или обновленных профилей может занять около одной минуты или дольше, особенно во время сетевых инцидентов и сбоев.
Перечисление платежей	Извлекает список платежей, принятых учетной записью, выполняя запрос. Результаты в конечном итоге согласованы, а новые платежи или изменения платежей могут занять несколько секунд.
Перечисление споров	Возвращает список споров, связанных с определенной учетной записью.
Перечисление счетов	Возвращает список счетов для заданного расположения.
Платеж по возврату средств	Возвращает платеж. Вы можете вернуть всю сумму оплаты или часть ее. Эту конечную точку можно использовать для возврата оплаты карты или записи возврата денежных средств или внешней оплаты.
Поиск клиентов	Выполняет поиск профилей клиентов, связанных с учетной записью Square, с помощью поддерживаемого фильтра запросов. Вызов SearchCustomers без явного фильтра запросов возвращает все профили клиентов, упорядоченные в алфавитном порядке на основе given_name и family_name.
Поиск объектов каталога	Ищет CatalogObject любого типа путем сопоставления поддерживаемых значений атрибутов поиска, исключая пользовательские значения атрибутов для элементов или вариантов элементов, в отношении одного или нескольких указанных фильтров запросов.
Поиск по извлечению терминалов	Извлекает отфильтрованный список запросов на извлечение терминала, созданных учетной записью, выполняя запрос.
Поиск по подпискам	Выполняет поиск подписок. Результаты упорядочиваются в хронологическом порядке по дате создания подписки. Если запрос задает несколько идентификаторов расположения, конечная точка упорядочивает результат по идентификатору расположения, а затем по дате создания в каждом расположении. Если в запросе нет расположений, выполняется поиск всех расположений.
Поиск счетов	Выполняет поиск счетов из расположения, указанного в фильтре.
Получение возврата платежей	Извлекает конкретный возврат с помощью refund_id.
Получение возврата терминала	Извлекает объект возврата терминала Interac по идентификатору.
Получение группы клиентов	Извлекает определенную группу клиентов.
Получение доказательств спора	Возвращает метаданные доказательства, указанные идентификатором доказательства в пути URL-адреса запроса. Если вы хотите ссылаться на него позже, необходимо сохранить копию отправленных доказательств. После отправки не удается скачать доказательства.
Получение заказа	Извлекает заказ по идентификатору.
Получение извлечений терминала	Извлекает запрос на извлечение терминала по checkout_id.
Получение карточки	Извлекает сведения для конкретной карточки.
Получение клиента	Возвращает сведения для одного клиента.
Получение корректировки инвентаризации	Возвращает объект InventoryAdjustment с предоставленным adjustment_id.
Получение объекта каталога	Возвращает один catalogItem в качестве каталогаObject на основе предоставленного идентификатора. Возвращаемый объект включает все соответствующие сведения CatalogItem, включая дочерние элементы CatalogItemVariation, ссылки на объекты CatalogModifierList и идентификаторы всех объектов CatalogTax, применяемых к нему.
Получение оплаты	Извлекает сведения о конкретном платеже.
Получение передачи инвентаризации (бета-версия)	Возвращает объект InventoryTransfer с предоставленным transfer_id.
Получение подписки	Извлекает подписку.
Получение сегмента клиента	Извлекает определенный сегмент клиента.
Получение спора	Возвращает сведения о конкретном споре.
Получение счета	Извлекает счет по идентификатору счета.
Получение счетчика инвентаризации	Извлекает текущее вычисляемое количество акций для заданного каталогаObject в заданном наборе расположений.
Получение физического количества инвентаризаций	Возвращает объект InventoryPhysicalCount с предоставленным physical_count_id.
Порядок клонирования (бета-версия)	Создает новый порядок в состоянии DRAFT путем дедупликации существующего заказа. Только что созданный заказ содержит только основные поля (например, элементы строки, налоги и скидки), скопированные из исходного заказа.
Порядок обновления (бета-версия)	Обновляет открытый заказ, добавляя, заменяя или удаляя поля. Не удается обновить заказы с состоянием COMPLETED или CANCELED.
Принятие спора	Принимает потерю в споре. Квадрат возвращает спорную сумму владельцу карт и обновляет состояние спора на ACCEPTED. Квадратный дебетирует спорную сумму от счета квадрата продавца. Если у квадратного счета нет достаточных средств, квадратный дебетовает связанный банковский счет.
Публикация счета	Публикует указанный черновик счета. После публикации счета Квадрат следует на основе конфигурации счета. Например, Square отправляет счет по адресу электронной почты клиента, взимает плату за карточку клиента в файле или ничего не делает. Квадрат также предоставляет счет на странице счета с квадратным размещением.
Регистрация домена для Apple Pay	Активирует домен для использования с Apple Pay в Интернете и квадрате. Проверка выполняется в этом домене Apple, чтобы убедиться, что она правильно настроена в качестве домена с поддержкой Apple Pay.
Сведения о каталоге	Извлекает сведения об API квадратных каталогов, таких как ограничения размера пакета, которые можно использовать конечной точкой BatchUpsertCatalogObjects.
Создание возврата терминала	Создает запрос на возврат платежа Interac, завершенного на квадратном терминале.
Создание группы клиентов	Создает новую группу клиентов для бизнеса.
Создание заказа	Создает новый заказ, который может включать сведения о продуктах для покупки и параметров для применения к покупке.
Создание извлечений терминала	Создает запрос на получение терминала и отправляет его на указанное устройство, чтобы принять платеж за запрошенную сумму.
Создание карточки	Добавляет карточку в файл к существующему продавцу.
Создание клиента	Создает нового клиента для бизнеса.
Создание оплаты	Создает платеж с помощью предоставленного источника. Эту конечную точку можно использовать для оплаты карты (кредитной или дебетовой карты или квадратной подарочной карты) или записи платежа, полученного продавцом за пределами Квадрата (наличные платежи от покупателя или оплаты, обрабатываемой внешней сущностью от имени продавца).
Создание подписки	Создает подписку для клиента в план подписки. Если вы предоставляете карточку по файлу в запросе, Квадратный взимает плату за подписку. В противном случае квадратные счета выставляются по адресу электронной почты клиента. Подписка начинается немедленно, если запрос не включает необязательный start_date. Каждая отдельная подписка связана с определенным расположением.
Создание счета	Создает черновик счета для заказа, созданного с помощью API заказов. Черновик счета остается в вашей учетной записи, и никаких действий не выполняется. Вы должны опубликовать счет, прежде чем квадрат может обработать его (отправить его по адресу электронной почты клиента или оплатить карточку клиента в файле).
Создание текста доказательства спора	Отправляет текст, используемый в качестве доказательства для вызова спора.
Список карточек	Извлекает список карт, принадлежащих учетной записи, выполняя запрос.
Удаление группы из клиента	Удаляет членство в группе от клиента. Клиент определяется значением customer_id, а группа клиентов определяется значением group_id.
Удаление группы клиентов	Удаляет группу клиентов, определяемую значением group_id.
Удаление доказательств спора	Удаляет указанные доказательства из спора.
Удаление клиента	Удаляет профиль клиента из бизнеса. Эта операция также отменяет связь с любыми связанными карточками в файле.
Удаление объекта каталога	Удаляет один catalogObject на основе предоставленного идентификатора и возвращает набор успешно удаленных идентификаторов в ответе. Удаление является каскадным событием, таким образом, что все дочерние элементы целевого объекта также удаляются. Например, удаление catalogItem также приведет к удалению всех дочерних элементов CatalogItemVariation.
Удаление счета	Удаляет указанный счет. При удалении счета соответствующее состояние заказа изменяется на CANCELED. Вы можете удалить только черновик счета (вы не можете удалить опубликованный счет, включая счет, запланированный для обработки).

Возврат средств в терминале поиска

Идентификатор операции:

TerminalSearchRefunds

Извлекает отфильтрованный список запросов на возмещение средств в терминале Interac, созданных продавцом, выполняющего запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов, возвращаемых на одной странице. Ограничение — это рекомендации. Реализация может возвращать более или меньше результатов. Если указанное ограничение отрицательно, ноль или выше максимального предела 1000, оно будет игнорироваться.
Состояние	status		string	Текущее состояние.

Возвращаемое значение

Имя	Путь	Тип	Описание
Возврат	refunds	array of object
Идентификатор	refunds.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор возврата	refunds.refund_id	string	Уникальный идентификатор для этого возврата, созданный квадратом.
Идентификатор оплаты	refunds.payment_id	string	Идентификатор платежа.
Сумма	refunds.amount_money.amount	integer	Сумма.
Валюта	refunds.amount_money.currency	string	Валюта.
Причина	refunds.reason	string	Причина спора, по которой держатель карт инициировал спор с их банком.
Идентификатор устройства	refunds.device_id	string	Уникальный идентификатор устройства, использующее этот код. Заполняется при паре устройства.
Срок действия	refunds.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Состояние	refunds.status	string	Текущее состояние проверки этого объекта.
Создано в	refunds.created_at	string	Время события в формате ISO 8601.
Обновлено в	refunds.updated_at	string	Метка времени последнего изменения в формате RFC 3339
ИД приложения	refunds.app_id	string	Идентификатор приложения, создавшего выход.
Бренд карточки	refunds.card.card_brand	string	Бренд карты.
Последние 4	refunds.card.last_4	string	Последние 4 цифры номера карточки.
Срок действия месяца	refunds.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Срок действия года	refunds.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	refunds.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	refunds.card.card_type	string	Тип карточки.
БУНКЕР	refunds.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Идентификатор заказа	refunds.order_id	string	Идентификатор заказа.
Идентификатор расположения	refunds.location_id	string	Идентификатор расположения.

Возобновление подписки

Идентификатор операции:

SubscriptionResume

Возобновляет деактивированную подписку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscription_id	True	string	Идентификатор подписки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	subscription.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscription.location_id	string	Идентификатор расположения.
Идентификатор плана	subscription.plan_id	string	Идентификатор связанного плана подписки.
Идентификатор клиента	subscription.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Состояние	subscription.status	string	Текущее состояние проверки этого объекта.
Сумма	subscription.price_override_money.amount	integer	Сумма.
Валюта	subscription.price_override_money.currency	string	Валюта.
Версия	subscription.version	integer	Текущая версия этого объекта.
Создано в	subscription.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Timezone	subscription.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscription.source.name	string	Имя.

Вывод списка сегментов клиентов

Идентификатор операции:

CustomerSegmentList

Извлекает список сегментов клиентов бизнеса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Лимит	limit		integer	Верхний предел числа, возвращаемого в ответе.

Возвращаемое значение

Имя	Путь	Тип	Описание
Сегменты	segments	array of object
Идентификатор	segments.id	string	Уникальный идентификатор, выданный квадратом.
Имя	segments.name	string	Имя объекта.
Создано в	segments.created_at	string	Время события в формате ISO 8601.
Обновлено в	segments.updated_at	string	Метка времени последнего изменения в формате RFC 3339

Вывод списка событий подписки

Идентификатор операции:

SubscriptionListEvents

Выводит список всех событий для определенной подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscription_id	True	string	Идентификатор подписки.

Возвращаемое значение

Имя	Путь	Тип	Описание
События подписки	subscription_events	array of object
Идентификатор	subscription_events.id	string	Уникальный идентификатор, выданный квадратом.
Тип события подписки	subscription_events.subscription_event_type	string	Тип события подписки.
Дата вступления в силу	subscription_events.effective_date	string	Дата, в формате YYY-MM-DD, когда событие подписки вступило в силу.
Идентификатор плана	subscription_events.plan_id	string	Идентификатор связанного плана подписки

Вычисление порядка (бета-версия)

Идентификатор операции:

OrderCalculate

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор расположения	location_id		string	Идентификатор расположения.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент	percentage		string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Scope	scope		string	Указывает текущий уровень.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Количество	quantity		string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Элементы строки	order.line_items	array of object
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Сумма	order.line_items.variation_total_price_money.amount	integer	Сумма.
Валюта	order.line_items.variation_total_price_money.currency	string	Валюта.
Примененные скидки	order.line_items.applied_discounts	array of object
ИД пользователя	order.line_items.applied_discounts.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс скидки	order.line_items.applied_discounts.discount_uid	string	Пользовательский интерфейс скидки, представляющей примененную скидку.
Сумма	order.line_items.applied_discounts.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_discounts.applied_money.currency	string	Валюта.
Скидки	order.discounts	array of object
ИД пользователя	order.discounts.uid	string	Идентификатор, созданный квадратом.
Имя	order.discounts.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент	order.discounts.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.discounts.applied_money.amount	integer	Сумма.
Валюта	order.discounts.applied_money.currency	string	Валюта.
Тип	order.discounts.type	string	Указывает тип.
Scope	order.discounts.scope	string	Указывает текущий уровень.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Государство	order.state	string	Текущее состояние.
Версия	order.version	integer	Текущая версия этого объекта.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Сумма	order.total_tip_money.amount	integer	Сумма.
Валюта	order.total_tip_money.currency	string	Валюта.
Сумма	order.total_money.amount	integer	Сумма.
Валюта	order.total_money.currency	string	Валюта.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.tip_money.amount	integer	Сумма.
Валюта	order.net_amounts.tip_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.

Добавление группы в клиент

Идентификатор операции:

CustomerAddGroup

Добавляет членство в группе клиенту. Клиент определяется значением customer_id, а группа клиентов определяется значением group_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор клиента	customer_id	True	string	Идентификатор клиента.
Идентификатор группы	group_id	True	string	Идентификатор группы.

Возвращаемое значение

response

object

Завершение оплаты

Идентификатор операции:

PaymentComplete

Завершает (фиксирует) платеж. По умолчанию платежи устанавливаются сразу после их создания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оплаты	payment_id	True	string	Идентификатор платежа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	payment.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	payment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	payment.amount_money.amount	integer	Сумма.
Валюта	payment.amount_money.currency	string	Валюта.
Состояние	payment.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payment.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу. Эта автоматическая delay_action применяется только к платежам, которые не достигают состояния терминала (COMPLETED, CANCELED или FAILED) до периода времени delay_duration. Это поле указывается в формате RFC 3339.
Тип источника	payment.source_type	string	Исходный тип для этого платежа. Текущие значения включают CARD, BANK_ACCOUNT, WALLET, CASH или EXTERNAL.
Состояние	payment.card_details.status	string	Текущее состояние.
Бренд карточки	payment.card_details.card.card_brand	string	Бренд карты.
Последние 4	payment.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payment.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payment.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payment.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payment.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payment.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payment.card_details.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Метод Entry	payment.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние CVV	payment.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние AVS	payment.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payment.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payment.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payment.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Записано в	payment.card_details.card_payment_timeline.captured_at	string	Метка времени записи платежа в формате RFC 3339.
Идентификатор расположения	payment.location_id	string	Идентификатор расположения.
Идентификатор заказа	payment.order_id	string	Идентификатор заказа.
Плата за обработку	payment.processing_fee	array of object
Действующий в	payment.processing_fee.effective_at	string	Метка времени, когда плата вступает в силу, в формате RFC 3339.
Тип	payment.processing_fee.type	string	Указывает тип.
Сумма	payment.processing_fee.amount_money.amount	integer	Сумма.
Валюта	payment.processing_fee.amount_money.currency	string	Валюта.
Замечание	payment.note	string	Настраиваемая заметка, связанная с профилем клиента.
Сумма	payment.total_money.amount	integer	Сумма.
Валюта	payment.total_money.currency	string	Валюта.
Сумма	payment.approved_money.amount	integer	Сумма.
Валюта	payment.approved_money.currency	string	Валюта.
Идентификатор сотрудника	payment.employee_id	string	Созданный квадратным идентификатором сотрудника.
Номер квитанции	payment.receipt_number	string	Номер квитанции платежа. Поле отсутствует, если платеж отменен.
URL-адрес квитанции	payment.receipt_url	string	URL-адрес квитанции платежа. Поле заполняется только для оплаты COMPLETED.
Действие по задержке	payment.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payment.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Идентификатор участника группы	payment.team_member_id	string	Идентификатор члена команды.
Квадратный продукт	payment.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payment.application_details.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Маркер версии	payment.version_token	string	Этот непрозрачный маркер определяет определенную версию объекта.

Заказ на оплату (бета-версия)

Идентификатор операции:

OrderPay

Оплачивайте заказ с помощью одного или нескольких утвержденных платежей или урегулирует заказ в общей сложности 0. Общее количество payment_ids, перечисленных в запросе, должно быть равно общей сумме заказа. Заказы с общим количеством 0 можно пометить как платные, указав пустой массив payment_ids в запросе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор заказа	order_id	True	string	Идентификатор заказа.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификаторы оплаты	payment_ids		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	order.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Элементы строки	order.line_items	array of object
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Версия	order.version	integer	Текущая версия этого объекта.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Сумма	order.total_money.amount	integer	Сумма.
Валюта	order.total_money.currency	string	Валюта.
Закрыто в	order.closed_at	string	Время закрытия в формате ISO 8601.
Тендеры	order.tenders	array of object
Идентификатор	order.tenders.id	string	Идентификатор объекта
Идентификатор расположения	order.tenders.location_id	string	Идентификатор расположения получателя (кроме торговца), получающего часть этого тендера.
Код проводки	order.tenders.transaction_id	string	Идентификатор связанной транзакции тендера.
Создано в	order.tenders.created_at	string	Метка времени при создании в формате RFC 3339.
Сумма	order.tenders.amount_money.amount	integer	Сумма.
Валюта	order.tenders.amount_money.currency	string	Валюта.
Тип	order.tenders.type	string	Указывает тип.
Состояние	order.tenders.card_details.status	string	Текущее состояние оплаты кредитной карты (например, АВТОРИЗОВАНО или ЗАХВАЧЕНО)
Бренд карточки	order.tenders.card_details.card.card_brand	string	Бренд карты.
last_4	order.tenders.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	order.tenders.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	order.tenders.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	order.tenders.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Метод Entry	order.tenders.card_details.entry_method	string	Метод, используемый для ввода сведений о карточке для транзакции.
Идентификатор оплаты	order.tenders.payment_id	string	Квадратный созданный уникальный идентификатор оплаты.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.tip_money.amount	integer	Сумма.
Валюта	order.net_amounts.tip_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.
Имя	order.source.name	string	Имя.
Государство	order.state	string	Текущее состояние.

Заказы на поиск

Идентификатор операции:

OrderSearch

Выполните поиск всех заказов для одного или нескольких расположений. Заказы включают все продажи, возвраты и обмены независимо от того, как они вошли в экосистему Square (например, точка продажи, счета и интерфейсы API подключения).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Возвращаемые записи	return_entries		boolean	Логическое значение, которое управляет форматом результатов поиска. Если значение true, SearchOrders возвращает объекты OrderEntry. Если значение false, SearchOrders возвращает объекты полного порядка.
Лимит	limit		integer	Ограничение количества результатов, возвращаемых на одной странице. Ограничение — это рекомендации. Реализация может возвращать более или меньше результатов. Если указанное ограничение отрицательно, ноль или выше максимального предела 1000, оно будет игнорироваться.
Идентификаторы расположения	location_ids		array of string
Начать с	start_at		string	Значение даты и времени в формате RFC 3339, указывающее, когда начинается диапазон времени.
Конец в	end_at		string	Значение даты и времени в формате RFC 3339, указывающее, когда заканчивается диапазон времени.
States	states		array of string
Поле сортировки	sort_field		string	Поле для сортировки по.
Порядок сортировки	sort_order		string	Хронологический порядок, в котором возвращаются результаты.

Возвращаемое значение

Имя	Путь	Тип	Описание
Записи заказа	order_entries	array of object
Идентификатор заказа	order_entries.order_id	string	Идентификатор заказа.
Идентификатор расположения	order_entries.location_id	string	Идентификатор расположения.
Версия	order_entries.version	integer	Текущая версия объекта.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Заказы на получение пакетной службы

Идентификатор операции:

OrderBatchRetrieve

Извлекает набор заказов по идентификаторам. Если заданный идентификатор заказа не существует, идентификатор игнорируется вместо создания ошибки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор расположения	location_id		string	Идентификатор расположения.
Идентификаторы заказов	order_ids		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Заказы	orders	array of object
Идентификатор	orders.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	orders.location_id	string	Идентификатор расположения.
Идентификатор ссылки	orders.reference_id	string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Элементы строки	orders.line_items	array of object
ИД пользователя	orders.line_items.uid	string	Идентификатор созданного квадратом запроса на оплату в счете.
Имя	orders.line_items.name	string	Имя, доступное для чтения человеком.
Количество	orders.line_items.quantity	string	Количество приобретено, отформатированное как десятичное число.
Сумма	orders.line_items.base_price_money.amount	integer	Сумма.
Валюта	orders.line_items.base_price_money.currency	string	Валюта.
Сумма	orders.line_items.total_money.amount	integer	Сумма.
Валюта	orders.line_items.total_money.currency	string	Валюта.
Сумма	orders.total_money.amount	integer	Сумма.
Валюта	orders.total_money.currency	string	Валюта.

Инвентаризация пакетных изменений

Идентификатор операции:

InventoryBatchChange

Применяет корректировки и подсчеты к указанным количествам элементов. При успешном выполнении возвращает текущие вычисляемые счетчики для всех объектов, на которые ссылается запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Тип	type		string	Тип этого объекта.
Идентификатор ссылки	reference_id		string	Необязательный идентификатор ссылки, определяемый пользователем, который связывает эту карточку с другой сущностью во внешней системе.
Идентификатор объекта каталога	catalog_object_id		string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Государство	state		string	Текущее состояние инвентаризации для связанного количества элементов.
Идентификатор расположения	location_id		string	Идентификатор расположения получателя (кроме торговца), получающего часть этого тендера.
Количество	quantity		string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Идентификатор сотрудника	employee_id		string	Созданный квадрат идентификатор сотрудника, ответственного за физическое число.
Произошло в	occurred_at		string	Метка времени, созданная клиентом в формате RFC 3339, которая указывает, когда было проверено физическое число. Для обновлений физического количества метка времени occurred_at не может быть старше 24 часов или в будущем относительно времени запроса.
Игнорировать неизменяемые счетчики	ignore_unchanged_counts		boolean	Указывает, следует ли игнорировать текущее физическое число, если количество не изменяется с момента последнего физического числа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Рассчитывает	counts	array of object
Идентификатор объекта каталога	counts.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	counts.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Государство	counts.state	string	Текущее состояние.
Идентификатор расположения	counts.location_id	string	Идентификатор расположения.
Количество	counts.quantity	string	Количество элементов, затронутых предполагаемым числом в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Вычисляется по адресу	counts.calculated_at	string	Метка времени в формате RFC 3339, указывающая, когда получено последнее физическое число или корректировка, влияющая на предполагаемое число.

Каталог списка

Идентификатор операции:

CatalogList

Возвращает список catalogObjects, который включает все объекты набора требуемых типов (например, все объекты CatalogItem и CatalogTax) в каталоге. ListCatalog не возвращает удаленные элементы каталога.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		integer	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Типы	types		string	Необязательный регистр без учета регистра, разделенный запятыми список типов объектов для извлечения. Допустимые значения определяются в перечислении CatalogObjectType, включая ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST или IMAGE. Если это не указано, операция возвращает объекты всех типов в версии API Square, используемой для выполнения запроса.

Возвращаемое значение

Имя	Путь	Тип	Описание
Объекты	objects	array of object
Тип	objects.type	string	Тип этого объекта.
Идентификатор	objects.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	objects.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.version	integer	Текущая версия объекта.
Удаляется	objects.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	objects.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	objects.category_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Имя	objects.tax_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Этап вычисления	objects.tax_data.calculation_phase	string	Вычисляется ли налог на основе промежуточных или общих сумм выплат.
Тип включения	objects.tax_data.inclusion_type	string	Независимо от того, является ли налог АДДИТИВным или ИНКЛЮЗИВНО.
Процент	objects.tax_data.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Включен	objects.tax_data.enabled	boolean	Указывает, можно ли использовать объект.

Количество инвентаризаций в пакетной службе

Идентификатор операции:

InventoryBatchRetrieveCounts

Возвращает текущие счетчики для предоставленных catalogObjects в запрошенных расположениях.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы объектов каталога	catalog_object_ids		array of string
Идентификаторы расположения	location_ids		array of string
Обновлено после	updated_after		string	Фильтр, возвращающий результаты со значением calculated_at после заданного времени, указанного в метке времени RFC 3339.

Возвращаемое значение

Имя	Путь	Тип	Описание
Рассчитывает	counts	array of object
Идентификатор объекта каталога	counts.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	counts.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Государство	counts.state	string	Текущее состояние.
Идентификатор расположения	counts.location_id	string	Идентификатор расположения.
Количество	counts.quantity	string	Количество элементов, затронутых предполагаемым числом в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Вычисляется по адресу	counts.calculated_at	string	Метка времени в формате RFC 3339, указывающая, когда получено последнее физическое число или корректировка, влияющая на предполагаемое число.

Обновление группы клиентов

Идентификатор операции:

CustomerGroupUpdate

Обновляет группу клиентов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	group_id	True	string	Идентификатор группы.
Имя	name		string	Имя объекта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	group.id	string	Уникальный идентификатор, выданный квадратом.
Имя	group.name	string	Имя объекта.
Создано в	group.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	group.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.

Обновление клиента

Идентификатор операции:

CustomerUpdate

Обновляет профиль клиента. Чтобы изменить атрибут, укажите новое значение. Чтобы удалить атрибут, укажите значение как пустую строку или пустой объект.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор клиента	customer_id	True	string	Идентификатор клиента.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	customer.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	customer.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	customer.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Заданное имя	customer.given_name	string	Указанное имя (т. е. имя, связанное с профилем клиента).
Фамилия	customer.family_name	string	Семейство (т. е. фамилия), связанное с профилем клиента.
Электронная почта	customer.email_address	string	Адрес электронной почты, связанный с профилем клиента.
Адресная строка 1	customer.address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	customer.address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	customer.address.locality	string	Город или город адреса.
Административный район 1	customer.address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	customer.address.postal_code	string	Почтовый индекс адреса.
Страна	customer.address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Идентификатор ссылки	customer.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Замечание	customer.note	string	Настраиваемая заметка, связанная с профилем клиента.
Отмена подписки по электронной почте	customer.preferences.email_unsubscribed	boolean	Указывает, отменяет ли клиент подписку на сообщения электронной почты маркетинговой кампании. Значение true означает, что клиент решил отказаться от маркетинга электронной почты от текущего продавца Квадрата или от всех продавцов Квадрата.
Источник создания	customer.creation_source	string	Источник создания представляет метод, используемый для создания профиля клиента.
Версия	customer.version	integer	Текущая версия этого объекта.

Обновление налогов на элементы

Идентификатор операции:

CatalogUpdateTaxes

Обновляет объекты CatalogTax, которые применяются к целевому каталогуItem, не выполняя upsert во всем элементе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы элементов	item_ids		array of string
Налоги для включения	taxes_to_enable		array of string
Налоги для отключения	taxes_to_disable		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Обновлено в	updated_at	string	Метка времени базы данных этого обновления в формате RFC 3339.

Обновление платежа

Идентификатор операции:

PaymentUpdate

Обновляет платеж с состоянием APPROVED. Вы можете обновить amount_money и tip_money с помощью этой конечной точки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оплаты	payment_id	True	string	Идентификатор платежа.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Маркер версии	version_token		string	Этот непрозрачный маркер определяет определенную версию объекта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	payment.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	payment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	payment.amount_money.amount	integer	Сумма.
Валюта	payment.amount_money.currency	string	Валюта.
Сумма	payment.tip_money.amount	integer	Сумма.
Валюта	payment.tip_money.currency	string	Валюта.
Состояние	payment.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payment.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу. Эта автоматическая delay_action применяется только к платежам, которые не достигают состояния терминала (COMPLETED, CANCELED или FAILED) до периода времени delay_duration. Это поле указывается в формате RFC 3339.
Тип источника	payment.source_type	string	Исходный тип для этого платежа. Текущие значения включают CARD, BANK_ACCOUNT, WALLET, CASH или EXTERNAL.
Состояние	payment.card_details.status	string	Текущее состояние.
Бренд карточки	payment.card_details.card.card_brand	string	Бренд карты.
Последние 4	payment.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payment.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payment.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payment.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payment.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payment.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payment.card_details.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Метод Entry	payment.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние CVV	payment.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние AVS	payment.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payment.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payment.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payment.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Идентификатор расположения	payment.location_id	string	Идентификатор расположения.
Идентификатор заказа	payment.order_id	string	Идентификатор заказа.
Создано в	payment.risk_evaluation.created_at	string	Метка времени при создании в формате RFC 3339.
Уровень риска	payment.risk_evaluation.risk_level	string	Уровень риска, связанный с оплатой.
Замечание	payment.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор клиента	payment.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Сумма	payment.total_money.amount	integer	Сумма.
Валюта	payment.total_money.currency	string	Валюта.
Сумма	payment.approved_money.amount	integer	Сумма.
Валюта	payment.approved_money.currency	string	Валюта.
Capabilities	payment.capabilities	array of string
Номер квитанции	payment.receipt_number	string	Номер квитанции платежа. Поле отсутствует, если платеж отменен.
Действие по задержке	payment.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payment.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Квадратный продукт	payment.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payment.application_details.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Маркер версии	payment.version_token	string	Этот непрозрачный маркер определяет определенную версию объекта.

Обновление подписки

Идентификатор операции:

SubscriptionUpdate

Обновляет подписку. Можно задать, изменить и очистить значения полей подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscription_id	True	string	Идентификатор подписки.
Версия	version		integer	Текущая версия этого объекта.
Процент налогов	tax_percentage		string	Сумма налога, применяемая при выставлении счетов подписки.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	subscription.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscription.location_id	string	Идентификатор расположения.
Идентификатор плана	subscription.plan_id	string	Идентификатор связанного плана подписки.
Идентификатор клиента	subscription.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Состояние	subscription.status	string	Текущее состояние проверки этого объекта.
Сумма	subscription.price_override_money.amount	integer	Сумма.
Валюта	subscription.price_override_money.currency	string	Валюта.
Версия	subscription.version	integer	Текущая версия этого объекта.
Создано в	subscription.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Timezone	subscription.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscription.source.name	string	Имя.

Обновление списков модификаторов элементов

Идентификатор операции:

CatalogUpdateModifier

Обновляет объекты CatalogModifierList, которые применяются к целевому CatalogItem, не выполняя upsert во всем элементе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы элементов	item_ids		array of string
Списки модификаторов для включения	modifier_lists_to_enable		array of string
Списки модификаторов для отключения	modifier_lists_to_disable		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Обновлено в	updated_at	string	Метка времени базы данных этого обновления в формате RFC 3339.

Обновление счета

Идентификатор операции:

InvoiceUpdate

Обновляет счет, изменяя поля, очищая поля или оба.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер счета	invoice_id	True	string	Идентификатор счета.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
ИД пользователя	uid		string	Идентификатор, созданный квадратом.
Советы включено	tipping_enabled		boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Поля для очистки	fields_to_clear		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	invoice.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoice.version	integer	Текущая версия этого объекта.
Идентификатор расположения	invoice.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoice.order_id	string	Идентификатор заказа.
Запросы на оплату	invoice.payment_requests	array of object
ИД пользователя	invoice.payment_requests.uid	string	Идентификатор, созданный квадратом.
Тип запроса	invoice.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoice.payment_requests.due_date	string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	invoice.payment_requests.tipping_enabled	boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Сумма	invoice.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoice.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoice.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Номер счета	invoice.invoice_number	string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	invoice.title	string	Заголовок.
Description	invoice.description	string	Описание.
Запланированное в	invoice.scheduled_at	string	Метка времени при планировании обработки в формате RFC 3339.
Состояние	invoice.status	string	Текущее состояние проверки этого объекта.
Timezone	invoice.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoice.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	invoice.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор клиента	invoice.primary_recipient.customer_id	string	Идентификатор клиента, связанного с заказом.
Заданное имя	invoice.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoice.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoice.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoice.primary_recipient.phone_number	string	Номер телефона получателя.
Сумма	invoice.next_payment_amount_money.amount	integer	Сумма.
Валюта	invoice.next_payment_amount_money.currency	string	Валюта.
Card	invoice.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoice.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoice.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoice.custom_fields	array of object
Этикетка	invoice.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoice.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoice.custom_fields.placement	string	Расположение настраиваемого поля в счете.
Метод доставки	invoice.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Дата продажи или обслуживания	invoice.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Объект каталога Upsert

Идентификатор операции:

CatalogUpsert

Создает или обновляет целевой catalogObject.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор	id		string	Уникальный идентификатор, выданный квадратом.
Тип	type		string	Тип этого объекта.
Abbreviation	abbreviation		string	Текст отображаемой метки элемента в приложении Square Point of Sale. Используются только первые пять символов строки. Этот атрибут доступен для поиска, и его длина значения имеет кодовые точки Юникода.
Description	title		string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Имя	name		string	Имя.
Идентификатор	id		string	Идентификатор для ссылки на этот объект в каталоге.
Тип	type		string	Тип этого объекта.
Идентификатор элемента	item_id		string	Идентификатор каталогаItem, связанный с этим вариантом элемента.
Имя	name		string	Имя варианта элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Тип ценообразования	pricing_type		string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Тип	catalog_object.type	string	Тип этого объекта.
Идентификатор	catalog_object.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	catalog_object.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Версия	catalog_object.version	integer	Текущая версия этого объекта.
Удаляется	catalog_object.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	catalog_object.item_data.name	string	Имя.
Description	catalog_object.item_data.title	string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Abbreviation	catalog_object.item_data.abbreviation	string	Текст отображаемой метки элемента в приложении Square Point of Sale. Используются только первые пять символов строки. Этот атрибут доступен для поиска, и его длина значения имеет кодовые точки Юникода.
Варианты	catalog_object.item_data.variations	array of object
Тип	catalog_object.item_data.variations.type	string	Тип этого объекта.
Идентификатор	catalog_object.item_data.variations.id	string	Идентификатор для ссылки на этот объект в каталоге.
Обновлено в	catalog_object.item_data.variations.updated_at	string	Метка времени последнего изменения в формате RFC 3339.
Версия	catalog_object.item_data.variations.version	integer	Версия объекта. При обновлении объекта указанная версия должна соответствовать версии в базе данных, в противном случае запись будет отклонена как конфликтующая.
Удаляется	catalog_object.item_data.variations.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	catalog_object.item_data.variations.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Идентификатор элемента	catalog_object.item_data.variations.item_variation_data.item_id	string	Идентификатор каталогаItem, связанный с этим вариантом элемента.
Имя	catalog_object.item_data.variations.item_variation_data.name	string	Имя варианта элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Порядковый	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Порядок отображения вариантов этого элемента. Это значение доступно только для чтения. При записи порядковый номер для каждого варианта элемента в родительском CatalogItem устанавливается в соответствии с положением вариантов элемента. При чтении значение не гарантируется последовательным или уникальным.
Тип ценообразования	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Запасной	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Учитывается ли акции непосредственно на этом варианте (TRUE) или только на его компонентах (FALSE). Для обратной совместимости отсутствующие значения будут интерпретированы как TRUE.
Сумма	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Сумма.
Валюта	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	Валюта.
Тип продукта	catalog_object.item_data.product_type	string	Тип продукта элемента. Может не изменяться после создания элемента.
Сопоставления идентификаторов	id_mappings	array of object
Идентификатор объекта клиента	id_mappings.client_object_id	string	Предоставленный клиентом временный идентификатор #-prefixed для нового каталогаObject.
Код объекта	id_mappings.object_id	string	Постоянный идентификатор, созданный сервером.

Объекты каталога пакетного удаления

Идентификатор операции:

CatalogBatchDelete

Удаляет набор catalogItems на основе предоставленного списка целевых идентификаторов и возвращает набор успешно удаленных идентификаторов в ответе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы объектов	object_ids		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификаторы удаленных объектов	deleted_object_ids	array of string
Удалено в	deleted_at	string	Метка времени удаления базы данных в формате RFC 3339

Объекты каталога пакетной службы upsert

Идентификатор операции:

CatalogBatchUpsert

Создает или обновляет до 10 000 целевых объектов на основе предоставленного списка объектов. Целевые объекты группируются в пакеты, и каждый пакет вставляется или обновляется без изменений. Если объект в пакете неправильно сформирован или нарушает ограничение базы данных, весь пакет, содержащий этот элемент, будет игнорироваться. Однако другие пакеты в том же запросе по-прежнему могут завершиться успешно. Каждый пакет может содержать до 1000 объектов, и пакеты будут обрабатываться в порядке, если общее количество объектов для запроса (элементы, варианты, списки модификаторов, скидки и налоги) не более 10 000.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Тип	type		string	Тип этого объекта.
Идентификатор	id		string	Идентификатор для ссылки на этот объект.
Присутствует во всех расположениях	present_at_all_locations		boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Description	title		string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Идентификатор категории	category_id		string	Идентификатор категории элемента, если он есть.
Идентификаторы налогоплательщика	tax_ids		array of string
Тип	type		string	Тип этого объекта. Каждый тип объекта имеет ожидаемые свойства, выраженные в структурированном формате в соответствующем поле *_data ниже.
Идентификатор	id		string	Идентификатор для ссылки на этот объект.
Присутствует во всех местах	present_at_all_locations		boolean	Присутствует ли во всех местах.
Идентификатор элемента	item_id		string	Идентификатор элемента.
Имя	name		string	Наименование номенклатуры.
Тип ценообразования	pricing_type		string	Тип ценообразования.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Этап вычисления	calculation_phase		string	Вычисляется ли налог на основе промежуточных или общих сумм выплат.
Тип включения	inclusion_type		string	Независимо от того, является ли налог АДДИТИВным или ИНКЛЮЗИВНО.
Процент	percentage		string	Процент налога в десятичной форме, используя "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Применимо к пользовательским суммам	applies_to_custom_amounts		boolean	Если значение true, плата применяется к пользовательским суммам, введенным в приложение Square Point of Sale, которое не связано с определенным catalogItem.
Включен	enabled		boolean	Логический флаг, указывающий, отображается ли налог как включенный (true) в приложении Square Point of Sale или нет (false).

Возвращаемое значение

Имя	Путь	Тип	Описание
Объекты	objects	array of object
Тип	objects.type	string	Тип этого объекта.
Идентификатор	objects.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	objects.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.version	integer	Текущая версия объекта.
Удаляется	objects.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	objects.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	objects.item_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Description	objects.item_data.title	string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Идентификатор категории	objects.item_data.category_id	string	Идентификатор категории элемента, если он есть.
Идентификаторы налогоплательщика	objects.item_data.tax_ids	array of string
Варианты	objects.item_data.variations	array of object
Тип	objects.item_data.variations.type	string	Тип этого объекта. Каждый тип объекта имеет ожидаемые свойства, выраженные в структурированном формате в соответствующем поле *_data ниже.
Идентификатор	objects.item_data.variations.id	string	Идентификатор для ссылки на этот объект.
Обновлено в	objects.item_data.variations.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.item_data.variations.version	integer	Версия объекта. При обновлении объекта указанная версия должна соответствовать версии в базе данных, в противном случае запись будет отклонена как конфликтующая.
Удаляется	objects.item_data.variations.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех местах	objects.item_data.variations.present_at_all_locations	boolean	Список расположений, в которых присутствует объект, даже если present_at_all_locations имеет значение false. Это может включать расположения, которые деактивированы.
Идентификатор элемента	objects.item_data.variations.item_variation_data.item_id	string	Идентификатор объекта с этим вариантом элемента.
Имя	objects.item_data.variations.item_variation_data.name	string	Имя этого элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Порядковый	objects.item_data.variations.item_variation_data.ordinal	integer	Порядок отображения вариантов этого элемента. Это значение доступно только для чтения.
Тип ценообразования	objects.item_data.variations.item_variation_data.pricing_type	string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Сумма	objects.item_data.variations.item_variation_data.price_money.amount	integer	Сумма денег, в наименьшем конфисовке валюты, указанной валютой. Например, если валюта — USD, сумма находится в центах. Денежные суммы могут быть положительными или отрицательными. Ознакомьтесь с описанием конкретного поля, чтобы определить смысл входа в конкретном случае.
Валюта	objects.item_data.variations.item_variation_data.price_money.currency	string	Тип валюты в формате ISO 4217. Например, код валюты для долларов США составляет USD.
Имя	objects.category_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Имя	objects.tax_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Этап вычисления	objects.tax_data.calculation_phase	string	Вычисляется ли налог на основе промежуточных или общих сумм выплат.
Тип включения	objects.tax_data.inclusion_type	string	Независимо от того, является ли налог АДДИТИВным или ИНКЛЮЗИВНО.
Процент	objects.tax_data.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Применяется к пользовательским суммам	objects.tax_data.applies_to_custom_amounts	boolean	Если значение true, плата применяется к пользовательским суммам, введенным в приложение Square Point of Sale, которое не связано с определенным catalogItem.
Включен	objects.tax_data.enabled	boolean	Указывает, можно ли использовать объект.
Сопоставления идентификаторов	id_mappings	array of object
Идентификатор объекта клиента	id_mappings.client_object_id	string	Предоставленный клиентом временный идентификатор #-prefixed для нового каталогаObject.
Код объекта	id_mappings.object_id	string	Постоянный идентификатор, созданный сервером.

Объекты каталога пакетной службы извлечения

Идентификатор операции:

CatalogBatchRetrieve

Возвращает набор объектов на основе предоставленного идентификатора. Каждый CatalogItem, возвращаемый в наборе, включает все дочерние сведения, включая все его объекты CatalogItemVariation, ссылки на объекты CatalogModifierList и идентификаторы всех объектов CatalogTax, применяемых к нему.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы объектов	object_ids		array of string
Версия каталога	catalog_version		integer	Конкретная версия объектов каталога, включаемая в ответ. Это позволяет получить исторические версии объектов. Указанное значение версии соответствует атрибуту версии CatalogObjects.
Включение связанных объектов	include_related_objects		boolean	Если значение true, ответ будет содержать дополнительные объекты, связанные с запрошенными объектами, как показано ниже. Если поле объектов ответа содержит CatalogItem, связанные объекты CatalogCategory, объекты CatalogTax, объекты CatalogImage и CatalogModifierLists будут возвращены в поле related_objects ответа. Если поле объектов ответа содержит CatalogItemVariation, его родительский CatalogItem будет возвращен в поле related_objects ответа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Объекты	objects	array of object
Тип	objects.type	string	Тип этого объекта.
Идентификатор	objects.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	objects.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.version	integer	Текущая версия объекта.
Удаляется	objects.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	objects.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	objects.item_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Description	objects.item_data.title	string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Идентификатор категории	objects.item_data.category_id	string	Идентификатор категории элемента, если он есть.
Идентификаторы налогоплательщика	objects.item_data.tax_ids	array of string
Варианты	objects.item_data.variations	array of object
Тип	objects.item_data.variations.type	string	Тип этого объекта. Каждый тип объекта имеет ожидаемые свойства, выраженные в структурированном формате в соответствующем поле *_data ниже.
Идентификатор	objects.item_data.variations.id	string	Идентификатор для ссылки на этот объект.
Обновлено в	objects.item_data.variations.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.item_data.variations.version	integer	Версия объекта. При обновлении объекта указанная версия должна соответствовать версии в базе данных, в противном случае запись будет отклонена как конфликтующая.
Удаляется	objects.item_data.variations.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех местах	objects.item_data.variations.present_at_all_locations	boolean	Список расположений, в которых присутствует объект, даже если present_at_all_locations имеет значение false. Это может включать расположения, которые деактивированы.
Идентификатор элемента	objects.item_data.variations.item_variation_data.item_id	string	Идентификатор объекта с этим вариантом элемента.
Имя	objects.item_data.variations.item_variation_data.name	string	Имя этого элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Порядковый	objects.item_data.variations.item_variation_data.ordinal	integer	Порядок отображения вариантов этого элемента. Это значение доступно только для чтения.
Тип ценообразования	objects.item_data.variations.item_variation_data.pricing_type	string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Сумма	objects.item_data.variations.item_variation_data.price_money.amount	integer	Сумма денег, в наименьшем конфисовке валюты, указанной валютой. Например, если валюта — USD, сумма находится в центах. Денежные суммы могут быть положительными или отрицательными. Ознакомьтесь с описанием конкретного поля, чтобы определить смысл входа в конкретном случае.
Валюта	objects.item_data.variations.item_variation_data.price_money.currency	string	Тип валюты в формате ISO 4217. Например, код валюты для долларов США составляет USD.
Связанные объекты	related_objects	array of object
Тип	related_objects.type	string	Тип этого объекта.
Идентификатор	related_objects.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	related_objects.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	related_objects.version	integer	Текущая версия объекта.
Удаляется	related_objects.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	related_objects.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	related_objects.category_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Имя	related_objects.tax_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Этап вычисления	related_objects.tax_data.calculation_phase	string	Вычисляется ли налог на основе промежуточных или общих сумм выплат.
Тип включения	related_objects.tax_data.inclusion_type	string	Независимо от того, является ли налог АДДИТИВным или ИНКЛЮЗИВНО.
Процент	related_objects.tax_data.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Включен	related_objects.tax_data.enabled	boolean	Указывает, можно ли использовать объект.

Отключение карточки

Идентификатор операции:

CardDisable

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор карточки	card_id	True	string	Идентификатор карточки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	card.id	string	Уникальный идентификатор, выданный квадратом.
Адресная строка 1	card.billing_address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	card.billing_address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	card.billing_address.locality	string	Город или город адреса.
Административный район 1	card.billing_address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	card.billing_address.postal_code	string	Почтовый индекс адреса.
Страна	card.billing_address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Отпечаток	card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
БУНКЕР	card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Бренд карточки	card.card_brand	string	Бренд карты.
Тип карточки	card.card_type	string	Тип карточки.
Имя заполнителя карточки	card.cardholder_name	string	Имя заполнителя карточки.
Идентификатор клиента	card.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Включен	card.enabled	boolean	Включена ли функция.
Месяц Exp	card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	card.exp_year	integer	Четырехзначный год срока действия карты.
Последние 4	card.last_4	string	Последние 4 цифры номера карточки.
Предоплаченный тип	card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
Идентификатор ссылки	card.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Версия	card.version	integer	Текущая версия этого объекта.

Отмена возврата терминала

Идентификатор операции:

TerminalCancelRefund

Отменяет запрос на возврат средств в терминале Interac по идентификатору запроса на возврат, если он разрешает его состояние.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор возврата терминала	terminal_refund_id	True	string	Идентификатор возврата терминала.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	refund.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор оплаты	refund.payment_id	string	Уникальный идентификатор платежа.
Сумма	refund.amount_money.amount	integer	Сумма.
Валюта	refund.amount_money.currency	string	Валюта.
Причина	refund.reason	string	Причина этого объекта.
Идентификатор устройства	refund.device_id	string	Уникальный идентификатор устройства, предназначенного для этого terminalRefund.
Срок действия	refund.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Состояние	refund.status	string	Текущее состояние проверки этого объекта.
Причина отмены	refund.cancel_reason	string	Причина отмененной транзакции.
Создано в	refund.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	refund.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	refund.app_id	string	Идентификатор приложения, создавшего выход.
Бренд карточки	refund.card.card_brand	string	Бренд карточки.
last_4	refund.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	refund.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	refund.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	refund.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	refund.card.card_type	string	Тип карточки.
БУНКЕР	refund.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Идентификатор заказа	refund.order_id	string	Идентификатор заказа.
Идентификатор расположения	refund.location_id	string	Идентификатор расположения.

Отмена выхода терминала

Идентификатор операции:

TerminalCancelCheckout

Отменяет запрос на получение терминала, если состояние запроса разрешает его.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор выхода	checkout_id	True	string	Идентификатор извлечений.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	checkout.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	checkout.amount_money.amount	integer	Сумма.
Валюта	checkout.amount_money.currency	string	Валюта.
Идентификатор ссылки	checkout.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Идентификатор устройства	checkout.device_options.device_id	string	Уникальный идентификатор устройства, предназначенного для этого терминалаCheckout.
Разрешить подсказку	checkout.device_options.tip_settings.allow_tipping	boolean	Указывает, включена ли подсказка для этого выхода. По умолчанию false.
Экран пропуска квитанций	checkout.device_options.skip_receipt_screen	boolean	Указывает устройству пропустить экран получения. По умолчанию false.
Состояние	checkout.status	string	Текущее состояние проверки этого объекта.
Причина отмены	checkout.cancel_reason	string	Причина отмененной транзакции.
Создано в	checkout.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	checkout.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	checkout.app_id	string	Идентификатор приложения, создавшего выход.
Срок действия	checkout.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания

Отмена оплаты

Идентификатор операции:

PaymentCancel

Отменяет (voids) платеж. Эту конечную точку можно использовать для отмены оплаты с состоянием APPROVED.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оплаты	payment_id	True	string	Идентификатор платежа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	payment.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	payment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	payment.amount_money.amount	integer	Сумма.
Валюта	payment.amount_money.currency	string	Валюта.
Сумма	payment.tip_money.amount	integer	Сумма.
Валюта	payment.tip_money.currency	string	Валюта.
Состояние	payment.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payment.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу. Эта автоматическая delay_action применяется только к платежам, которые не достигают состояния терминала (COMPLETED, CANCELED или FAILED) до периода времени delay_duration. Это поле указывается в формате RFC 3339.
Тип источника	payment.source_type	string	Исходный тип для этого платежа. Текущие значения включают CARD, BANK_ACCOUNT, WALLET, CASH или EXTERNAL.
Состояние	payment.card_details.status	string	Текущее состояние.
Бренд карточки	payment.card_details.card.card_brand	string	Бренд карты.
Последние 4	payment.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payment.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payment.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payment.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payment.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payment.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payment.card_details.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Метод Entry	payment.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние CVV	payment.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние AVS	payment.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payment.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payment.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payment.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Недействимый	payment.card_details.card_payment_timeline.voided_at	string	Метка времени, когда платеж был отменен, в формате RFC 3339.
Идентификатор расположения	payment.location_id	string	Идентификатор расположения.
Идентификатор заказа	payment.order_id	string	Идентификатор заказа.
Создано в	payment.risk_evaluation.created_at	string	Метка времени при создании в формате RFC 3339.
Уровень риска	payment.risk_evaluation.risk_level	string	Уровень риска, связанный с оплатой.
Замечание	payment.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор клиента	payment.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Сумма	payment.total_money.amount	integer	Сумма.
Валюта	payment.total_money.currency	string	Валюта.
Сумма	payment.approved_money.amount	integer	Сумма.
Валюта	payment.approved_money.currency	string	Валюта.
Действие по задержке	payment.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payment.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Квадратный продукт	payment.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payment.application_details.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Маркер версии	payment.version_token	string	Этот непрозрачный маркер определяет определенную версию объекта.

Отмена оплаты по ключу idempotency

Идентификатор операции:

PaymentCancelIdempotency

Отменяет (voids) платеж, определенный ключом идемпотентности, указанным в запросе. Используйте этот метод, если состояние запроса CreatePayment неизвестно (например, после отправки запроса CreatePayment возникает сетевая ошибка, и вы не получите ответ). В этом случае можно направить квадрат, чтобы отменить оплату с помощью этой конечной точки. В запросе укажите тот же ключ идемпотентности, который вы указали в запросе CreatePayment, который требуется отменить. После отмены оплаты вы можете снова отправить запрос CreatePayment. Обратите внимание, что если платеж с указанным ключом идемпотентности не найден, действие не выполняется, а конечная точка успешно возвращается.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).

Возвращаемое значение

response

object

Отмена подписки

Идентификатор операции:

SubscriptionCancel

Задает поле canceled_date до конца активного периода выставления счетов. После этой даты состояние изменяется с ACTIVE на CANCELED.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscription_id	True	string	Идентификатор подписки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	subscription.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscription.location_id	string	Идентификатор расположения.
Идентификатор плана	subscription.plan_id	string	Идентификатор связанного плана подписки.
Идентификатор клиента	subscription.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Идентификатор карточки	subscription.card_id	string	Идентификатор карточки клиента, которая взимается за подписку.
Дата начала	subscription.start_date	string	Дата начала подписки в формате YYY-MM-DD.
Дата отмены	subscription.canceled_date	string	Дата отмены подписки в формате YYY-MM-DD.
Оплата до даты	subscription.paid_until_date	string	Дата, доплачиваемая.
Состояние	subscription.status	string	Текущее состояние проверки этого объекта.
Создано в	subscription.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Версия	subscription.version	integer	Текущая версия этого объекта.
Timezone	subscription.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscription.source.name	string	Имя.

Отмена счета

Идентификатор операции:

InvoiceCancel

Отменяет счет. Продавец не может собирать платежи за отмененный счет.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер счета	invoice_id	True	string	Идентификатор счета.
Версия	version		integer	Версия.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	invoice.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoice.version	integer	Текущая версия этого объекта.
Идентификатор расположения	invoice.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoice.order_id	string	Идентификатор заказа.
Запросы на оплату	invoice.payment_requests	array of object
ИД пользователя	invoice.payment_requests.uid	string	Идентификатор, созданный квадратом.
Тип запроса	invoice.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoice.payment_requests.due_date	string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	invoice.payment_requests.tipping_enabled	boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Напоминания	invoice.payment_requests.reminders	array of object
ИД пользователя	invoice.payment_requests.reminders.uid	string	Идентификатор, назначенный квадратом.
Относительные запланированные дни	invoice.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoice.payment_requests.reminders.message	string	Сообщение.
Состояние	invoice.payment_requests.reminders.status	string	Текущее состояние.
Сумма	invoice.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoice.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoice.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Номер счета	invoice.invoice_number	string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	invoice.title	string	Заголовок.
Description	invoice.description	string	Описание.
Запланированное в	invoice.scheduled_at	string	Метка времени при планировании обработки в формате RFC 3339.
Состояние	invoice.status	string	Текущее состояние проверки этого объекта.
Timezone	invoice.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoice.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	invoice.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор клиента	invoice.primary_recipient.customer_id	string	Идентификатор клиента, связанного с заказом.
Заданное имя	invoice.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoice.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoice.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoice.primary_recipient.phone_number	string	Номер телефона получателя.
Card	invoice.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoice.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoice.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoice.custom_fields	array of object
Этикетка	invoice.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoice.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoice.custom_fields.placement	string	Расположение настраиваемого поля в счете.
Метод доставки	invoice.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Дата продажи или обслуживания	invoice.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Отправка доказательств

Идентификатор операции:

EvidenceSubmit

Отправляет доказательства банку держателя карт. Перед отправкой доказательств квадрат компилирует все доступные доказательства. К ним относятся доказательства, отправленные с помощью конечных точек CreateDisputeEvidenceFile и CreateDisputeEvidenceText, которые автоматически предоставляются квадратом, когда они доступны.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	dispute.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	dispute.amount_money.amount	integer	Сумма.
Валюта	dispute.amount_money.currency	string	Валюта.
Причина	dispute.reason	string	Причина этого объекта.
Государство	dispute.state	string	Текущее состояние.
Из-за	dispute.due_at	string	Время выполнения следующего действия в формате RFC 3339.
Спорные платежи	dispute.disputed_payments	array of object
Идентификатор оплаты	dispute.disputed_payments.payment_id	string	Квадратный созданный уникальный идентификатор оплаты.
Бренд карточки	dispute.card_brand	string	Бренд карты.
Создано в	dispute.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	dispute.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор спора бренда	dispute.brand_dispute_id	string	Идентификатор спора в системе фирменной марки карты, созданной брендом карты.

Пакетная служба извлекает изменения инвентаризации

Идентификатор операции:

InventoryBatchRetrieveChanges

Возвращает исторические физические счетчики и корректировки на основе предоставленных критериев фильтра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы объектов каталога	catalog_object_ids		array of string
Идентификаторы расположения	location_ids		array of string
Типы	types		array of string
States	states		array of string
Обновлено после	updated_after		string	Фильтр, возвращающий результаты со значением calculated_at после заданного времени, указанного в метке времени RFC 3339.
Обновлено до	updated_before		string	Фильтр для возврата результатов с их created_at или calculated_at значение строго до заданного времени, указанного в метке времени RFC 3339.

Возвращаемое значение

Имя	Путь	Тип	Описание
Changes	changes	array of object
Тип	changes.type	string	Тип этого объекта.
Идентификатор	changes.physical_count.id	string	Идентификатор объекта
Идентификатор ссылки	changes.physical_count.reference_id	string	Необязательный идентификатор ссылки, определяемый пользователем, который связывает эту карточку с другой сущностью во внешней системе.
Идентификатор объекта каталога	changes.physical_count.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	changes.physical_count.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Государство	changes.physical_count.state	string	Текущее состояние инвентаризации для связанного количества элементов.
Идентификатор расположения	changes.physical_count.location_id	string	Идентификатор расположения получателя (кроме торговца), получающего часть этого тендера.
Количество	changes.physical_count.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Продукт	changes.physical_count.source.product	string	Тип продукта для приложения.
Идентификатор приложения	changes.physical_count.source.application_id	string	Квадратный идентификатор, назначенный приложению.
Имя	changes.physical_count.source.name	string	Наименование номенклатуры.
Идентификатор сотрудника	changes.physical_count.employee_id	string	Созданный квадрат идентификатор сотрудника, ответственного за физическое число.
Произошло в	changes.physical_count.occurred_at	string	Метка времени, созданная клиентом в формате RFC 3339, которая указывает, когда было проверено физическое число. Для обновлений физического количества метка времени occurred_at не может быть старше 24 часов или в будущем относительно времени запроса.
Создано в	changes.physical_count.created_at	string	Метка времени, созданная клиентом RFC 3339, указывающая, когда был создан физический счетчик.

Перечисление возмещения платежей

Идентификатор операции:

RefundList

Извлекает список возвратов для учетной записи, выполняя запрос. Результаты в конечном итоге согласованы, и новые возвраты или изменения в возврате могут занять несколько секунд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Время начала	begin_time		string	Инклюзивное время начала запроса на opened_at в формате ISO 8601.
Время окончания	end_time		string	Монопольная дата окончания запроса на opened_at в формате ISO 8601.
Порядок сортировки	sort_order		string	Сортирует возвращаемый список по моменту создания карточки с указанным порядком.
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Идентификатор расположения	location_id		string	Этот необязательный фильтр можно указать, чтобы получить только записи, принадлежащие определенному расположению.
Состояние	status		string	Если задано, возвращает только объекты, соответствующие указанным состояниям.
Тип источника	source_type		string	При условии возвращаются только возвраты средств с указанным типом источника.
Лимит	limit		integer	Верхний предел числа, возвращаемого в ответе.

Возвращаемое значение

Имя	Путь	Тип	Описание
Возврат	refunds	array of object
Идентификатор	refunds.id	string	Уникальный идентификатор, выданный квадратом.
Состояние	refunds.status	string	Текущее состояние проверки этого объекта.
Сумма	refunds.amount_money.amount	integer	Сумма.
Валюта	refunds.amount_money.currency	string	Валюта.
Идентификатор оплаты	refunds.payment_id	string	Идентификатор платежа.
Идентификатор заказа	refunds.order_id	string	Идентификатор заказа.
Создано в	refunds.created_at	string	Время события в формате ISO 8601.
Обновлено в	refunds.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Плата за обработку	refunds.processing_fee	array of object
Действующий в	refunds.processing_fee.effective_at	string	Метка времени, когда плата вступает в силу, в формате RFC 3339.
Тип	refunds.processing_fee.type	string	Тип этого объекта.
Сумма	refunds.processing_fee.amount_money.amount	integer	Сумма.
Валюта	refunds.processing_fee.amount_money.currency	string	Валюта.
Идентификатор расположения	refunds.location_id	string	Идентификатор расположения.
Причина	refunds.reason	string	Причина спора, по которой держатель карт инициировал спор с их банком.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Перечисление групп клиентов

Идентификатор операции:

CustomerGroupList

Извлекает список групп клиентов бизнеса.

Возвращаемое значение

Имя	Путь	Тип	Описание
Groups	groups	array of object
Идентификатор	groups.id	string	Уникальный идентификатор, выданный квадратом.
Имя	groups.name	string	Имя объекта.
Создано в	groups.created_at	string	Время события в формате ISO 8601.
Обновлено в	groups.updated_at	string	Метка времени последнего изменения в формате RFC 3339

Перечисление доказательств спора

Идентификатор операции:

DisputeListEvidence

Возвращает список доказательств, связанных с спором.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.

Возвращаемое значение

Имя	Путь	Тип	Описание
Evidence	evidence	array of object
Идентификатор	evidence.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор спора	evidence.dispute_id	string	Идентификатор спора, с которым связано свидетельство.
Текст доказательства	evidence.evidence_text	string	Необработанный текст.
Тип доказательства	evidence.evidence_type	string	Тип доказательства.
Отправлено по адресу	evidence.uploaded_at	string	Время выполнения следующего действия в формате RFC 3339.
Идентификатор доказательства	evidence.evidence_id	string	Квадратный идентификатор доказательства.
Filename	evidence.evidence_file.filename	string	Имя файла, включая расширение файла
Тип файла	evidence.evidence_file.filetype	string	Файлы доказательств спора должны быть форматами application/pdf, image/heic, image/heif, image/jpeg, image/png или image/tiff.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Перечисление клиентов

Идентификатор операции:

CustomerList

Список профилей клиентов, связанных с учетной записью Square. В обычных условиях эксплуатации только что созданные или обновленные профили клиентов становятся доступными для операции перечисления в течение 30 секунд. Иногда распространение новых или обновленных профилей может занять около одной минуты или дольше, особенно во время сетевых инцидентов и сбоев.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Лимит	limit		integer	Верхний предел числа, возвращаемого в ответе.
Поле сортировки	sort_field		string	Указывает, как следует отсортировать клиентов. Значение по умолчанию — DEFAULT.
Порядок сортировки	sort_order		string	Сортирует возвращаемый список по моменту создания карточки с указанным порядком.

Возвращаемое значение

Имя	Путь	Тип	Описание
Customers	customers	array of object
Идентификатор	customers.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	customers.created_at	string	Время события в формате ISO 8601.
Обновлено в	customers.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Заданное имя	customers.given_name	string	Указанное имя (т. е. имя, связанное с профилем клиента).
Фамилия	customers.family_name	string	Семейство (т. е. фамилия), связанное с профилем клиента.
Электронная почта	customers.email_address	string	Адрес электронной почты, связанный с профилем клиента.
Адресная строка 1	customers.address.address_line_1	string	Первая строка адреса.
Строка адреса 2	customers.address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	customers.address.locality	string	Город или город адреса.
Административный район 1	customers.address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	customers.address.postal_code	string	Почтовый индекс адреса.
Страна	customers.address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Номер телефона	customers.phone_number	string	11-значный номер телефона, связанный с профилем клиента.
Идентификатор ссылки	customers.reference_id	string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Замечание	customers.note	string	Настраиваемая заметка, связанная с профилем клиента.
Отмена подписки по электронной почте	customers.preferences.email_unsubscribed	boolean	Указывает, отменяет ли клиент подписку на сообщения электронной почты маркетинговой кампании. Значение true означает, что клиент решил отказаться от маркетинга электронной почты от текущего продавца Квадрата или от всех продавцов Квадрата. Это значение доступно только для чтения из API клиентов.
Источник создания	customers.creation_source	string	Источник создания представляет метод, используемый для создания профиля клиента.
Идентификаторы групп	customers.group_ids	array of string
Идентификаторы сегментов	customers.segment_ids	array of string
Версия	customers.version	integer	Текущая версия объекта.

Перечисление платежей

Идентификатор операции:

PaymentList

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Время начала	begin_time		string	Инклюзивное время начала запроса на opened_at в формате ISO 8601.
Время окончания	end_time		string	Монопольная дата окончания запроса на opened_at в формате ISO 8601.
Порядок сортировки	sort_order		string	Сортирует возвращаемый список по моменту создания карточки с указанным порядком.
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Идентификатор расположения	location_id		string	Этот необязательный фильтр можно указать, чтобы получить только записи, принадлежащие определенному расположению.
Total	total		integer	Точную сумму в total_money для оплаты.
Последние 4	last_4		string	Последние четыре цифры платежной карты.
Бренд карточки	card_brand		string	Бренд платежной карты (например, VISA).
Лимит	limit		integer	Верхний предел числа, возвращаемого в ответе.

Возвращаемое значение

Имя	Путь	Тип	Описание
Payments	payments	array of object
Идентификатор	payments.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payments.created_at	string	Время события в формате ISO 8601.
Обновлено в	payments.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Сумма	payments.amount_money.amount	integer	Сумма.
Валюта	payments.amount_money.currency	string	Валюта.
Состояние	payments.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payments.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу.
Тип источника	payments.source_type	string	Исходный тип для этого платежа.
Состояние	payments.card_details.status	string	Текущее состояние оплаты карты. Состояние может быть АВТОРИЗОВАНО, ЗАПИСАНО, VOIDED или FAILED.
Бренд карточки	payments.card_details.card.card_brand	string	Бренд карты.
last_4	payments.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payments.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payments.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payments.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payments.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payments.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payments.card_details.card.bin	string	Первые шесть цифр номера карты, известные как идентификационный номер банка (BIN)
Метод Entry	payments.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние Cvv	payments.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние avs	payments.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payments.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payments.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payments.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Записано в	payments.card_details.card_payment_timeline.captured_at	string	Метка времени записи платежа в формате RFC 3339.
Идентификатор расположения	payments.location_id	string	Идентификатор расположения.
Идентификатор заказа	payments.order_id	string	Идентификатор заказа.
Плата за обработку	payments.processing_fee	array of object
Действующий в	payments.processing_fee.effective_at	string	Метка времени, когда плата вступает в силу, в формате RFC 3339.
Тип	payments.processing_fee.type	string	Тип этого объекта.
Сумма	payments.processing_fee.amount_money.amount	integer	Сумма.
Валюта	payments.processing_fee.amount_money.currency	string	Валюта.
Замечание	payments.note	string	Настраиваемая заметка, связанная с профилем клиента.
Сумма	payments.total_money.amount	integer	Сумма.
Валюта	payments.total_money.currency	string	Валюта.
Сумма	payments.approved_money.amount	integer	Сумма.
Валюта	payments.approved_money.currency	string	Валюта.
Номер квитанции	payments.receipt_number	string	Номер квитанции платежа. Поле отсутствует, если платеж отменен.
URL-адрес квитанции	payments.receipt_url	string	URL-адрес квитанции платежа. Поле заполняется только для оплаты COMPLETED.
Действие по задержке	payments.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payments.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Идентификатор участника группы	payments.team_member_id	string	Идентификатор объекта TeamMember для члена команды, связанного с объектом.
Квадратный продукт	payments.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payments.application_details.application_id	string	Идентификатор квадрата, назначенный приложению, используемому для оплаты. Разработчики приложений могут использовать эти сведения для идентификации платежей, обработанных приложением. Например, если разработчик использует пользовательское приложение для обработки платежей, это поле содержит идентификатор приложения на панели мониторинга разработчика. Если продавец использует приложение Square App Marketplace для обработки платежей, поле содержит соответствующий идентификатор приложения.
Маркер версии	payments.version_token	string	Используется для оптимистического параллелизма. Этот непрозрачный маркер определяет определенную версию объекта Payment.

Перечисление споров

Идентификатор операции:

DisputeList

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
States	states		string	Спор указывает на фильтрацию результата. Если это не указано, конечная точка возвращает все открытые споры (состояние спора не INQUIRY_CLOSED, WON или LOST).
Идентификатор расположения	location_id		string	Этот необязательный фильтр можно указать, чтобы получить только записи, принадлежащие определенному расположению.

Возвращаемое значение

Имя	Путь	Тип	Описание
Споры	disputes	array of object
Идентификатор	disputes.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	disputes.amount_money.amount	integer	Сумма.
Валюта	disputes.amount_money.currency	string	Валюта.
Причина	disputes.reason	string	Причина спора, по которой держатель карт инициировал спор с их банком.
Государство	disputes.state	string	Текущее состояние.
Из-за	disputes.due_at	string	Время выполнения следующего действия в формате RFC 3339.
Спорные платежи	disputes.disputed_payments	array of object
Идентификатор оплаты	disputes.disputed_payments.payment_id	string	Квадратный созданный уникальный идентификатор оспариваемого платежа.
Бренд карточки	disputes.card_brand	string	Бренд карты, используемый в спорном платеже.
Создано в	disputes.created_at	string	Время события в формате ISO 8601.
Обновлено в	disputes.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Идентификатор спора бренда	disputes.brand_dispute_id	string	Идентификатор спора в системе фирменной марки карты, созданной брендом карты.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Перечисление счетов

Идентификатор операции:

InvoiceList

Возвращает список счетов для заданного расположения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор расположения	location_id		string	Этот необязательный фильтр можно указать, чтобы получить только записи, принадлежащие определенному расположению.
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Лимит	limit		integer	Верхний предел числа, возвращаемого в ответе.

Возвращаемое значение

Имя	Путь	Тип	Описание
Invoices	invoices	array of object
Идентификатор	invoices.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoices.version	integer	Текущая версия объекта.
Идентификатор расположения	invoices.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoices.order_id	string	Идентификатор заказа.
Запросы на оплату	invoices.payment_requests	array of object
ИД пользователя	invoices.payment_requests.uid	string	Идентификатор созданного квадратом запроса на оплату в счете.
Тип запроса	invoices.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoices.payment_requests.due_date	string	Дата выполнения (в часовом поясе счета) для запроса на оплату в формате YYY-MM-DD.
Советы включено	invoices.payment_requests.tipping_enabled	boolean	Если задано значение true, страница счета с квадратным размещением (поле public_url счета) предоставляет клиенту место для оплаты чаевых.
Напоминания	invoices.payment_requests.reminders	array of object	Напоминания
ИД пользователя	invoices.payment_requests.reminders.uid	string	Идентификатор, назначаемый квадратом, который однозначно идентифицирует напоминание в счетеPaymentRequest.
Относительные запланированные дни	invoices.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoices.payment_requests.reminders.message	string	Сообщение напоминания.
Состояние	invoices.payment_requests.reminders.status	string	Состояние напоминания.
Сумма	invoices.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoices.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoices.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoices.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoices.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Запрошенный процент	invoices.payment_requests.percentage_requested	string	Указывает сумму для запроса на оплату в процентах.
Идентификатор карточки	invoices.payment_requests.card_id	string	Идентификатор кредитной или дебетовой карты в файле для оплаты запроса на оплату.
Номер счета	invoices.invoice_number	string	Понятный номер счета.
Название	invoices.title	string	Заголовок счета.
Description	invoices.description	string	Описание.
Запланированное в	invoices.scheduled_at	string	Метка времени при планировании выставления счета на обработку в формате RFC 3339. После публикации счета Square обрабатывает счет по указанной дате в соответствии с способом доставки и параметрами запроса на оплату.
Состояние	invoices.status	string	Текущее состояние проверки этого объекта.
Timezone	invoices.timezone	string	Часовой пояс, используемый для интерпретации дат календаря в счете, например due_date. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoices.created_at	string	Время события в формате ISO 8601.
Обновлено в	invoices.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Идентификатор клиента	invoices.primary_recipient.customer_id	string	Идентификатор клиента, связанного с карточкой.
Заданное имя	invoices.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoices.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoices.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoices.primary_recipient.phone_number	string	Номер телефона получателя.
Card	invoices.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoices.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoices.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoices.custom_fields	array of object
Этикетка	invoices.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoices.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoices.custom_fields.placement	string	Расположение настраиваемого поля в счете
Метод доставки	invoices.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту.
Дата продажи или обслуживания	invoices.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.
Общедоступный URL-адрес	invoices.public_url	string	URL-адрес страницы счета с квадратным размещением. После публикации счета с помощью конечной точки PublishInvoice квадрат размещает страницу счета и возвращает URL-адрес страницы в ответе.
Сумма	invoices.next_payment_amount_money.amount	integer	Сумма.
Валюта	invoices.next_payment_amount_money.currency	string	Валюта.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Платеж по возврату средств

Идентификатор операции:

RefundPayment

Возвращает платеж. Вы можете вернуть всю сумму оплаты или часть ее. Эту конечную точку можно использовать для возврата оплаты карты или записи возврата денежных средств или внешней оплаты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор оплаты	payment_id		string	Уникальный идентификатор возвращаемого платежа.
Сумма	amount		integer	Сумма денег, которую нужно принять для этого платежа, не включая tip_money.
Валюта	currency		string	3-символьный код валюты ISO 4217.
Сумма	amount		integer	Сумма денег, которую нужно принять для этого платежа, не включая tip_money.
Валюта	currency		string	3-символьный код валюты ISO 4217.
Причина	reason		string	Описание причины возврата.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	refund.id	string	Уникальный идентификатор, выданный квадратом.
Состояние	refund.status	string	Текущее состояние проверки этого объекта.
Сумма	refund.amount_money.amount	integer	Сумма.
Валюта	refund.amount_money.currency	string	Валюта.
Идентификатор оплаты	refund.payment_id	string	Уникальный идентификатор платежа.
Идентификатор заказа	refund.order_id	string	Идентификатор заказа.
Создано в	refund.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	refund.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	refund.app_fee_money.amount	integer	Сумма.
Валюта	refund.app_fee_money.currency	string	Валюта.
Идентификатор расположения	refund.location_id	string	Идентификатор расположения.
Причина	refund.reason	string	Причина этого объекта.

Поиск клиентов

Идентификатор операции:

CustomerSearch

Выполняет поиск профилей клиентов, связанных с учетной записью Square, с помощью поддерживаемого фильтра запросов. Вызов SearchCustomers без явного фильтра запросов возвращает все профили клиентов, упорядоченные в алфавитном порядке на основе given_name и family_name.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Пушистый	fuzzy		string	Используйте нечеткий фильтр, чтобы выбрать клиентов, атрибуты которых соответствуют указанному запросу нечетким образом. При использовании нечеткого параметра поисковые запросы маркерируются, а затем каждый маркер запроса должен быть сопоставлен где-то в поисковом атрибуте. Для запросов с одним маркером это фактически то же поведение, что и операция частичного сопоставления.
Ценности	values		array of string
Правило	rule		string	Указывает, должен ли профиль клиента соответствовать критериям фильтра в результате или исключен из результата.
Начать с	start_at		string	Значение даты и времени в формате RFC 3339, указывающее, когда начинается диапазон времени.
Конец в	end_at		string	Значение даты и времени в формате RFC 3339, указывающее, когда заканчивается диапазон времени.
All	all		array of string
Поле	field		string	Используйте один или несколько атрибутов клиента в качестве ключа сортировки для сортировки поисковых профилей клиентов.
Заказ	order		string	Указывает порядок сортировки результатов на основе значения поля сортировки. Строки используют стандартное сравнение алфавита для определения порядка.
Лимит	limit		integer	Ограничение количества результатов, возвращаемых на одной странице. Ограничение — это рекомендации. Реализация может возвращать более или меньше результатов. Если указанное ограничение отрицательно, ноль или выше максимального предела 1000, оно будет игнорироваться.

Возвращаемое значение

Имя	Путь	Тип	Описание
Customers	customers	array of object
Идентификатор	customers.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	customers.created_at	string	Время события в формате ISO 8601.
Обновлено в	customers.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Заданное имя	customers.given_name	string	Указанное имя (т. е. имя, связанное с профилем клиента).
Фамилия	customers.family_name	string	Семейство (т. е. фамилия), связанное с профилем клиента.
Электронная почта	customers.email_address	string	Адрес электронной почты, связанный с профилем клиента.
Адресная строка 1	customers.address.address_line_1	string	Первая строка адреса.
Строка адреса 2	customers.address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	customers.address.locality	string	Город или город адреса.
Административный район 1	customers.address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	customers.address.postal_code	string	Почтовый индекс адреса.
Страна	customers.address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Номер телефона	customers.phone_number	string	11-значный номер телефона, связанный с профилем клиента.
Идентификатор ссылки	customers.reference_id	string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Отмена подписки по электронной почте	customers.preferences.email_unsubscribed	boolean	Указывает, отменяет ли клиент подписку на сообщения электронной почты маркетинговой кампании. Значение true означает, что клиент решил отказаться от маркетинга электронной почты от текущего продавца Квадрата или от всех продавцов Квадрата. Это значение доступно только для чтения из API клиентов.
Источник создания	customers.creation_source	string	Источник создания представляет метод, используемый для создания профиля клиента.
Идентификаторы групп	customers.group_ids	array of string
Идентификаторы сегментов	customers.segment_ids	array of string
Версия	customers.version	integer	Текущая версия объекта.
Замечание	customers.note	string	Настраиваемая заметка, связанная с профилем клиента.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Поиск объектов каталога

Идентификатор операции:

CatalogSearch

Ищет CatalogObject любого типа путем сопоставления поддерживаемых значений атрибутов поиска, исключая пользовательские значения атрибутов для элементов или вариантов элементов, в отношении одного или нескольких указанных фильтров запросов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Типы объектов	object_types		array of string
Имя атрибута	attribute_name		string	Имя атрибута для поиска.
Префикс атрибута	attribute_prefix		string	Требуемый префикс значения атрибута поиска.
Лимит	limit		integer	Ограничение количества результатов, возвращаемых на одной странице. Ограничение — это рекомендации. Реализация может возвращать более или меньше результатов. Если указанное ограничение отрицательно, ноль или выше максимального предела 1000, оно будет игнорироваться.

Возвращаемое значение

Имя	Путь	Тип	Описание
Объекты	objects	array of object
Тип	objects.type	string	Тип этого объекта.
Идентификатор	objects.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	objects.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.version	integer	Текущая версия объекта.
Удаляется	objects.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	objects.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	objects.item_data.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Description	objects.item_data.title	string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Идентификатор категории	objects.item_data.category_id	string	Идентификатор категории элемента, если он есть.
Тип продукта	objects.item_data.product_type	string	Выражение запроса типов продуктов для возврата элементов или вариантов элементов с указанными типами продуктов.
Идентификаторы налогоплательщика	objects.item_data.tax_ids	array of string
Варианты	objects.item_data.variations	array of object
Тип	objects.item_data.variations.type	string	Тип этого объекта. Каждый тип объекта имеет ожидаемые свойства, выраженные в структурированном формате в соответствующем поле *_data ниже.
Идентификатор	objects.item_data.variations.id	string	Идентификатор для ссылки на этот объект.
Обновлено в	objects.item_data.variations.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Версия	objects.item_data.variations.version	integer	Версия объекта. При обновлении объекта указанная версия должна соответствовать версии в базе данных, в противном случае запись будет отклонена как конфликтующая.
Удаляется	objects.item_data.variations.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех местах	objects.item_data.variations.present_at_all_locations	boolean	Список расположений, в которых присутствует объект, даже если present_at_all_locations имеет значение false. Это может включать расположения, которые деактивированы.
Идентификатор элемента	objects.item_data.variations.item_variation_data.item_id	string	Идентификатор объекта с этим вариантом элемента.
Имя	objects.item_data.variations.item_variation_data.name	string	Имя этого элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Порядковый	objects.item_data.variations.item_variation_data.ordinal	integer	Порядок отображения вариантов этого элемента. Это значение доступно только для чтения.
Сумма	objects.item_data.variations.item_variation_data.price_money.amount	integer	Сумма денег, в наименьшем конфисовке валюты, указанной валютой. Например, если валюта — USD, сумма находится в центах. Денежные суммы могут быть положительными или отрицательными. Ознакомьтесь с описанием конкретного поля, чтобы определить смысл входа в конкретном случае.
Валюта	objects.item_data.variations.item_variation_data.price_money.currency	string	Тип валюты в формате ISO 4217. Например, код валюты для долларов США составляет USD.
Тип ценообразования	objects.item_data.variations.item_variation_data.pricing_type	string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Видимость	objects.item_data.visibility	string	Видимость.

Поиск по извлечению терминалов

Идентификатор операции:

TerminalSearchCheckouts

Извлекает отфильтрованный список запросов на извлечение терминала, созданных учетной записью, выполняя запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов, возвращаемых на одной странице. Ограничение — это рекомендации. Реализация может возвращать более или меньше результатов. Если указанное ограничение отрицательно, ноль или выше максимального предела 1000, оно будет игнорироваться.
Состояние	status		string	Текущее состояние.

Возвращаемое значение

Имя	Путь	Тип	Описание
Извлечения	checkouts	array of object
Идентификатор	checkouts.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	checkouts.amount_money.amount	integer	Сумма.
Валюта	checkouts.amount_money.currency	string	Валюта.
Идентификатор ссылки	checkouts.reference_id	string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Замечание	checkouts.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор устройства	checkouts.device_options.device_id	string	Уникальный идентификатор устройства, предназначенного для этого терминалаCheckout.
Разрешить подсказку	checkouts.device_options.tip_settings.allow_tipping	boolean	Указывает, включена ли подсказка для этого выхода. По умолчанию false.
Экран пропуска квитанций	checkouts.device_options.skip_receipt_screen	boolean	Указывает устройству пропустить экран получения. По умолчанию false.
Состояние	checkouts.status	string	Текущее состояние проверки этого объекта.
Идентификаторы оплаты	checkouts.payment_ids	array of string
Создано в	checkouts.created_at	string	Время события в формате ISO 8601.
Обновлено в	checkouts.updated_at	string	Метка времени последнего изменения в формате RFC 3339
ИД приложения	checkouts.app_id	string	Идентификатор приложения, создавшего выход.
Срок действия	checkouts.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Поиск по подпискам

Идентификатор операции:

SubscriptionSearch

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы расположения	location_ids		array of string
Идентификаторы клиентов	customer_ids		array of string
Исходные имена	source_names		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Подписки	subscriptions	array of object
Идентификатор	subscriptions.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscriptions.location_id	string	Идентификатор расположения.
Идентификатор плана	subscriptions.plan_id	string	Идентификатор связанного плана подписки
Идентификатор клиента	subscriptions.customer_id	string	Идентификатор клиента, назначаемого квадратом, связанного с учетной записью.
Дата начала	subscriptions.start_date	string	Дата начала подписки в формате YYY-MM-DD.
Дата отмены	subscriptions.canceled_date	string	Дата отмены подписки в формате YYY-MM-DD.
Оплата по дате	subscriptions.charged_through_date	string	Дата, в которой клиент выставляется счет за подписку, в формате YYY-MM-DD.
Состояние	subscriptions.status	string	Текущее состояние проверки этого объекта.
Создано в	subscriptions.created_at	string	Время события в формате ISO 8601.
Идентификатор карточки	subscriptions.card_id	string	Идентификатор карточки клиента, которая взимается за подписку.
Оплата до даты	subscriptions.paid_until_date	string	Дата, доплачиваемая.
Timezone	subscriptions.timezone	string	Часовой пояс, используемый для интерпретации дат календаря в счете, например due_date. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscriptions.source.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент налогов	subscriptions.tax_percentage	string	Сумма налога, применяемая при выставлении счетов подписки.
Сумма	subscriptions.price_override_money.amount	integer	Сумма.
Валюта	subscriptions.price_override_money.currency	string	Валюта.
Версия	subscriptions.version	integer	Текущая версия объекта.
Идентификаторы счетов	subscriptions.invoice_ids	array of string

Поиск счетов

Идентификатор операции:

InvoiceSearch

Выполняет поиск счетов из расположения, указанного в фильтре.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы расположения	location_ids		array of string
Идентификаторы клиентов	customer_ids		array of string
Поле	field		string	Используйте один или несколько атрибутов клиента в качестве ключа сортировки для сортировки поисковых профилей клиентов.
Заказ	order		string	Указывает порядок сортировки результатов на основе значения поля сортировки. Строки используют стандартное сравнение алфавита для определения порядка.
Лимит	limit		integer	Максимальное количество возвращаемых счетов (200 — максимальное ограничение). Если это не указано, сервер использует ограничение по умолчанию в 100 счетов.

Возвращаемое значение

Имя	Путь	Тип	Описание
Invoices	invoices	array of object
Идентификатор	invoices.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoices.version	integer	Текущая версия объекта.
Идентификатор расположения	invoices.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoices.order_id	string	Идентификатор заказа.
Запросы на оплату	invoices.payment_requests	array of object
ИД пользователя	invoices.payment_requests.uid	string	Идентификатор созданного квадратом запроса на оплату в счете.
Тип запроса	invoices.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoices.payment_requests.due_date	string	Дата выполнения (в часовом поясе счета) для запроса на оплату в формате YYY-MM-DD.
Советы включено	invoices.payment_requests.tipping_enabled	boolean	Если задано значение true, страница счета с квадратным размещением (поле public_url счета) предоставляет клиенту место для оплаты чаевых.
Напоминания	invoices.payment_requests.reminders	array of object	Напоминания
ИД пользователя	invoices.payment_requests.reminders.uid	string	Идентификатор, назначаемый квадратом, который однозначно идентифицирует напоминание в счетеPaymentRequest.
Относительные запланированные дни	invoices.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoices.payment_requests.reminders.message	string	Сообщение напоминания.
Состояние	invoices.payment_requests.reminders.status	string	Состояние напоминания.
Сумма	invoices.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoices.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoices.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoices.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoices.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Запрошенный процент	invoices.payment_requests.percentage_requested	string	Указывает сумму для запроса на оплату в процентах.
Идентификатор карточки	invoices.payment_requests.card_id	string	Идентификатор кредитной или дебетовой карты в файле для оплаты запроса на оплату.
Номер счета	invoices.invoice_number	string	Понятный номер счета.
Название	invoices.title	string	Заголовок счета.
Description	invoices.description	string	Описание.
Запланированное в	invoices.scheduled_at	string	Метка времени при планировании выставления счета на обработку в формате RFC 3339. После публикации счета Square обрабатывает счет по указанной дате в соответствии с способом доставки и параметрами запроса на оплату.
Состояние	invoices.status	string	Текущее состояние проверки этого объекта.
Timezone	invoices.timezone	string	Часовой пояс, используемый для интерпретации дат календаря в счете, например due_date. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoices.created_at	string	Время события в формате ISO 8601.
Обновлено в	invoices.updated_at	string	Метка времени последнего изменения в формате RFC 3339
Идентификатор клиента	invoices.primary_recipient.customer_id	string	Идентификатор клиента, связанного с карточкой.
Заданное имя	invoices.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoices.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoices.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoices.primary_recipient.phone_number	string	Номер телефона получателя.
Card	invoices.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoices.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoices.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoices.custom_fields	array of object
Этикетка	invoices.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoices.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoices.custom_fields.placement	string	Расположение настраиваемого поля в счете
Метод доставки	invoices.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту.
Дата продажи или обслуживания	invoices.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.
Общедоступный URL-адрес	invoices.public_url	string	URL-адрес страницы счета с квадратным размещением. После публикации счета с помощью конечной точки PublishInvoice квадрат размещает страницу счета и возвращает URL-адрес страницы в ответе.
Сумма	invoices.next_payment_amount_money.amount	integer	Сумма.
Валюта	invoices.next_payment_amount_money.currency	string	Валюта.
Cursor	cursor	string	Добавьте курсор на страницы в последующие вызовы этой конечной точки, чтобы получить следующий набор результатов, связанных с исходным запросом.

Получение возврата платежей

Идентификатор операции:

RefundGet

Извлекает конкретный возврат с помощью refund_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор возврата	refund_id	True	string	Идентификатор возврата.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	refund.id	string	Уникальный идентификатор, выданный квадратом.
Состояние	refund.status	string	Текущее состояние проверки этого объекта.
Сумма	refund.amount_money.amount	integer	Сумма.
Валюта	refund.amount_money.currency	string	Валюта.
Идентификатор оплаты	refund.payment_id	string	Уникальный идентификатор платежа.
Идентификатор заказа	refund.order_id	string	Идентификатор заказа.
Создано в	refund.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	refund.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Плата за обработку	refund.processing_fee	array of object
Действующий в	refund.processing_fee.effective_at	string	Метка времени, когда плата вступает в силу, в формате RFC 3339.
Тип	refund.processing_fee.type	string	Указывает тип.
Сумма	refund.processing_fee.amount_money.amount	integer	Сумма.
Валюта	refund.processing_fee.amount_money.currency	string	Валюта.
Идентификатор расположения	refund.location_id	string	Идентификатор расположения.
Причина	refund.reason	string	Причина этого объекта.

Получение возврата терминала

Идентификатор операции:

TerminalGetRefund

Извлекает объект возврата терминала Interac по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор возврата терминала	terminal_refund_id	True	string	Идентификатор возврата терминала.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	refund.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор возврата	refund.refund_id	string	Уникальный идентификатор для этого возврата, созданный квадратом.
Идентификатор оплаты	refund.payment_id	string	Уникальный идентификатор платежа.
Сумма	refund.amount_money.amount	integer	Сумма.
Валюта	refund.amount_money.currency	string	Валюта.
Причина	refund.reason	string	Причина этого объекта.
Идентификатор устройства	refund.device_id	string	Уникальный идентификатор устройства, предназначенного для этого terminalRefund.
Срок действия	refund.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Состояние	refund.status	string	Текущее состояние проверки этого объекта.
Создано в	refund.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	refund.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	refund.app_id	string	Идентификатор приложения, создавшего выход.
Бренд карточки	refund.card.card_brand	string	Бренд карточки.
last_4	refund.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	refund.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	refund.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	refund.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	refund.card.card_type	string	Тип карточки.
БУНКЕР	refund.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Идентификатор заказа	refund.order_id	string	Идентификатор заказа.
Идентификатор расположения	refund.location_id	string	Идентификатор расположения.

Получение группы клиентов

Идентификатор операции:

CustomerGroupRetrieve

Извлекает определенную группу клиентов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	group_id	True	string	Идентификатор группы.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	group.id	string	Уникальный идентификатор, выданный квадратом.
Имя	group.name	string	Имя объекта.
Создано в	group.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	group.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.

Получение доказательств спора

Идентификатор операции:

DisputeRetrieveEvidence

Возвращает метаданные доказательства, указанные идентификатором доказательства в пути URL-адреса запроса. Если вы хотите ссылаться на него позже, необходимо сохранить копию отправленных доказательств. После отправки не удается скачать доказательства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.
Идентификатор доказательства	evidence_id	True	string	Идентификатор доказательства.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	evidence.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор спора	evidence.dispute_id	string	Идентификатор спора, с которым связано свидетельство.
Filename	evidence.evidence_file.filename	string	Файлы доказательств спора должны быть форматами application/pdf, image/heic, image/heif, image/jpeg, image/png или image/tiff.
Тип файла	evidence.evidence_file.filetype	string	Имя файла, включая расширение файла.
Тип доказательства	evidence.evidence_type	string	Свидетельство типа pf.
Отправлено по адресу	evidence.uploaded_at	string	Время выполнения следующего действия в формате RFC 3339.

Получение заказа

Идентификатор операции:

OrderRetrieve

Извлекает заказ по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор заказа	order_id	True	string	Идентификатор заказа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	order.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Элементы строки	order.line_items	array of object
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Сумма	order.line_items.variation_total_price_money.amount	integer	Сумма.
Валюта	order.line_items.variation_total_price_money.currency	string	Валюта.
Примененные скидки	order.line_items.applied_discounts	array of object
ИД пользователя	order.line_items.applied_discounts.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс скидки	order.line_items.applied_discounts.discount_uid	string	Пользовательский интерфейс скидки, представляющей примененную скидку.
Сумма	order.line_items.applied_discounts.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_discounts.applied_money.currency	string	Валюта.
Скидки	order.discounts	array of object
ИД пользователя	order.discounts.uid	string	Идентификатор, созданный квадратом.
Имя	order.discounts.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент	order.discounts.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.discounts.applied_money.amount	integer	Сумма.
Валюта	order.discounts.applied_money.currency	string	Валюта.
Тип	order.discounts.type	string	Указывает тип.
Scope	order.discounts.scope	string	Указывает текущий уровень.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Государство	order.state	string	Текущее состояние.
Версия	order.version	integer	Текущая версия этого объекта.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Сумма	order.total_tip_money.amount	integer	Сумма.
Валюта	order.total_tip_money.currency	string	Валюта.
Сумма	order.total_money.amount	integer	Сумма.
Валюта	order.total_money.currency	string	Валюта.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.tip_money.amount	integer	Сумма.
Валюта	order.net_amounts.tip_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.

Получение извлечений терминала

Идентификатор операции:

TerminalGetCheckout

Извлекает запрос на извлечение терминала по checkout_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор выхода	checkout_id	True	string	Идентификатор извлечений.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	checkout.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	checkout.amount_money.amount	integer	Сумма.
Валюта	checkout.amount_money.currency	string	Валюта.
Идентификатор ссылки	checkout.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Замечание	checkout.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор устройства	checkout.device_options.device_id	string	Уникальный идентификатор устройства, предназначенного для этого терминалаCheckout.
Разрешить подсказку	checkout.device_options.tip_settings.allow_tipping	boolean	Указывает, включена ли подсказка для этого выхода. По умолчанию false.
Экран пропуска квитанций	checkout.device_options.skip_receipt_screen	boolean	Указывает устройству пропустить экран получения. По умолчанию false.
Состояние	checkout.status	string	Текущее состояние проверки этого объекта.
Создано в	checkout.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	checkout.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	checkout.app_id	string	Идентификатор приложения, создавшего выход.
Срок действия	checkout.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания

Получение карточки

Идентификатор операции:

CardRetrieve

Извлекает сведения для конкретной карточки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор карточки	card_id	True	string	Идентификатор карточки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	card.id	string	Уникальный идентификатор, выданный квадратом.
Адресная строка 1	card.billing_address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	card.billing_address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	card.billing_address.locality	string	Город или город адреса.
Административный район 1	card.billing_address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	card.billing_address.postal_code	string	Почтовый индекс адреса.
Страна	card.billing_address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Отпечаток	card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
БУНКЕР	card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Бренд карточки	card.card_brand	string	Бренд карты.
Тип карточки	card.card_type	string	Тип карточки.
Имя заполнителя карточки	card.cardholder_name	string	Имя заполнителя карточки.
Идентификатор клиента	card.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Включен	card.enabled	boolean	Включена ли функция.
Месяц Exp	card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	card.exp_year	integer	Четырехзначный год срока действия карты.
Последние 4	card.last_4	string	Последние 4 цифры номера карточки.
Предоплаченный тип	card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
Идентификатор ссылки	card.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Версия	card.version	integer	Текущая версия этого объекта.

Получение клиента

Идентификатор операции:

CustomerRetrieve

Возвращает сведения для одного клиента.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор клиента	customer_id	True	string	Идентификатор клиента.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	customer.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	customer.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	customer.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Заданное имя	customer.given_name	string	Указанное имя (т. е. имя, связанное с профилем клиента).
Фамилия	customer.family_name	string	Семейство (т. е. фамилия), связанное с профилем клиента.
Электронная почта	customer.email_address	string	Адрес электронной почты, связанный с профилем клиента.
Адресная строка 1	customer.address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	customer.address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	customer.address.locality	string	Город или город адреса.
Административный район 1	customer.address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	customer.address.postal_code	string	Почтовый индекс адреса.
Страна	customer.address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Номер телефона	customer.phone_number	string	11-значный номер телефона, связанный с профилем клиента.
Идентификатор ссылки	customer.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Замечание	customer.note	string	Настраиваемая заметка, связанная с профилем клиента.
Отмена подписки по электронной почте	customer.preferences.email_unsubscribed	boolean	Указывает, отменяет ли клиент подписку на сообщения электронной почты маркетинговой кампании. Значение true означает, что клиент решил отказаться от маркетинга электронной почты от текущего продавца Квадрата или от всех продавцов Квадрата.
Источник создания	customer.creation_source	string	Источник создания представляет метод, используемый для создания профиля клиента.
Идентификаторы групп	customer.group_ids	array of string
Идентификаторы сегментов	customer.segment_ids	array of string
Версия	customer.version	integer	Текущая версия этого объекта.

Получение корректировки инвентаризации

Идентификатор операции:

InventoryRetrieveAdjustment

Возвращает объект InventoryAdjustment с предоставленным adjustment_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор корректировки	adjustment_id	True	string	Идентификатор корректировки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	adjustment.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор ссылки	adjustment.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Из состояния	adjustment.from_state	string	Состояние инвентаризации связанного количества элементов перед корректировкой.
Состояние	adjustment.to_state	string	Состояние инвентаризации связанного количества элементов после корректировки.
Идентификатор расположения	adjustment.location_id	string	Идентификатор расположения.
Идентификатор объекта каталога	adjustment.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	adjustment.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Количество	adjustment.quantity	string	Количество элементов, затронутых корректировкой в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Сумма	adjustment.total_price_money.amount	integer	Сумма.
Валюта	adjustment.total_price_money.currency	string	Валюта.
Произошло в	adjustment.occurred_at	string	Метка времени, созданная клиентом в формате RFC 3339, указывающая, когда произошла корректировка инвентаризации. Для обновлений корректировки инвентаризации метка времени occurred_at не может быть старше 24 часов или в будущем относительно времени запроса.
Создано в	adjustment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Продукт	adjustment.source.product	string	Тип продукта для приложения.
Идентификатор приложения	adjustment.source.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Имя	adjustment.source.name	string	Имя.
Идентификатор сотрудника	adjustment.employee_id	string	Созданный квадратным идентификатором сотрудника.

Получение объекта каталога

Идентификатор операции:

CatalogRetrieve

Возвращает один catalogItem в качестве каталогаObject на основе предоставленного идентификатора. Возвращаемый объект включает все соответствующие сведения CatalogItem, включая дочерние элементы CatalogItemVariation, ссылки на объекты CatalogModifierList и идентификаторы всех объектов CatalogTax, применяемых к нему.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код объекта	object_id	True	string	Идентификатор объекта.
Включение связанных объектов	include_related_objects		boolean	Если значение true, ответ будет содержать дополнительные объекты, связанные с запрошенным объектом, как показано ниже: если поле объекта ответа содержит CatalogItem, его связанные объекты CatalogCategory, CatalogTax, CatalogImage и CatalogModifierList будут возвращены в поле related_objects ответа. Если поле объекта ответа содержит catalogItemVariation, его родительский CatalogItem будет возвращен в поле related_objects ответа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Тип	object.type	string	Тип этого объекта.
Идентификатор	object.id	string	Уникальный идентификатор, выданный квадратом.
Обновлено в	object.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Версия	object.version	integer	Текущая версия этого объекта.
Удаляется	object.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
present_at_all_locations	object.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Имя	object.item_data.name	string	Имя.
Description	object.item_data.title	string	Описание элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Идентификатор категории	object.item_data.category_id	string	Идентификатор категории элемента, если он есть.
Идентификаторы налогоплательщика	object.item_data.tax_ids	array of string
Варианты	object.item_data.variations	array of object
Тип	object.item_data.variations.type	string	Тип этого объекта.
Идентификатор	object.item_data.variations.id	string	Идентификатор для ссылки на этот объект в каталоге.
Обновлено в	object.item_data.variations.updated_at	string	Метка времени последнего изменения в формате RFC 3339.
Версия	object.item_data.variations.version	integer	Версия объекта. При обновлении объекта указанная версия должна соответствовать версии в базе данных, в противном случае запись будет отклонена как конфликтующая.
Удаляется	object.item_data.variations.is_deleted	boolean	Если значение true, объект был удален из базы данных. Значение false для вставляемых новых объектов. При удалении поле updated_at равно времени удаления.
Присутствует во всех расположениях	object.item_data.variations.present_at_all_locations	boolean	Если значение true, этот объект присутствует во всех расположениях (включая будущие расположения), за исключением того, где указано в поле absent_at_location_ids. Если значение false, этот объект не присутствует в каких-либо расположениях (включая будущие расположения), за исключением того, где указано в поле present_at_location_ids. Если значение не указано, значение по умолчанию имеет значение true.
Идентификатор элемента	object.item_data.variations.item_variation_data.item_id	string	Идентификатор каталогаItem, связанный с этим вариантом элемента.
Имя	object.item_data.variations.item_variation_data.name	string	Имя варианта элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, и его длина значения имеет кодовые точки Юникода.
Порядковый	object.item_data.variations.item_variation_data.ordinal	integer	Порядок отображения вариантов этого элемента. Это значение доступно только для чтения. При записи порядковый номер для каждого варианта элемента в родительском CatalogItem устанавливается в соответствии с положением вариантов элемента. При чтении значение не гарантируется последовательным или уникальным.
Тип ценообразования	object.item_data.variations.item_variation_data.pricing_type	string	Указывает, является ли цена варианта элемента фиксированной или определенной во время продажи.
Сумма	object.item_data.variations.item_variation_data.price_money.amount	integer	Сумма.
Валюта	object.item_data.variations.item_variation_data.price_money.currency	string	Валюта.

Получение оплаты

Идентификатор операции:

PaymentGet

Извлекает сведения о конкретном платеже.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оплаты	payment_id	True	string	Идентификатор платежа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	payment.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	payment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	payment.amount_money.amount	integer	Сумма.
Валюта	payment.amount_money.currency	string	Валюта.
Состояние	payment.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payment.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу. Эта автоматическая delay_action применяется только к платежам, которые не достигают состояния терминала (COMPLETED, CANCELED или FAILED) до периода времени delay_duration. Это поле указывается в формате RFC 3339.
Тип источника	payment.source_type	string	Исходный тип для этого платежа. Текущие значения включают CARD, BANK_ACCOUNT, WALLET, CASH или EXTERNAL.
Состояние	payment.card_details.status	string	Текущее состояние.
Бренд карточки	payment.card_details.card.card_brand	string	Бренд карты.
Последние 4	payment.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payment.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payment.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payment.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payment.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payment.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payment.card_details.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Метод Entry	payment.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние CVV	payment.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние AVS	payment.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payment.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payment.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payment.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Записано в	payment.card_details.card_payment_timeline.captured_at	string	Метка времени записи платежа в формате RFC 3339.
Идентификатор расположения	payment.location_id	string	Идентификатор расположения.
Идентификатор заказа	payment.order_id	string	Идентификатор заказа.
Плата за обработку	payment.processing_fee	array of object
Действующий в	payment.processing_fee.effective_at	string	Метка времени, когда плата вступает в силу, в формате RFC 3339.
Тип	payment.processing_fee.type	string	Указывает тип.
Сумма	payment.processing_fee.amount_money.amount	integer	Сумма.
Валюта	payment.processing_fee.amount_money.currency	string	Валюта.
Замечание	payment.note	string	Настраиваемая заметка, связанная с профилем клиента.
Сумма	payment.total_money.amount	integer	Сумма.
Валюта	payment.total_money.currency	string	Валюта.
Сумма	payment.approved_money.amount	integer	Сумма.
Валюта	payment.approved_money.currency	string	Валюта.
Идентификатор сотрудника	payment.employee_id	string	Созданный квадратным идентификатором сотрудника.
Номер квитанции	payment.receipt_number	string	Номер квитанции платежа. Поле отсутствует, если платеж отменен.
URL-адрес квитанции	payment.receipt_url	string	URL-адрес квитанции платежа. Поле заполняется только для оплаты COMPLETED.
Действие по задержке	payment.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payment.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Идентификатор участника группы	payment.team_member_id	string	Идентификатор члена команды.
Квадратный продукт	payment.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payment.application_details.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Маркер версии	payment.version_token	string	Этот непрозрачный маркер определяет определенную версию объекта.

Получение передачи инвентаризации (бета-версия)

Идентификатор операции:

InventoryRetrieveTransfer

Возвращает объект InventoryTransfer с предоставленным transfer_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор трансфера	transfer_id	True	string	Идентификатор передачи.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	transfer.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор объекта каталога	transfer.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	transfer.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Создано в	transfer.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Идентификатор сотрудника	transfer.employee_id	string	Созданный квадратным идентификатором сотрудника.
Идентификатор расположения	transfer.from_location_id	string	Созданный квадрат идентификатор расположения, где связанное количество элементов отслеживалось перед передачей.
Идентификатор расположения	transfer.to_location_id	string	Созданный квадрат идентификатор расположения, где связанное количество элементов отслеживалось после передачи.
Произошло в	transfer.occurred_at	string	Метка времени, созданная клиентом в формате RFC 3339, указывающая, когда произошла корректировка инвентаризации. Для обновлений корректировки инвентаризации метка времени occurred_at не может быть старше 24 часов или в будущем относительно времени запроса.
Количество	transfer.quantity	string	Количество элементов, затронутых корректировкой в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Идентификатор ссылки	transfer.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Продукт	transfer.source.product	string	Тип продукта для приложения.
Идентификатор приложения	transfer.source.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Имя	transfer.source.name	string	Имя.
Государство	transfer.state	string	Текущее состояние.

Получение подписки

Идентификатор операции:

SubscriptionRetrieve

Извлекает подписку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscription_id	True	string	Идентификатор подписки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	subscription.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscription.location_id	string	Идентификатор расположения.
Идентификатор плана	subscription.plan_id	string	Идентификатор связанного плана подписки.
Идентификатор клиента	subscription.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Дата начала	subscription.start_date	string	Дата начала подписки в формате YYY-MM-DD.
Оплата по дате	subscription.charged_through_date	string	Дата, в которой клиент выставляется счет за подписку, в формате YYY-MM-DD.
Состояние	subscription.status	string	Текущее состояние проверки этого объекта.
Идентификаторы счетов	subscription.invoice_ids	array of string
Сумма	subscription.price_override_money.amount	integer	Сумма.
Валюта	subscription.price_override_money.currency	string	Валюта.
Создано в	subscription.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Оплата до даты	subscription.paid_until_date	string	Дата, доплачиваемая.
Timezone	subscription.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscription.source.name	string	Имя.

Получение сегмента клиента

Идентификатор операции:

CustomerSegmentRetrieve

Извлекает определенный сегмент клиента.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сегмента	segment_id	True	string	Идентификатор сегмента.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	segment.id	string	Уникальный идентификатор, выданный квадратом.
Имя	segment.name	string	Имя объекта.
Создано в	segment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	segment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.

Получение спора

Идентификатор операции:

DisputeRetrieve

Возвращает сведения о конкретном споре.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	dispute.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	dispute.amount_money.amount	integer	Сумма.
Валюта	dispute.amount_money.currency	string	Валюта.
Причина	dispute.reason	string	Причина этого объекта.
Государство	dispute.state	string	Текущее состояние.
Из-за	dispute.due_at	string	Время выполнения следующего действия в формате RFC 3339.
Спорные платежи	dispute.disputed_payments	array of object
Идентификатор оплаты	dispute.disputed_payments.payment_id	string	Квадратный созданный уникальный идентификатор оплаты.
Бренд карточки	dispute.card_brand	string	Бренд карты.
Создано в	dispute.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	dispute.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор спора бренда	dispute.brand_dispute_id	string	Идентификатор спора в системе фирменной марки карты, созданной брендом карты.

Получение счета

Идентификатор операции:

InvoiceGet

Извлекает счет по идентификатору счета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер счета	invoice_id	True	string	Идентификатор счета.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	invoice.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoice.version	integer	Текущая версия этого объекта.
Идентификатор расположения	invoice.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoice.order_id	string	Идентификатор заказа.
Запросы на оплату	invoice.payment_requests	array of object
ИД пользователя	invoice.payment_requests.uid	string	Идентификатор, созданный квадратом.
Тип запроса	invoice.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoice.payment_requests.due_date	string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	invoice.payment_requests.tipping_enabled	boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Напоминания	invoice.payment_requests.reminders	array of object
ИД пользователя	invoice.payment_requests.reminders.uid	string	Идентификатор, назначенный квадратом.
Относительные запланированные дни	invoice.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoice.payment_requests.reminders.message	string	Сообщение.
Состояние	invoice.payment_requests.reminders.status	string	Текущее состояние.
Сумма	invoice.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoice.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoice.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Номер счета	invoice.invoice_number	string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	invoice.title	string	Заголовок.
Description	invoice.description	string	Описание.
Запланированное в	invoice.scheduled_at	string	Метка времени при планировании обработки в формате RFC 3339.
Состояние	invoice.status	string	Текущее состояние проверки этого объекта.
Timezone	invoice.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoice.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	invoice.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор клиента	invoice.primary_recipient.customer_id	string	Идентификатор клиента, связанного с заказом.
Заданное имя	invoice.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoice.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoice.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoice.primary_recipient.phone_number	string	Номер телефона получателя.
Card	invoice.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoice.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoice.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoice.custom_fields	array of object
Этикетка	invoice.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoice.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoice.custom_fields.placement	string	Расположение настраиваемого поля в счете.
Метод доставки	invoice.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Дата продажи или обслуживания	invoice.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Получение счетчика инвентаризации

Идентификатор операции:

InventoryRetrieveCount

Извлекает текущее вычисляемое количество акций для заданного каталогаObject в заданном наборе расположений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор объекта каталога	catalog_object_id	True	string	Идентификатор объекта каталога.
Идентификаторы расположения	location_ids		string	Идентификаторы расположения для поиска в виде разделенного запятыми списка. Пустой список запрашивает все расположения.
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Рассчитывает	counts	array of object
Идентификатор объекта каталога	counts.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	counts.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Государство	counts.state	string	Текущее состояние.
Идентификатор расположения	counts.location_id	string	Идентификатор расположения.
Количество	counts.quantity	string	Количество элементов, затронутых предполагаемым числом в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Вычисляется по адресу	counts.calculated_at	string	Метка времени в формате RFC 3339, указывающая, когда получено последнее физическое число или корректировка, влияющая на предполагаемое число.

Получение физического количества инвентаризаций

Идентификатор операции:

InventoryRetrievePhysicalCount

Возвращает объект InventoryPhysicalCount с предоставленным physical_count_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор физического подсчета	physical_count_id	True	string	Идентификатор физического счетчика.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	count.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор ссылки	count.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Идентификатор объекта каталога	count.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Тип объекта каталога	count.catalog_object_type	string	Тип отслеживаемого объекта CatalogObject.
Государство	count.state	string	Текущее состояние.
Идентификатор расположения	count.location_id	string	Идентификатор расположения.
Количество	count.quantity	string	Количество элементов, затронутых корректировкой в виде десятичной строки. Может поддерживать до 5 цифр после десятичной запятой.
Продукт	count.source.product	string	Тип продукта для приложения.
Идентификатор приложения	count.source.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Имя	count.source.name	string	Имя.
Идентификатор сотрудника	count.employee_id	string	Созданный квадратным идентификатором сотрудника.
Произошло в	count.occurred_at	string	Метка времени, созданная клиентом в формате RFC 3339, указывающая, когда произошла корректировка инвентаризации. Для обновлений корректировки инвентаризации метка времени occurred_at не может быть старше 24 часов или в будущем относительно времени запроса.
Создано в	count.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.

Порядок клонирования (бета-версия)

Идентификатор операции:

OrderClone

Создает новый порядок в состоянии DRAFT путем дедупликации существующего заказа. Только что созданный заказ содержит только основные поля (например, элементы строки, налоги и скидки), скопированные из исходного заказа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор заказа	order_id		string	Идентификатор заказа.
Версия	version		integer	Версия.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	order.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Элементы строки	order.line_items	array of object
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Примененные налоги	order.line_items.applied_taxes	array of object
ИД пользователя	order.line_items.applied_taxes.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс налога	order.line_items.applied_taxes.tax_uid	string	UiD налога, для которого этот примененный налог представляет.
Сумма	order.line_items.applied_taxes.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_taxes.applied_money.currency	string	Валюта.
Примененные скидки	order.line_items.applied_discounts	array of object
ИД пользователя	order.line_items.applied_discounts.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс скидки	order.line_items.applied_discounts.discount_uid	string	Пользовательский интерфейс скидки, представляющей примененную скидку.
Сумма	order.line_items.applied_discounts.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_discounts.applied_money.currency	string	Валюта.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Сумма	order.line_items.variation_total_price_money.amount	integer	Сумма.
Валюта	order.line_items.variation_total_price_money.currency	string	Валюта.
Идентификатор объекта каталога	order.line_items.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Имя варианта	order.line_items.variation_name	string	Имя варианта, примененного к этому элементу строки.
Модификаторы	order.line_items.modifiers	array of object
ИД пользователя	order.line_items.modifiers.uid	string	Идентификатор, назначенный квадратом.
Идентификатор объекта каталога	order.line_items.modifiers.catalog_object_id	string	Идентификатор объекта каталога.
Имя	order.line_items.modifiers.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	order.line_items.modifiers.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.modifiers.base_price_money.currency	string	Валюта.
Сумма	order.line_items.modifiers.total_price_money.amount	integer	Сумма.
Валюта	order.line_items.modifiers.total_price_money.currency	string	Валюта.
Налоги	order.taxes	array of object
ИД пользователя	order.taxes.uid	string	Идентификатор, созданный квадратом.
Имя	order.taxes.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Тип	order.taxes.type	string	Указывает тип.
Процент	order.taxes.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.taxes.applied_money.amount	integer	Сумма.
Валюта	order.taxes.applied_money.currency	string	Валюта.
Scope	order.taxes.scope	string	Указывает текущий уровень.
Скидки	order.discounts	array of object
ИД пользователя	order.discounts.uid	string	Идентификатор, созданный квадратом.
Идентификатор объекта каталога	order.discounts.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Имя	order.discounts.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Тип	order.discounts.type	string	Указывает тип.
Процент	order.discounts.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.discounts.applied_money.amount	integer	Сумма.
Валюта	order.discounts.applied_money.currency	string	Валюта.
Scope	order.discounts.scope	string	Указывает текущий уровень.
Сумма	order.discounts.amount_money.amount	integer	Сумма.
Валюта	order.discounts.amount_money.currency	string	Валюта.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Государство	order.state	string	Текущее состояние.
Версия	order.version	integer	Текущая версия этого объекта.
Идентификатор ссылки	order.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Сумма	order.total_money.amount	integer	Сумма.
Валюта	order.total_money.currency	string	Валюта.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Сумма	order.total_tip_money.amount	integer	Сумма.
Валюта	order.total_tip_money.currency	string	Валюта.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.tip_money.amount	integer	Сумма.
Валюта	order.net_amounts.tip_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.
Имя	order.source.name	string	Имя.

Порядок обновления (бета-версия)

Идентификатор операции:

OrderUpdate

Обновляет открытый заказ, добавляя, заменяя или удаляя поля. Не удается обновить заказы с состоянием COMPLETED или CANCELED.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор заказа	order_id	True	string	Идентификатор заказа.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Версия	version		integer	Текущая версия этого объекта.
ИД пользователя	uid		string	Идентификатор, созданный квадратом.
Количество	quantity		string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Поля для очистки	fields_to_clear		array of string

Возвращаемое значение

Имя	Путь	Тип	Описание
Версия	order.version	integer	Текущая версия этого объекта.
Валюта	order.total_money.currency	string	Валюта.
Сумма	order.total_money.amount	integer	Сумма.
Имя	order.source.name	string	Имя.
Элементы строки	order.line_items	array of object
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Сумма	order.line_items.variation_total_price_money.amount	integer	Сумма.
Валюта	order.line_items.variation_total_price_money.currency	string	Валюта.
Государство	order.state	string	Текущее состояние.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Идентификатор	order.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.

Принятие спора

Идентификатор операции:

DisputeAccept

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	dispute.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	dispute.amount_money.amount	integer	Сумма.
Валюта	dispute.amount_money.currency	string	Валюта.
Причина	dispute.reason	string	Причина этого объекта.
Государство	dispute.state	string	Текущее состояние.
Из-за	dispute.due_at	string	Время выполнения следующего действия в формате RFC 3339.
Спорные платежи	dispute.disputed_payments	array of object
Идентификатор оплаты	dispute.disputed_payments.payment_id	string	Квадратный созданный уникальный идентификатор оплаты.
Бренд карточки	dispute.card_brand	string	Бренд карты.
Создано в	dispute.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	dispute.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор спора бренда	dispute.brand_dispute_id	string	Идентификатор спора в системе фирменной марки карты, созданной брендом карты.

Публикация счета

Идентификатор операции:

InvoicePublish

Публикует указанный черновик счета. После публикации счета Квадрат следует на основе конфигурации счета. Например, Square отправляет счет по адресу электронной почты клиента, взимает плату за карточку клиента в файле или ничего не делает. Квадрат также предоставляет счет на странице счета с квадратным размещением.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер счета	invoice_id	True	string	Идентификатор счета.
Версия	version		integer	Версия.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	invoice.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoice.version	integer	Текущая версия этого объекта.
Идентификатор расположения	invoice.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoice.order_id	string	Идентификатор заказа.
Запросы на оплату	invoice.payment_requests	array of object
ИД пользователя	invoice.payment_requests.uid	string	Идентификатор, созданный квадратом.
Тип запроса	invoice.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoice.payment_requests.due_date	string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	invoice.payment_requests.tipping_enabled	boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Напоминания	invoice.payment_requests.reminders	array of object
ИД пользователя	invoice.payment_requests.reminders.uid	string	Идентификатор, назначенный квадратом.
Относительные запланированные дни	invoice.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoice.payment_requests.reminders.message	string	Сообщение.
Состояние	invoice.payment_requests.reminders.status	string	Текущее состояние.
Сумма	invoice.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoice.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoice.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Номер счета	invoice.invoice_number	string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	invoice.title	string	Заголовок.
Description	invoice.description	string	Описание.
Запланированное в	invoice.scheduled_at	string	Метка времени при планировании обработки в формате RFC 3339.
Состояние	invoice.status	string	Текущее состояние проверки этого объекта.
Timezone	invoice.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoice.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	invoice.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор клиента	invoice.primary_recipient.customer_id	string	Идентификатор клиента, связанного с заказом.
Заданное имя	invoice.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoice.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoice.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoice.primary_recipient.phone_number	string	Номер телефона получателя.
Общедоступный URL-адрес	invoice.public_url	string	URL-адрес страницы счета с квадратным размещением. После публикации счета с помощью конечной точки PublishInvoice квадрат размещает страницу счета и возвращает URL-адрес страницы в ответе.
Card	invoice.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoice.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoice.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoice.custom_fields	array of object
Этикетка	invoice.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoice.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoice.custom_fields.placement	string	Расположение настраиваемого поля в счете.
Метод доставки	invoice.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Дата продажи или обслуживания	invoice.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Регистрация домена для Apple Pay

Идентификатор операции:

ApplePayRegister

Активирует домен для использования с Apple Pay в Интернете и квадрате. Проверка выполняется в этом домене Apple, чтобы убедиться, что она правильно настроена в качестве домена с поддержкой Apple Pay.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя домена	domain_name	True	string	Доменное имя, как описано в RFC-1034, которое будет зарегистрировано в Apple Pay.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние регистрации домена.

Сведения о каталоге

Идентификатор операции:

CatalogInfo

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

Возвращаемое значение

Имя	Путь	Тип	Описание
Пакетный upsert Max Objects на пакет	limits.batch_upsert_max_objects_per_batch	integer	Максимальное количество объектов, которые могут отображаться в одном пакете в запросе /v2/catalog/batch-upsert.
Пакетная upsert Max Total Objects	limits.batch_upsert_max_total_objects	integer	Максимальное количество объектов, которые могут отображаться во всех пакетах в запросе /v2/catalog/batch-upsert.
Пакетное получение идентификаторов максимальных объектов	limits.batch_retrieve_max_object_ids	integer	Максимальное количество идентификаторов объектов, которые могут отображаться в запросе /v2/catalog/batch-get.
Максимальное ограничение страницы поиска	limits.search_max_page_limit	integer	Максимальное количество результатов, которые могут быть возвращены на странице ответа /v2/catalog/search.
Идентификаторы максимальных объектов пакетного удаления	limits.batch_delete_max_object_ids	integer	Максимальное количество идентификаторов объектов, которые могут быть включены в один запрос /v2/catalog/batch-delete.
Обновление идентификаторов элементов max	limits.update_item_taxes_max_item_ids	integer	Максимальное количество идентификаторов элементов, которые могут быть включены в один запрос /v2/catalog/update-item-taxes.
Обновление налогов элементов максимальное количество налогов для включения	limits.update_item_taxes_max_taxes_to_enable	integer	Максимальное количество идентификаторов налогов, которые можно включить в один запрос на налоги /v2/catalog/update-item-tax.
Обновление налогов на элементы максимальное количество налогов, чтобы отключить	limits.update_item_taxes_max_taxes_to_disable	integer	Максимальное количество идентификаторов налогов, которые могут быть включены в один запрос на налоги /v2/catalog/update-item-tax.
Обновление модификаторов элементов содержит идентификаторы максимального числа элементов	limits.update_item_modifier_lists_max_item_ids	integer	Максимальное количество идентификаторов налогов, которые могут быть включены в один запрос на налоги /v2/catalog/update-item-tax.
Список модификаторов элементов обновления для включения	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Максимальное количество идентификаторов списков модификаторов, которые могут быть включены в один запрос /v2/catalog/update-item-modifier-list.
Обновление списков модификаторов элементов max modifier, чтобы отключить	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Максимальное количество идентификаторов списка модификаторов, которые могут быть включены в один запрос /v2/catalog/update-item-modifier-list.

Создание возврата терминала

Идентификатор операции:

TerminalCreateRefund

Создает запрос на возврат платежа Interac, завершенного на квадратном терминале.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Идентификатор устройства	device_id		string	Уникальный идентификатор устройства, предназначенного для этого terminalRefund.
Причина	reason		string	Причина этого объекта.
Идентификатор оплаты	payment_id		string	Уникальный идентификатор платежа.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	refund.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор оплаты	refund.payment_id	string	Уникальный идентификатор платежа.
Сумма	refund.amount_money.amount	integer	Сумма.
Валюта	refund.amount_money.currency	string	Валюта.
Причина	refund.reason	string	Причина этого объекта.
Идентификатор устройства	refund.device_id	string	Уникальный идентификатор устройства, предназначенного для этого terminalRefund.
Срок действия	refund.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Состояние	refund.status	string	Текущее состояние проверки этого объекта.
Создано в	refund.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	refund.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	refund.app_id	string	Идентификатор приложения, создавшего выход.
Бренд карточки	refund.card.card_brand	string	Бренд карточки.
last_4	refund.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	refund.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	refund.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	refund.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	refund.card.card_type	string	Тип карточки.
БУНКЕР	refund.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Идентификатор заказа	refund.order_id	string	Идентификатор заказа.
Идентификатор расположения	refund.location_id	string	Идентификатор расположения.

Создание группы клиентов

Идентификатор операции:

CustomGroupCreate

Создает новую группу клиентов для бизнеса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name		string	Имя объекта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	group.id	string	Уникальный идентификатор, выданный квадратом.
Имя	group.name	string	Имя объекта.
Создано в	group.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	group.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.

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

Идентификатор операции:

OrderCreate

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор ссылки	reference_id		string	Необязательный идентификатор ссылки, определенный пользователем.
Идентификатор расположения	location_id		string	Идентификатор расположения.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Количество	quantity		string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Идентификатор объекта каталога	catalog_object_id		string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Идентификатор объекта каталога	catalog_object_id		string	Идентификатор объекта каталога.
Пользовательский интерфейс скидки	discount_uid		string	Пользовательский интерфейс скидки, представляющей примененную скидку.
ИД пользователя	uid		string	Идентификатор, созданный квадратом.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент	percentage		string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Scope	scope		string	Указывает текущий уровень.
ИД пользователя	uid		string	Идентификатор, созданный квадратом.
Имя	name		string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Процент	percentage		string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Scope	scope		string	Указывает текущий уровень.
Идентификатор объекта каталога	catalog_object_id		string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	order.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	order.location_id	string	Идентификатор расположения.
Элементы строки	order.line_items	array of object
ИД пользователя	order.line_items.uid	string	Идентификатор, созданный квадратом.
Имя	order.line_items.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Количество	order.line_items.quantity	string	Количество элементов, затронутых физическим числом в виде десятичной строки. Число может поддерживать до 5 цифр после десятичной запятой.
Примененные налоги	order.line_items.applied_taxes	array of object
ИД пользователя	order.line_items.applied_taxes.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс налога	order.line_items.applied_taxes.tax_uid	string	UiD налога, для которого этот примененный налог представляет.
Сумма	order.line_items.applied_taxes.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_taxes.applied_money.currency	string	Валюта.
Примененные скидки	order.line_items.applied_discounts	array of object
ИД пользователя	order.line_items.applied_discounts.uid	string	Идентификатор, назначенный квадратом.
Пользовательский интерфейс скидки	order.line_items.applied_discounts.discount_uid	string	Пользовательский интерфейс скидки, представляющей примененную скидку.
Сумма	order.line_items.applied_discounts.applied_money.amount	integer	Сумма.
Валюта	order.line_items.applied_discounts.applied_money.currency	string	Валюта.
Сумма	order.line_items.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.base_price_money.currency	string	Валюта.
Сумма	order.line_items.gross_sales_money.amount	integer	Сумма.
Валюта	order.line_items.gross_sales_money.currency	string	Валюта.
Сумма	order.line_items.total_tax_money.amount	integer	Сумма.
Валюта	order.line_items.total_tax_money.currency	string	Валюта.
Сумма	order.line_items.total_discount_money.amount	integer	Сумма.
Валюта	order.line_items.total_discount_money.currency	string	Валюта.
Сумма	order.line_items.total_money.amount	integer	Сумма.
Валюта	order.line_items.total_money.currency	string	Валюта.
Сумма	order.line_items.variation_total_price_money.amount	integer	Сумма.
Валюта	order.line_items.variation_total_price_money.currency	string	Валюта.
Идентификатор объекта каталога	order.line_items.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Имя варианта	order.line_items.variation_name	string	Имя варианта, примененного к этому элементу строки.
Модификаторы	order.line_items.modifiers	array of object
ИД пользователя	order.line_items.modifiers.uid	string	Идентификатор, назначенный квадратом.
Идентификатор объекта каталога	order.line_items.modifiers.catalog_object_id	string	Идентификатор объекта каталога.
Имя	order.line_items.modifiers.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Сумма	order.line_items.modifiers.base_price_money.amount	integer	Сумма.
Валюта	order.line_items.modifiers.base_price_money.currency	string	Валюта.
Сумма	order.line_items.modifiers.total_price_money.amount	integer	Сумма.
Валюта	order.line_items.modifiers.total_price_money.currency	string	Валюта.
Налоги	order.taxes	array of object
ИД пользователя	order.taxes.uid	string	Идентификатор, созданный квадратом.
Имя	order.taxes.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Тип	order.taxes.type	string	Указывает тип.
Процент	order.taxes.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.taxes.applied_money.amount	integer	Сумма.
Валюта	order.taxes.applied_money.currency	string	Валюта.
Scope	order.taxes.scope	string	Указывает текущий уровень.
Скидки	order.discounts	array of object
ИД пользователя	order.discounts.uid	string	Идентификатор, созданный квадратом.
Идентификатор объекта каталога	order.discounts.catalog_object_id	string	Созданный квадрат идентификатор отслеживаемого объекта CatalogObject.
Имя	order.discounts.name	string	Имя элемента. Это атрибут, доступный для поиска для использования в применимых фильтрах запросов, его значение не должно быть пустым, а длина — точек кода Юникода.
Тип	order.discounts.type	string	Указывает тип.
Процент	order.discounts.percentage	string	Процент в десятичной форме с использованием "." в качестве десятичного разделителя и без знака "%". Значение 7,5 соответствует 7,5%.
Сумма	order.discounts.applied_money.amount	integer	Сумма.
Валюта	order.discounts.applied_money.currency	string	Валюта.
Scope	order.discounts.scope	string	Указывает текущий уровень.
Сумма	order.discounts.amount_money.amount	integer	Сумма.
Валюта	order.discounts.amount_money.currency	string	Валюта.
Создано в	order.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	order.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Государство	order.state	string	Текущее состояние.
Версия	order.version	integer	Текущая версия этого объекта.
Идентификатор ссылки	order.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Сумма	order.total_money.amount	integer	Сумма.
Валюта	order.total_money.currency	string	Валюта.
Сумма	order.total_tax_money.amount	integer	Сумма.
Валюта	order.total_tax_money.currency	string	Валюта.
Сумма	order.total_discount_money.amount	integer	Сумма.
Валюта	order.total_discount_money.currency	string	Валюта.
Сумма	order.total_tip_money.amount	integer	Сумма.
Валюта	order.total_tip_money.currency	string	Валюта.
Сумма	order.total_service_charge_money.amount	integer	Сумма.
Валюта	order.total_service_charge_money.currency	string	Валюта.
Сумма	order.net_amounts.total_money.amount	integer	Сумма.
Валюта	order.net_amounts.total_money.currency	string	Валюта.
Сумма	order.net_amounts.tax_money.amount	integer	Сумма.
Валюта	order.net_amounts.tax_money.currency	string	Валюта.
Сумма	order.net_amounts.discount_money.amount	integer	Сумма.
Валюта	order.net_amounts.discount_money.currency	string	Валюта.
Сумма	order.net_amounts.tip_money.amount	integer	Сумма.
Валюта	order.net_amounts.tip_money.currency	string	Валюта.
Сумма	order.net_amounts.service_charge_money.amount	integer	Сумма.
Валюта	order.net_amounts.service_charge_money.currency	string	Валюта.
Имя	order.source.name	string	Имя.

Создание извлечений терминала

Идентификатор операции:

TerminalCreateCheckout

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Сумма	amount		integer	Сумма.
Валюта	currency		string	Валюта.
Идентификатор ссылки	reference_id		string	Необязательный идентификатор ссылки, определенный пользователем.
Идентификатор устройства	device_id		string	Уникальный идентификатор устройства, предназначенного для этого терминалаCheckout.
Замечание	note		string	Настраиваемая заметка, связанная с профилем клиента.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	checkout.id	string	Уникальный идентификатор, выданный квадратом.
Сумма	checkout.amount_money.amount	integer	Сумма.
Валюта	checkout.amount_money.currency	string	Валюта.
Идентификатор ссылки	checkout.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Замечание	checkout.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор устройства	checkout.device_options.device_id	string	Уникальный идентификатор устройства, предназначенного для этого терминалаCheckout.
Разрешить подсказку	checkout.device_options.tip_settings.allow_tipping	boolean	Указывает, включена ли подсказка для этого выхода. По умолчанию false.
Экран пропуска квитанций	checkout.device_options.skip_receipt_screen	boolean	Указывает устройству пропустить экран получения. По умолчанию false.
Состояние	checkout.status	string	Текущее состояние проверки этого объекта.
Создано в	checkout.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	checkout.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
ИД приложения	checkout.app_id	string	Идентификатор приложения, создавшего выход.
Срок действия	checkout.deadline_duration	string	Длительность RFC 3339, после которой возврат автоматически отменяется. ТерминалCheckout, который находится В ОЖИДАНИи, автоматически отменен и имеет причину отмены TIMED_OUT. Значение по умолчанию: 5 минут после создания
Тип оплаты	checkout.payment_type	string	Тип оплаты терминала должен пытаться записать из. По умолчанию используется CARD_PRESENT.

Создание карточки

Идентификатор операции:

CardCreate

Добавляет карточку в файл к существующему продавцу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Ключ идемпотентности.
Исходный идентификатор	source_id		string	Идентификатор источника.
Адресная строка 1	address_line_1		string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	address_line_2		string	Вторая строка адреса, если она есть.
Местность	locality		string	Город или город адреса.
Административный район 1	administrative_district_level_1		string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	postal_code		string	Почтовый индекс адреса.
Страна	country		string	Страна адреса в формате ISO 3166-1-alpha-2.
Имя заполнителя карточки	cardholder_name		string	Имя заполнителя карточки.
Идентификатор клиента	customer_id		string	Идентификатор этого объекта, представляющего клиента.
Идентификатор ссылки	reference_id		string	Необязательный идентификатор ссылки, определенный пользователем.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	card.id	string	Уникальный идентификатор, выданный квадратом.
Адресная строка 1	card.billing_address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	card.billing_address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	card.billing_address.locality	string	Город или город адреса.
Административный район 1	card.billing_address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	card.billing_address.postal_code	string	Почтовый индекс адреса.
Страна	card.billing_address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Отпечаток	card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
БУНКЕР	card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Бренд карточки	card.card_brand	string	Бренд карты.
Тип карточки	card.card_type	string	Тип карточки.
Имя заполнителя карточки	card.cardholder_name	string	Имя заполнителя карточки.
Идентификатор клиента	card.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Включен	card.enabled	boolean	Включена ли функция.
Месяц Exp	card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	card.exp_year	integer	Четырехзначный год срока действия карты.
Последние 4	card.last_4	string	Последние 4 цифры номера карточки.
Предоплаченный тип	card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
Идентификатор ссылки	card.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Версия	card.version	integer	Текущая версия этого объекта.

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

Идентификатор операции:

CustomerCreate

Создает нового клиента для бизнеса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заданное имя	given_name		string	Заданное имя (то есть имя), связанное с профилем клиента.
Фамилия	family_name		string	Имя семейства (то есть фамилия), связанное с профилем клиента.
Электронная почта	email_address		string	Адрес электронной почты, связанный с профилем клиента.
Название компании	company_name		string	Бизнес-имя, связанное с профилем клиента.
Nickname	nickname		string	Псевдоним профиля клиента.
Адресная строка 1	address_line_1		string	Первая строка адреса.
Строка адреса 2	address_line_2		string	Вторая строка адреса, если она есть.
Местность	locality		string	Город или город адреса.
Административный район 1	administrative_district_level_1		string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	postal_code		string	Почтовый индекс адреса.
Страна	country		string	Код страны ISO 3166 Alpha-2.
Номер телефона	phone_number		string	11-значный номер телефона, связанный с профилем клиента.
Идентификатор ссылки	reference_id		string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Замечание	note		string	Настраиваемая заметка, связанная с профилем клиента.
День рождения	birthday		string	День рождения, связанный с профилем клиента, в формате RFC 3339. Год необязателен. Часовой пояс и время запрещены. Например, 0000-09-21T00:00:00-00:00 представляет день рождения 21 сентября и 1998-09-21T00:00:00-00:00:00:00 представляет день рождения 21 сентября 1998 года. Вы также можете указать это значение в формате YYYY-MM-DD.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	customer.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	customer.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	customer.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Заданное имя	customer.given_name	string	Указанное имя (т. е. имя, связанное с профилем клиента).
Фамилия	customer.family_name	string	Семейство (т. е. фамилия), связанное с профилем клиента.
Электронная почта	customer.email_address	string	Адрес электронной почты, связанный с профилем клиента.
Название компании	customer.company_name	string	Бизнес-имя, связанное с профилем клиента.
Nickname	customer.nickname	string	Псевдоним профиля клиента.
Адресная строка 1	customer.address.address_line_1	string	Первая строка адреса. Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	customer.address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	customer.address.locality	string	Город или город адреса.
Административный район 1	customer.address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	customer.address.postal_code	string	Почтовый индекс адреса.
Страна	customer.address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Номер телефона	customer.phone_number	string	11-значный номер телефона, связанный с профилем клиента.
Идентификатор ссылки	customer.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Замечание	customer.note	string	Настраиваемая заметка, связанная с профилем клиента.
День рождения	customer.birthday	string	День рождения, связанный с профилем клиента, в формате RFC 3339. Год необязателен. Часовой пояс и время запрещены. Например, 0000-09-21T00:00:00-00:00 представляет день рождения 21 сентября и 1998-09-21T00:00:00-00:00:00:00 представляет день рождения 21 сентября 1998 года.
Отмена подписки по электронной почте	customer.preferences.email_unsubscribed	boolean	Указывает, отменяет ли клиент подписку на сообщения электронной почты маркетинговой кампании. Значение true означает, что клиент решил отказаться от маркетинга электронной почты от текущего продавца Квадрата или от всех продавцов Квадрата.
Источник создания	customer.creation_source	string	Источник создания представляет метод, используемый для создания профиля клиента.
Версия	customer.version	integer	Текущая версия этого объекта.

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

Идентификатор операции:

PaymentCreate

Создает платеж с помощью предоставленного источника. Эту конечную точку можно использовать для оплаты карты (кредитной или дебетовой карты или квадратной подарочной карты) или записи платежа, полученного продавцом за пределами Квадрата (наличные платежи от покупателя или оплаты, обрабатываемой внешней сущностью от имени продавца).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Сумма	amount		integer	Сумма денег, которую нужно принять для этого платежа, не включая tip_money.
Валюта	currency		string	3-символьный код валюты ISO 4217.
Исходный идентификатор	source_id		string	Идентификатор источника средств для этого платежа. Это может быть маркер оплаты (карточка, не относящегося к карте), созданный формой оплаты Square или картой в файле, сделанном с помощью API клиентов. При записи платежа, полученного продавцом за пределами квадрата, укажите ЛИБО CASH или EXTERNAL.
Автозаполнение	autocomplete		boolean	Если задано значение true, этот платеж будет выполнен по возможности. Если задано значение false, этот платеж хранится в утвержденном состоянии до явного завершения (захваченного) или отмененного (voided).
Идентификатор клиента	customer_id		string	Идентификатор клиента, который нужно связать.
Идентификатор расположения	location_id		string	Идентификатор расположения.
Идентификатор ссылки	reference_id		string	Необязательный второй идентификатор, используемый для связывания профиля клиента с сущностью в другой системе.
Замечание	note		string	Настраиваемая заметка, связанная с профилем клиента.
Сумма	amount		integer	Сумма денег, которую нужно принять для этого платежа, не включая tip_money.
Валюта	currency		string	3-символьный код валюты ISO 4217.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	payment.id	string	Уникальный идентификатор, выданный квадратом.
Создано в	payment.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	payment.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Сумма	payment.amount_money.amount	integer	Сумма.
Валюта	payment.amount_money.currency	string	Валюта.
Сумма	payment.app_fee_money.amount	integer	Сумма.
Валюта	payment.app_fee_money.currency	string	Валюта.
Состояние	payment.status	string	Текущее состояние проверки этого объекта.
Длительность задержки	payment.delay_duration	string	Длительность времени после создания платежа, когда Квадрат автоматически применяет delay_action к платежу. Эта автоматическая delay_action применяется только к платежам, которые не достигают состояния терминала (COMPLETED, CANCELED или FAILED) до периода времени delay_duration. Это поле указывается в формате RFC 3339.
Тип источника	payment.source_type	string	Исходный тип для этого платежа. Текущие значения включают CARD, BANK_ACCOUNT, WALLET, CASH или EXTERNAL.
Состояние	payment.card_details.status	string	Текущее состояние.
Бренд карточки	payment.card_details.card.card_brand	string	Бренд карты.
Последние 4	payment.card_details.card.last_4	string	Последние 4 цифры номера карточки.
Месяц Exp	payment.card_details.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Exp Year	payment.card_details.card.exp_year	integer	Четырехзначный год срока действия карты.
Отпечаток	payment.card_details.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
Тип карточки	payment.card_details.card.card_type	string	Тип карточки.
Предоплаченный тип	payment.card_details.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
БУНКЕР	payment.card_details.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Метод Entry	payment.card_details.entry_method	string	Метод, используемый для ввода сведений о карте для оплаты. Метод может быть KEYED, SWIPED, EMV, ON_FILE или CONTACTLESS.
Состояние CVV	payment.card_details.cvv_status	string	Код состояния, возвращенный проверкой значения проверки карточки (CVV). Код может быть CVV_ACCEPTED, CVV_REJECTED или CVV_NOT_CHECKED.
Состояние AVS	payment.card_details.avs_status	string	Код состояния, возвращенный проверкой системы проверки адресов (AVS). Код может быть AVS_ACCEPTED, AVS_REJECTED или AVS_NOT_CHECKED.
Код результата проверки подлинности	payment.card_details.auth_result_code	string	Код состояния, возвращенный издателем карты, который описывает состояние авторизации платежа.
Описание инструкции	payment.card_details.statement_description	string	Описание инструкции, отправленное в сети карточек.
Авторизовано по адресу	payment.card_details.card_payment_timeline.authorized_at	string	Метка времени, когда платеж был авторизован, в формате RFC 3339.
Записано в	payment.card_details.card_payment_timeline.captured_at	string	Метка времени записи платежа в формате RFC 3339.
Идентификатор расположения	payment.location_id	string	Идентификатор расположения.
Идентификатор заказа	payment.order_id	string	Идентификатор заказа.
Идентификатор ссылки	payment.reference_id	string	Необязательный идентификатор ссылки, определенный пользователем.
Создано в	payment.risk_evaluation.created_at	string	Метка времени при создании в формате RFC 3339.
Уровень риска	payment.risk_evaluation.risk_level	string	Уровень риска, связанный с оплатой.
Замечание	payment.note	string	Настраиваемая заметка, связанная с профилем клиента.
Идентификатор клиента	payment.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Сумма	payment.total_money.amount	integer	Сумма.
Валюта	payment.total_money.currency	string	Валюта.
Сумма	payment.approved_money.amount	integer	Сумма.
Валюта	payment.approved_money.currency	string	Валюта.
Номер квитанции	payment.receipt_number	string	Номер квитанции платежа. Поле отсутствует, если платеж отменен.
URL-адрес квитанции	payment.receipt_url	string	URL-адрес квитанции платежа. Поле заполняется только для оплаты COMPLETED.
Действие по задержке	payment.delay_action	string	Действие, которое будет применено к платежу, когда delay_duration истекает.
Задержка до	payment.delayed_until	string	Метка времени только для чтения при автоматическом применении delay_action в формате RFC 3339.
Квадратный продукт	payment.application_details.square_product	string	Квадратный продукт, например квадратный пункт продажи (POS), квадратные счета или квадратный виртуальный терминал.
Идентификатор приложения	payment.application_details.application_id	string	Идентификатор квадрата только для чтения, назначенный приложению.
Маркер версии	payment.version_token	string	Этот непрозрачный маркер определяет определенную версию объекта.

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

Идентификатор операции:

SubscriptionCreate

Создает подписку для клиента в план подписки. Если вы предоставляете карточку по файлу в запросе, Квадратный взимает плату за подписку. В противном случае квадратные счета выставляются по адресу электронной почты клиента. Подписка начинается немедленно, если запрос не включает необязательный start_date. Каждая отдельная подписка связана с определенным расположением.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор расположения	location_id		string	Идентификатор расположения.
Идентификатор плана	plan_id		string	Идентификатор плана подписки, созданного с помощью API каталога.
Идентификатор клиента	customer_id		string	Идентификатор клиента, который нужно связать.
Идентификатор карточки	card_id		string	Идентификатор карты клиента для оплаты.
Дата начала	start_date		string	Дата начала подписки в формате YYY-MM-DD.
Процент налогов	tax_percentage		string	Налог, добавляемый при выставлении счетов подписки.
Сумма	amount		integer	Сумма денег, которую нужно принять для этого платежа, не включая tip_money.
Валюта	currency		string	3-символьный код валюты ISO 4217.
Timezone	timezone		string	Часовой пояс, используемый в вычислениях дат для подписки.
Имя	name		string	Имя объекта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	subscription.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор расположения	subscription.location_id	string	Идентификатор расположения.
Идентификатор плана	subscription.plan_id	string	Идентификатор связанного плана подписки.
Идентификатор клиента	subscription.customer_id	string	Идентификатор этого объекта, представляющего клиента.
Дата начала	subscription.start_date	string	Дата начала подписки в формате YYY-MM-DD.
Состояние	subscription.status	string	Текущее состояние проверки этого объекта.
Процент налогов	subscription.tax_percentage	string	Сумма налога, применяемая при выставлении счетов подписки.
Сумма	subscription.price_override_money.amount	integer	Сумма.
Валюта	subscription.price_override_money.currency	string	Валюта.
Версия	subscription.version	integer	Текущая версия этого объекта.
Создано в	subscription.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Идентификатор карточки	subscription.card_id	string	Идентификатор карточки клиента, которая взимается за подписку.
Timezone	subscription.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Имя	subscription.source.name	string	Имя.

Создание счета

Идентификатор операции:

InvoiceCreate

Создает черновик счета для заказа, созданного с помощью API заказов. Черновик счета остается в вашей учетной записи, и никаких действий не выполняется. Вы должны опубликовать счет, прежде чем квадрат может обработать его (отправить его по адресу электронной почты клиента или оплатить карточку клиента в файле).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).
Идентификатор расположения	location_id		string	Идентификатор расположения.
Идентификатор заказа	order_id		string	Идентификатор заказа.
Запланированное в	scheduled_at		string	Метка времени при планировании обработки в формате RFC 3339.
Идентификатор клиента	customer_id		string	Идентификатор клиента, связанного с заказом.
Метод доставки	delivery_method		string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Тип запроса	request_type		string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	due_date		string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	tipping_enabled		boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Автоматический источник оплаты	automatic_payment_source		string	Метод оплаты для автоматического платежа.
Message	message		string	Сообщение.
Относительные запланированные дни	relative_scheduled_days		integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Номер счета	invoice_number		string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	title		string	Заголовок.
Description	description		string	Описание.
Card	card		boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	square_gift_card		boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	bank_account		boolean	Указывает, принимаются ли банковские платежи.
Этикетка	label		string	Метка или название настраиваемого поля.
Ценность	value		string	Текст настраиваемого поля.
Размещение	placement		string	Расположение настраиваемого поля в счете.
Дата продажи или обслуживания	sale_or_service_date		string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	invoice.id	string	Уникальный идентификатор, выданный квадратом.
Версия	invoice.version	integer	Текущая версия этого объекта.
Идентификатор расположения	invoice.location_id	string	Идентификатор расположения.
Идентификатор заказа	invoice.order_id	string	Идентификатор заказа.
Запросы на оплату	invoice.payment_requests	array of object
ИД пользователя	invoice.payment_requests.uid	string	Идентификатор, созданный квадратом.
Тип запроса	invoice.payment_requests.request_type	string	Определяет тип запроса на оплату. Этот тип определяет, как определяется сумма запроса на оплату.
Срок	invoice.payment_requests.due_date	string	Дата выполнения запроса на оплату в формате YYY-MM-DD.
Советы включено	invoice.payment_requests.tipping_enabled	boolean	Если задано значение true, предоставляет клиенту место для оплаты чаевых.
Напоминания	invoice.payment_requests.reminders	array of object
ИД пользователя	invoice.payment_requests.reminders.uid	string	Идентификатор, назначенный квадратом.
Относительные запланированные дни	invoice.payment_requests.reminders.relative_scheduled_days	integer	Число дней до (отрицательное число) или после (положительное число) запрос на оплату due_date при отправке напоминания.
Message	invoice.payment_requests.reminders.message	string	Сообщение.
Состояние	invoice.payment_requests.reminders.status	string	Текущее состояние.
Сумма	invoice.payment_requests.computed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.computed_amount_money.currency	string	Валюта.
Сумма	invoice.payment_requests.total_completed_amount_money.amount	integer	Сумма.
Валюта	invoice.payment_requests.total_completed_amount_money.currency	string	Валюта.
Автоматический источник оплаты	invoice.payment_requests.automatic_payment_source	string	Метод оплаты для автоматического платежа.
Номер счета	invoice.invoice_number	string	Понятный номер счета. Значение уникально в расположении. Если при создании счета не указано, квадрат назначает значение.
Название	invoice.title	string	Заголовок.
Description	invoice.description	string	Описание.
Запланированное в	invoice.scheduled_at	string	Метка времени при планировании обработки в формате RFC 3339.
Состояние	invoice.status	string	Текущее состояние проверки этого объекта.
Timezone	invoice.timezone	string	Часовой пояс, используемый для интерпретации дат календаря. При создании счета это поле задается в часовой пояс, указанный для расположения продавца. Невозможно изменить значение.
Создано в	invoice.created_at	string	Метка времени, указывающая время создания этого объекта в формате RFC 3339.
Обновлено в	invoice.updated_at	string	Метка времени, указывающая последнее время обновления этого объекта в формате RFC 3339.
Идентификатор клиента	invoice.primary_recipient.customer_id	string	Идентификатор клиента, связанного с заказом.
Заданное имя	invoice.primary_recipient.given_name	string	Данное имя получателя (то есть имя).
Фамилия	invoice.primary_recipient.family_name	string	Семья получателя (то есть фамилия).
Электронная почта	invoice.primary_recipient.email_address	string	Адрес электронной почты получателя.
Номер телефона	invoice.primary_recipient.phone_number	string	Номер телефона получателя.
Card	invoice.accepted_payment_methods.card	boolean	Указывает, принимаются ли платежи по кредитной карте или дебетовой карте.
Квадратная подарочная карта	invoice.accepted_payment_methods.square_gift_card	boolean	Указывает, принимаются ли платежи по карточке квадратных карт.
Банковский счёт	invoice.accepted_payment_methods.bank_account	boolean	Указывает, принимаются ли банковские платежи.
Настраиваемые поля	invoice.custom_fields	array of object
Этикетка	invoice.custom_fields.label	string	Метка или название настраиваемого поля.
Ценность	invoice.custom_fields.value	string	Текст настраиваемого поля.
Размещение	invoice.custom_fields.placement	string	Расположение настраиваемого поля в счете.
Метод доставки	invoice.delivery_method	string	Метод доставки, который Квадрат использует для отправки счета, напоминаний и квитанций клиенту. После публикации счета Квадратный обрабатывает счет на основе методов доставки и параметров запроса на оплату немедленно или по дате scheduled_at, если указано.
Дата продажи или обслуживания	invoice.sale_or_service_date	string	Дата продажи или дата отрисовки службы в формате YYY-MM-DD. Это поле можно использовать для указания последней или будущей даты, которая отображается в счете.

Создание текста доказательства спора

Идентификатор операции:

DisputeCreateEvidenceText

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.
Тип доказательства	evidence_type		string	Тип передаваемых доказательств.
Текст доказательства	evidence_text		string	Строка доказательства.
Ключ Idempotency	idempotency_key		string	Значение, указывающее, что однозначно идентифицирует этот запрос среди всех ваших запросов. Распространенный способ создания допустимого ключа идемпотентности — использовать универсальный уникальный идентификатор (UUID).

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	evidence.id	string	Уникальный идентификатор, выданный квадратом.
Идентификатор спора	evidence.dispute_id	string	Идентификатор спора, с которым связано свидетельство.
Текст доказательства	evidence.evidence_text	string	Необработанный текст.
Тип доказательства	evidence.evidence_type	string	Свидетельство типа pf.
Отправлено по адресу	evidence.uploaded_at	string	Время выполнения следующего действия в формате RFC 3339.

Список карточек

Идентификатор операции:

CardList

Извлекает список карт, принадлежащих учетной записи, выполняя запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор разбиения на страницы, возвращенный предыдущим вызовом этой конечной точки.
Идентификатор клиента	customer_id		string	Ограничить результаты карточками, связанными с предоставленным клиентом. По умолчанию возвращаются все карты, принадлежащие торговцу.
Включение отключено	include_disabled		boolean	Включает отключенные карточки. По умолчанию возвращаются все включенные карточки, принадлежащие продавцу.
Идентификатор ссылки	reference_id		string	Ограничить результаты карточками, связанными с предоставленным reference_id.
Порядок сортировки	sort_order		string	Сортирует возвращаемый список по моменту создания карточки с указанным порядком.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cards	cards	array of object
Идентификатор	cards.card.id	string	Идентификатор объекта
Адресная строка 1	cards.card.billing_address.address_line_1	string	Поля, начинающиеся с address_line, предоставляют наиболее конкретные сведения адреса, такие как номер улицы, имя улицы и имя здания.
Строка адреса 2	cards.card.billing_address.address_line_2	string	Вторая строка адреса, если она есть.
Местность	cards.card.billing_address.locality	string	Город или город адреса.
Административный район 1	cards.card.billing_address.administrative_district_level_1	string	Гражданская сущность в стране адреса. В США это государство.
Почтовый индекс	cards.card.billing_address.postal_code	string	Почтовый индекс адреса.
Страна	cards.card.billing_address.country	string	Страна адреса в формате ISO 3166-1-alpha-2.
Отпечаток	cards.card.fingerprint	string	Предназначен как идентификатор, назначенный квадратом, на основе номера карточки, чтобы определить карточку в нескольких расположениях в одном приложении.
БУНКЕР	cards.card.bin	string	Первые шесть цифр номера карты, известные как банковский идентификационный номер (BIN).
Бренд карточки	cards.card.card_brand	string	Бренд карты.
Тип карточки	cards.card.card_type	string	Тип карточки.
Имя заполнителя карточки	cards.card.cardholder_name	string	Имя заполнителя карточки.
Идентификатор клиента	cards.card.customer_id	string	Идентификатор клиента, связанного с карточкой.
Включен	cards.card.enabled	boolean	Указывает, можно ли использовать объект.
Срок действия месяца	cards.card.exp_month	integer	Срок действия связанной карты в качестве целого числа от 1 до 12.
Срок действия года	cards.card.exp_year	integer	Четырехзначный год срока действия карты.
Последние 4	cards.card.last_4	string	Последние 4 цифры номера карточки.
Предоплаченный тип	cards.card.prepaid_type	string	Указывает, является ли карта предоплаченной или нет.
Идентификатор ссылки	cards.card.reference_id	string	Необязательный идентификатор ссылки, определяемый пользователем, который связывает эту карточку с другой сущностью во внешней системе.
Версия	cards.card.version	integer	Номер текущей версии карточки. Увеличивается при каждом обновлении карточки. Запросы на обновление существующего объекта Card будут отклонены, если версия в запросе не соответствует текущей версии карточки.

Удаление группы из клиента

Идентификатор операции:

CustomerRemoveGroup

Удаляет членство в группе от клиента. Клиент определяется значением customer_id, а группа клиентов определяется значением group_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор клиента	customer_id	True	string	Идентификатор клиента.
Идентификатор группы	group_id	True	string	Идентификатор группы.

Возвращаемое значение

response

object

Удаление группы клиентов

Идентификатор операции:

CustomerGroupDelete

Удаляет группу клиентов, определяемую значением group_id.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	group_id	True	string	Идентификатор группы.

Возвращаемое значение

response

object

Удаление доказательств спора

Идентификатор операции:

DisputeDeleteEvidence

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор спора	dispute_id	True	string	Идентификатор спора.
Идентификатор доказательства	evidence_id	True	string	Идентификатор доказательства.

Возвращаемое значение

response

object

Удаление клиента

Идентификатор операции:

CustomerDelete

Удаляет профиль клиента из бизнеса. Эта операция также отменяет связь с любыми связанными карточками в файле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор клиента	customer_id	True	string	Идентификатор клиента.

Возвращаемое значение

response

object

Удаление объекта каталога

Идентификатор операции:

CatalogDelete

Удаляет один catalogObject на основе предоставленного идентификатора и возвращает набор успешно удаленных идентификаторов в ответе. Удаление является каскадным событием, таким образом, что все дочерние элементы целевого объекта также удаляются. Например, удаление catalogItem также приведет к удалению всех дочерних элементов CatalogItemVariation.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код объекта	object_id	True	string	Идентификатор объекта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификаторы удаленных объектов	deleted_object_ids	array of string
Удалено в	deleted_at	string	Метка времени удаления базы данных в формате RFC 3339

Удаление счета

Идентификатор операции:

InvoiceDelete

Удаляет указанный счет. При удалении счета соответствующее состояние заказа изменяется на CANCELED. Вы можете удалить только черновик счета (вы не можете удалить опубликованный счет, включая счет, запланированный для обработки).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер счета	invoice_id	True	string	Идентификатор счета.
Версия	version		integer	Версия счета для удаления.

Возвращаемое значение

response

object

Определения

объект

Это тип «объект».