Pagamentos Quadrados (Editor Independente) (Versão Prévia)

A Square ajuda milhões de vendedores a administrar seus negócios - desde processamento seguro de cartão de crédito até soluções de ponto de venda. Esse conector contém ações para os seguintes pontos de extremidade: Pagamentos, Terminal, Pedidos, Assinaturas, Faturas, Catálogo, Inventário e Clientes.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Publicador	Troy Taylor
Site da Web	https://squareup.com/
Política de privacidade	https://squareup.com/us/en/legal/general/privacy
Categorias	Comércio; Vendas e CRM

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Aceitar disputa	Aceita a perda em uma disputa. Square retorna o valor contestado para o titular do cartão e atualiza o estado de disputa para ACCEPTED. A Square debita o valor contestado da conta quadrada do vendedor. Se a conta Square não tiver fundos suficientes, a Square debita a conta bancária associada.
Adicionar grupo ao cliente	Adiciona uma associação de grupo a um cliente. O cliente é identificado pelo valor customer_id e o grupo de clientes é identificado pelo valor group_id.
Alterações de inventário de recuperação de lote	Retorna contagens físicas históricas e ajustes com base nos critérios de filtro fornecidos.
Atualizar assinatura	Atualiza uma assinatura. Você pode definir, modificar e limpar os valores do campo de assinatura.
Atualizar fatura	Atualiza uma fatura modificando campos, desmarcando campos ou ambos.
Atualizar grupo de clientes	Atualiza um grupo de clientes.
Atualizar impostos sobre itens	Atualiza os objetos CatalogTax que se aplicam ao CatalogItem de destino sem precisar executar um upsert em todo o item.
Atualizar listas de modificadores de item	Atualiza os objetos CatalogModifierList que se aplicam ao CatalogItem de destino sem precisar executar um upsert em todo o item.
Atualizar o pagamento	Atualiza um pagamento com o status APROVADO. Você pode atualizar o amount_money e tip_money usando esse ponto de extremidade.
Atualização de cliente	Atualiza um perfil de cliente. Para alterar um atributo, especifique o novo valor. Para remover um atributo, especifique o valor como uma cadeia de caracteres vazia ou objeto vazio.
Calcular ordem (Beta)	Permite que os aplicativos visualizem os preços dos pedidos sem criar um pedido.
Cancelar assinatura	Define o campo canceled_date ao final do período de cobrança ativo. Após essa data, o status muda de ACTIVE para CANCELED.
Cancelar check-out do terminal	Cancela uma solicitação de check-out do Terminal se o status da solicitação permitir.
Cancelar fatura	Cancela uma fatura. O vendedor não pode coletar pagamentos para a fatura cancelada.
Cancelar o pagamento por chave de idempotency	Cancela (nulos) um pagamento identificado pela chave de idempotency especificada na solicitação. Use esse método quando o status de uma solicitação CreatePayment for desconhecido (por exemplo, depois de enviar uma solicitação CreatePayment, ocorrerá um erro de rede e você não obterá uma resposta). Nesse caso, você pode direcionar a Square para cancelar o pagamento usando esse ponto de extremidade. Na solicitação, você fornece a mesma chave de idempotency que você forneceu em sua solicitação CreatePayment que deseja cancelar. Depois de cancelar o pagamento, você pode enviar sua solicitação CreatePayment novamente. Observe que, se nenhum pagamento com a chave de idempotação especificada for encontrado, nenhuma ação será tomada e o ponto de extremidade retornará com êxito.
Cancelar pagamento	Cancela (anula) um pagamento. Você pode usar esse ponto de extremidade para cancelar um pagamento com o status APPROVED.
Cancelar reembolso do terminal	Cancela uma solicitação de reembolso do Terminal Interac por ID de solicitação de reembolso se o status da solicitação permitir.
Catálogo de listas	Retorna uma lista de CatalogObjects que inclui todos os objetos de um conjunto de tipos desejados (por exemplo, todos os objetos CatalogItem e CatalogTax) no catálogo. ListCatalog não retorna itens de catálogo excluídos.
Concluir o pagamento	Conclui (captura) um pagamento. Por padrão, os pagamentos são definidos para serem concluídos imediatamente após serem criados.
Contagens de inventário de recuperação de lote	Retorna as contagens atuais para os CatalogObjects fornecidos nos Locais solicitados.
Criar assinatura	Cria uma assinatura para um cliente para um plano de assinatura. Se você fornecer um cartão no arquivo na solicitação, o Square cobra o cartão pela assinatura. Caso contrário, a Square fatura uma fatura no endereço de email do cliente. A assinatura é iniciada imediatamente, a menos que a solicitação inclua o start_date opcional. Cada assinatura individual está associada a um local específico.
Criar cartão	Adiciona um cartão no arquivo a um comerciante existente.
Criar check-out de terminal	Cria uma solicitação de check-out do Terminal e a envia para o dispositivo especificado para receber um pagamento pelo valor solicitado.
Criar fatura	Cria uma fatura de rascunho para um pedido criado usando a API orders. Uma fatura de rascunho permanece em sua conta e nenhuma ação é tomada. Você deve publicar a fatura antes que a Square possa processá-la (envie-a para o endereço de email do cliente ou carregue o cartão do cliente no arquivo).
Criar grupo de clientes	Cria um novo grupo de clientes para uma empresa.
Criar ordem	Cria um novo pedido que pode incluir informações sobre produtos para compra e configurações a serem aplicadas à compra.
Criar pagamento	Cria um pagamento usando a fonte fornecida. Você pode usar esse ponto de extremidade para cobrar um cartão (cartão de crédito/débito ou cartão de presente square) ou registrar um pagamento que o vendedor recebeu fora da Square (pagamento em dinheiro de um comprador ou um pagamento que uma entidade externa processou em nome do vendedor).
Criar reembolso de terminal	Cria uma solicitação para reembolsar um pagamento interac concluído em um Terminal Quadrado.
Criar texto de evidência de controvérsia	Carrega o texto a ser usado como evidência para um desafio de disputa.
Criar um cliente	Cria um novo cliente para uma empresa.
Desabilitar cartão	Desabilita o cartão, impedindo quaisquer atualizações ou encargos adicionais. A desabilitação de um cartão já desabilitado é permitida, mas não tem efeito.
Enviar evidência	Envia provas ao banco do titular do cartão. Antes de enviar provas, Square compila todas as evidências disponíveis. Isso inclui evidências carregadas usando os pontos de extremidade CreateDisputeEvidenceFile e CreateDisputeEvidenceText e evidências fornecidas automaticamente pelo Square, quando disponíveis.
Excluir clientes	Exclui um perfil de cliente de uma empresa. Essa operação também desvincula os cartões associados no arquivo.
Excluir evidência de controvérsia	Remove a evidência especificada de uma disputa.
Excluir fatura	Exclui a fatura especificada. Quando uma fatura é excluída, o status do pedido associado é alterado para CANCELED. Você só pode excluir uma fatura de rascunho (não é possível excluir uma fatura publicada, incluindo uma agendada para processamento).
Excluir grupo de clientes	Exclui um grupo de clientes, conforme identificado pelo valor group_id.
Excluir objeto de catálogo	Exclui um único CatalogObject com base na ID fornecida e retorna o conjunto de IDs excluídas com êxito na resposta. A exclusão é um evento em cascata, de modo que todos os filhos do objeto de destino também sejam excluídos. Por exemplo, excluir um CatalogItem também excluirá todos os seus filhos CatalogItemVariation.
Informações do catálogo	Recupera informações sobre a API do Catálogo Quadrado, como limites de tamanho de lote que podem ser usados pelo ponto de extremidade BatchUpsertCatalogObjects.
Inventário de alteração em lote	Aplica ajustes e contagens às quantidades de item fornecidas. Com êxito: retorna as contagens calculadas atuais para todos os objetos referenciados na solicitação.
Listar cartões	Recupera uma lista de cartões pertencentes à conta que está fazendo a solicitação.
Listar clientes	Lista perfis de clientes associados a uma conta Square. Em condições operacionais normais, os perfis de cliente recém-criados ou atualizados ficam disponíveis para a operação de listagem em menos de 30 segundos. Ocasionalmente, a propagação dos perfis novos ou atualizados pode levar mais de um minuto ou mais, especialmente durante incidentes de rede e interrupções.
Listar disputas	Retorna uma lista de disputas associadas a uma conta específica.
Listar eventos de assinatura	Lista todos os eventos para uma assinatura específica.
Listar faturas	Retorna uma lista de faturas para um determinado local.
Listar grupos de clientes	Recupera a lista de grupos de clientes de uma empresa.
Listar pagamentos	Recupera uma lista de pagamentos feitos pela conta que está fazendo a solicitação. Os resultados são eventualmente consistentes, e novos pagamentos ou alterações nos pagamentos podem levar vários segundos para aparecer.
Listar provas de controvérsia	Retorna uma lista de evidências associadas a uma disputa.
Listar reembolsos de pagamento	Recupera uma lista de reembolsos para a conta que está fazendo a solicitação. Os resultados são eventualmente consistentes, e novos reembolsos ou alterações nos reembolsos podem levar vários segundos para aparecer.
Listar segmentos de clientes	Recupera a lista de segmentos de clientes de uma empresa.
Objeto de catálogo upsert	Cria ou atualiza o CatalogObject de destino.
Objetos de catálogo de exclusão em lote	Exclui um conjunto de CatalogItems com base na lista fornecida de IDs de destino e retorna um conjunto de IDs excluídas com êxito na resposta.
Objetos de catálogo de recuperação de lote	Retorna um conjunto de objetos com base na ID fornecida. Cada CatalogItem retornado no conjunto inclui todas as suas informações filho, incluindo: todos os seus objetos CatalogItemVariation, referências a seus objetos CatalogModifierList e as IDs de todos os objetos CatalogTax que se aplicam a ele.
Objetos de catálogo upsert do lote	Cria ou atualiza até 10.000 objetos de destino com base na lista de objetos fornecida. Os objetos de destino são agrupados em lotes e cada lote é inserido/atualizado de maneira tudo ou nada. Se um objeto dentro de um lote for malformado de alguma forma ou violar uma restrição de banco de dados, todo o lote que contém esse item será desconsiderado. No entanto, outros lotes na mesma solicitação ainda podem ter êxito. Cada lote pode conter até 1.000 objetos e lotes serão processados em ordem, desde que a contagem total de objetos para a solicitação (itens, variações, listas de modificadores, descontos e impostos) não seja superior a 10.000.
Obter check-out do terminal	Recupera uma solicitação de check-out do terminal checkout_id.
Obter fatura	Recupera uma fatura por ID da fatura.
Obter pagamento	Recupera detalhes de um pagamento específico.
Obter reembolso de pagamento	Recupera um reembolso específico usando o refund_id.
Obter reembolso do terminal	Recupera um objeto de reembolso do Terminal Interac por ID.
Ordem de atualização (Beta)	Atualiza uma ordem aberta adicionando, substituindo ou excluindo campos. Os pedidos com um estado COMPLETED ou CANCELED não podem ser atualizados.
Ordem de clonagem (Beta)	Cria uma nova ordem, no estado DRAFT, duplicando uma ordem existente. O pedido recém-criado tem apenas os campos principais (como itens de linha, impostos e descontos) copiados do pedido original.
Ordem de pagamento (Beta)	Pague um pedido usando um ou mais pagamentos aprovados ou resolva um pedido com um total de 0. O total do payment_ids listado na solicitação deve ser igual ao total da ordem. Os pedidos com um valor total de 0 podem ser marcados como pagos especificando uma matriz vazia de payment_ids na solicitação.
Pagamento de reembolso	Reembolsa um pagamento. Você pode reembolsar todo o valor de pagamento ou uma parte dele. Você pode usar esse ponto de extremidade para reembolsar um pagamento com cartão ou registrar um reembolso de um pagamento em dinheiro ou externo.
Pedidos de pesquisa	Pesquise todos os pedidos por um ou mais locais. Os pedidos incluem todas as vendas, retornos e trocas, independentemente de como ou quando entraram no ecossistema quadrado (como Ponto de Venda, Faturas e APIs de Conexão).
Pedidos de recuperação de lote	Recupera um conjunto de pedidos por suas IDs. Se uma determinada ID de pedido não existir, a ID será ignorada em vez de gerar um erro.
Pesquisar assinaturas	Pesquisa assinaturas. Os resultados são ordenados cronologicamente pela data de criação da assinatura. Se a solicitação especificar mais de uma ID de local, o ponto de extremidade ordenará o resultado por ID de local e, em seguida, por data de criação em cada local. Se nenhum local for dado na consulta, todos os locais serão pesquisados.
Pesquisar check-outs do terminal	Recupera uma lista filtrada de solicitações de check-out de terminal criadas pela conta que está fazendo a solicitação.
Pesquisar clientes	Pesquisa os perfis de cliente associados a uma conta Square usando um filtro de consulta com suporte. Chamar SearchCustomers sem qualquer filtro de consulta explícito retorna todos os perfis de cliente ordenados em ordem alfabética com base em given_name e family_name.
Pesquisar faturas	Pesquisa faturas de um local especificado no filtro.
Pesquisar objetos do catálogo	Pesquisa catalogObject de qualquer tipo, correspondendo a valores de atributo de pesquisa com suporte, excluindo valores de atributo personalizados em itens ou variações de item, em relação a um ou mais dos filtros de consulta especificados.
Pesquisar reembolsos do terminal	Recupera uma lista filtrada de solicitações de reembolso do Terminal Interac criadas pelo vendedor que está fazendo a solicitação.
Publicar fatura	Publica a fatura de rascunho especificada. Depois que uma fatura é publicada, o Square faz o acompanhamento com base na configuração da fatura. Por exemplo, a Square envia a fatura para o endereço de email do cliente, cobra o cartão do cliente no arquivo ou não faz nada. A Square também disponibiliza a fatura em uma página de fatura hospedada na Praça.
Recuperar ajuste de inventário	Retorna o objeto InventoryAdjustment com o adjustment_id fornecido.
Recuperar assinatura	Recupera uma assinatura.
Recuperar cartão	Recupera detalhes de um Cartão específico.
Recuperar cliente	Retorna detalhes para um único cliente.
Recuperar contagem de inventário	Recupera a contagem atual de ações calculadas para um determinado CatalogObject em um determinado conjunto de Locais.
Recuperar contagem física de inventário	Retorna o objeto InventoryPhysicalCount com o physical_count_id fornecido.
Recuperar disputa	Retorna detalhes sobre uma disputa específica.
Recuperar evidência de controvérsia	Retorna os metadados de evidência especificados pela ID da evidência no caminho da URL da solicitação. Você deve manter uma cópia da evidência carregada se quiser referenciá-la mais tarde. Você não pode baixar a evidência depois de carregá-la.
Recuperar grupo de clientes	Recupera um grupo de clientes específico.
Recuperar objeto de catálogo	Retorna um único CatalogItem como um CatalogObject com base na ID fornecida. O objeto retornado inclui todas as informações relevantes do CatalogItem, incluindo: catalogItemVariation children, referências a seus objetos CatalogModifierList e as IDs de todos os objetos CatalogTax que se aplicam a ele.
Recuperar ordem	Recupera um pedido por ID.
Recuperar segmento do cliente	Recupera um segmento de cliente específico.
Recuperar transferência de inventário (Beta)	Retorna o objeto InventoryTransfer com o transfer_id fornecido.
Registrar domínio para Apple Pay	Ativa um domínio para uso com o Apple Pay na Web e no Square. Uma validação é executada nesse domínio pela Apple para garantir que ela seja configurada corretamente como um domínio habilitado para Apple Pay.
Remover grupo do cliente	Remove uma associação de grupo de um cliente. O cliente é identificado pelo valor customer_id e o grupo de clientes é identificado pelo valor group_id.
Retomar assinatura	Retoma uma assinatura desativada.

Aceitar disputa

ID da operação:: DisputeAccept

Aceita a perda em uma disputa. Square retorna o valor contestado para o titular do cartão e atualiza o estado de disputa para ACCEPTED. A Square debita o valor contestado da conta quadrada do vendedor. Se a conta Square não tiver fundos suficientes, a Square debita a conta bancária associada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.

Retornos

Nome	Caminho	Tipo	Description
ID	dispute.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	dispute.amount_money.amount	integer	O valor.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	O motivo desse objeto.
Estado	dispute.state	string	O estado atual.
Conclusão em	dispute.due_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.
Pagamentos Contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID exclusiva gerada por quadrado do pagamento.
Marca de cartão	dispute.card_brand	string	A marca do cartão.
Criado em	dispute.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	dispute.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	A ID da disputa no sistema de marca de cartão, gerada pela marca de cartão.

Adicionar grupo ao cliente

ID da operação:: CustomerAddGroup

Adiciona uma associação de grupo a um cliente. O cliente é identificado pelo valor customer_id e o grupo de clientes é identificado pelo valor group_id.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customer_id	True	string	O identificador do cliente.
ID do grupo	group_id	True	string	O identificador do grupo.

Retornos

response: object

Alterações de inventário de recuperação de lote

ID da operação:: InventoryBatchRetrieveChanges

Retorna contagens físicas históricas e ajustes com base nos critérios de filtro fornecidos.

Parâmetros

Nome	Chave	Tipo	Description
IDs de objeto de catálogo	catalog_object_ids	array of string
IDs de localização	location_ids	array of string
Tipos	types	array of string
States	states	array of string
Atualizado após	updated_after	string	O filtro para retornar resultados com seu valor de calculated_at após o determinado tempo, conforme especificado em um carimbo de data/hora RFC 3339.
Atualizado antes	updated_before	string	O filtro para retornar resultados com seus created_at ou calculated_at valor estritamente antes do horário especificado em um carimbo de data/hora RFC 3339.

Retornos

Nome	Caminho	Tipo	Description
Changes	changes	array of object
Tipo	changes.type	string	O tipo desse objeto.
ID	changes.physical_count.id	string	O identificador do objeto
ID de Referência	changes.physical_count.reference_id	string	Uma ID de referência opcional definida pelo usuário que associa esse cartão a outra entidade em um sistema externo.
ID do objeto catalog	changes.physical_count.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	changes.physical_count.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Estado	changes.physical_count.state	string	O estado de inventário atual para a quantidade relacionada de itens.
ID do Local	changes.physical_count.location_id	string	A ID do local de um destinatário (diferente do comerciante) recebendo uma parte desta licitação.
Quantidade	changes.physical_count.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Product	changes.physical_count.source.product	string	Tipo de produto para o aplicativo.
ID do aplicativo	changes.physical_count.source.application_id	string	ID quadrada atribuída ao aplicativo.
Nome	changes.physical_count.source.name	string	O nome do item.
ID do Funcionário	changes.physical_count.employee_id	string	A ID gerada por quadrado do Funcionário responsável pela contagem física.
Ocorreu em	changes.physical_count.occurred_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando a contagem física foi examinada. Para atualizações de contagem física, o carimbo de data/hora occurred_at não pode ter mais de 24 horas ou no futuro em relação à hora da solicitação.
Criado em	changes.physical_count.created_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando a contagem física foi criada.

Atualizar assinatura

ID da operação:: SubscriptionUpdate

Atualiza uma assinatura. Você pode definir, modificar e limpar os valores do campo de assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscription_id	True	string	O identificador da assinatura.
Versão	version		integer	A versão atual deste objeto.
Percentual de Impostos	tax_percentage		string	O valor do imposto aplicado ao cobrar a assinatura.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.

Retornos

Nome	Caminho	Tipo	Description
ID	subscription.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscription.location_id	string	O identificador do local.
ID do Plano	subscription.plan_id	string	A ID do plano de assinatura associado.
ID do cliente	subscription.customer_id	string	A ID desse objeto que representa o cliente.
Situação	subscription.status	string	O status de verificação atual desse objeto.
Quantidade	subscription.price_override_money.amount	integer	O valor.
Moeda	subscription.price_override_money.currency	string	A moeda.
Versão	subscription.version	integer	A versão atual deste objeto.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscription.source.name	string	O nome.

Atualizar fatura

ID da operação:: InvoiceUpdate

Atualiza uma fatura modificando campos, desmarcando campos ou ambos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
UID	uid		string	A ID gerada por quadrado.
Inflexão Habilitada	tipping_enabled		boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Campos a serem limpos	fields_to_clear		array of string

Retornos

Nome	Caminho	Tipo	Description
ID	invoice.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoice.version	integer	A versão atual deste objeto.
ID do Local	invoice.location_id	string	O identificador do local.
ID do pedido	invoice.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	A ID gerada por quadrado.
Tipo de solicitação	invoice.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoice.payment_requests.due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Quantidade	invoice.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoice.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoice.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Número da fatura	invoice.invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	invoice.title	string	O título.
Description	invoice.description	string	A descrição.
Agendado em	invoice.scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
Situação	invoice.status	string	O status de verificação atual desse objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoice.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	invoice.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do cliente	invoice.primary_recipient.customer_id	string	A ID do cliente associado ao pedido.
Nome	invoice.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoice.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoice.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
Quantidade	invoice.next_payment_amount_money.amount	integer	O valor.
Moeda	invoice.next_payment_amount_money.currency	string	A moeda.
Card	invoice.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoice.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoice.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	O local do campo personalizado na fatura.
Método de entrega	invoice.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Data de venda ou serviço	invoice.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Atualizar grupo de clientes

ID da operação:: CustomerGroupUpdate

Atualiza um grupo de clientes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.
Nome	name		string	O nome do objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	group.id	string	O identificador exclusivo emitido por Quadrado.
Nome	group.name	string	O nome do objeto.
Criado em	group.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	group.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Atualizar impostos sobre itens

ID da operação:: CatalogUpdateTaxes

Atualiza os objetos CatalogTax que se aplicam ao CatalogItem de destino sem precisar executar um upsert em todo o item.

Parâmetros

Nome	Chave	Tipo
Item IDs	item_ids	array of string
Impostos para habilitar	taxes_to_enable	array of string
Impostos para desabilitar	taxes_to_disable	array of string

Retornos

Nome	Caminho	Tipo	Description
Atualizado em	updated_at	string	O carimbo de data/hora do banco de dados dessa atualização no formato RFC 3339.

Atualizar listas de modificadores de item

ID da operação:: CatalogUpdateModifier

Atualiza os objetos CatalogModifierList que se aplicam ao CatalogItem de destino sem precisar executar um upsert em todo o item.

Parâmetros

Nome	Chave	Tipo
Item IDs	item_ids	array of string
Listas de modificadores para habilitar	modifier_lists_to_enable	array of string
Listas de modificadores para desabilitar	modifier_lists_to_disable	array of string

Retornos

Nome	Caminho	Tipo	Description
Atualizado em	updated_at	string	O carimbo de data/hora do banco de dados dessa atualização no formato RFC 3339.

Atualizar o pagamento

ID da operação:: PaymentUpdate

Atualiza um pagamento com o status APROVADO. Você pode atualizar o amount_money e tip_money usando esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
Token da versão	version_token		string	Esse token opaco identifica uma versão específica do objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	payment.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	payment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	payment.amount_money.amount	integer	O valor.
Moeda	payment.amount_money.currency	string	A moeda.
Quantidade	payment.tip_money.amount	integer	O valor.
Moeda	payment.tip_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual desse objeto.
Duração do atraso	payment.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento. Esse delay_action automático se aplica somente a pagamentos que não atingem um estado terminal (CONCLUÍDO, CANCELADO ou COM FALHA) antes do período de delay_duration. Esse campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de Fonte	payment.source_type	string	O tipo de origem desse pagamento. Os valores atuais incluem CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Situação	payment.card_details.status	string	O status atual.
Marca de cartão	payment.card_details.card.card_brand	string	A marca do cartão.
Últimos 4	payment.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payment.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payment.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payment.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payment.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Método entry	payment.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
CVV Status	payment.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
AVS Status	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payment.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payment.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payment.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
ID do Local	payment.location_id	string	O identificador do local.
ID do pedido	payment.order_id	string	A ID da ordem.
Criado em	payment.risk_evaluation.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
Nível de risco	payment.risk_evaluation.risk_level	string	O nível de risco associado ao pagamento.
Observação	payment.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do cliente	payment.customer_id	string	A ID desse objeto que representa o cliente.
Quantidade	payment.total_money.amount	integer	O valor.
Moeda	payment.total_money.currency	string	A moeda.
Quantidade	payment.approved_money.amount	integer	O valor.
Moeda	payment.approved_money.currency	string	A moeda.
Capabilities	payment.capabilities	array of string
Número do recibo	payment.receipt_number	string	O número do recibo do pagamento. O campo estará ausente se um pagamento for cancelado.
Ação de atraso	payment.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payment.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payment.application_details.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Token da versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Atualização de cliente

ID da operação:: CustomerUpdate

Atualiza um perfil de cliente. Para alterar um atributo, especifique o novo valor. Para remover um atributo, especifique o valor como uma cadeia de caracteres vazia ou objeto vazio.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customer_id	True	string	O identificador do cliente.

Retornos

Nome	Caminho	Tipo	Description
ID	customer.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	customer.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Nome	customer.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	customer.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	customer.email_address	string	O endereço de email associado ao perfil do cliente.
Linha de endereço 1	customer.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	customer.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	customer.address.postal_code	string	O código postal do endereço.
País	customer.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
ID de Referência	customer.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Observação	customer.note	string	Uma anotação personalizada associada ao perfil do cliente.
Email não assinado	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a assinatura de emails de campanha de marketing. Um valor verdadeiro significa que o cliente optou por recusar o marketing de email do vendedor da Square atual ou de todos os vendedores da Square.
Origem da criação	customer.creation_source	string	Uma fonte de criação representa o método usado para criar o perfil do cliente.
Versão	customer.version	integer	A versão atual deste objeto.

Calcular ordem (Beta)

ID da operação:: OrderCalculate

Permite que os aplicativos visualizem os preços dos pedidos sem criar um pedido.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do Local	location_id	string	O identificador do local.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Porcentagem	percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Scope	scope	string	Indica o nível atual.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.

Retornos

Nome	Caminho	Tipo	Description
ID do Local	order.location_id	string	O identificador do local.
Itens de Linha	order.line_items	array of object
UID	order.line_items.uid	string	A ID gerada por quadrado.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Quantidade	order.line_items.variation_total_price_money.amount	integer	O valor.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
Descontos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Uma ID atribuída por quadrado.
UID de desconto	order.line_items.applied_discounts.discount_uid	string	A uid do desconto que o desconto aplicado representa.
Quantidade	order.line_items.applied_discounts.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	A ID gerada por quadrado.
Nome	order.discounts.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Porcentagem	order.discounts.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.discounts.applied_money.amount	integer	O valor.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Tipo	order.discounts.type	string	Indica o tipo.
Scope	order.discounts.scope	string	Indica o nível atual.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Quantidade	order.total_tip_money.amount	integer	O valor.
Moeda	order.total_tip_money.currency	string	A moeda.
Quantidade	order.total_money.amount	integer	O valor.
Moeda	order.total_money.currency	string	A moeda.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.tip_money.amount	integer	O valor.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.

Cancelar assinatura

ID da operação:: SubscriptionCancel

Define o campo canceled_date ao final do período de cobrança ativo. Após essa data, o status muda de ACTIVE para CANCELED.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscription_id	True	string	O identificador da assinatura.

Retornos

Nome	Caminho	Tipo	Description
ID	subscription.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscription.location_id	string	O identificador do local.
ID do Plano	subscription.plan_id	string	A ID do plano de assinatura associado.
ID do cliente	subscription.customer_id	string	A ID desse objeto que representa o cliente.
ID do Cartão	subscription.card_id	string	A ID do cartão do cliente que é cobrado pela assinatura.
Data de Início	subscription.start_date	string	A data de início da assinatura, no formato YYYY-MM-DD.
Data cancelada	subscription.canceled_date	string	A data de cancelamento da assinatura, no formato YYYY-MM-DD.
Data de pagamento até a data	subscription.paid_until_date	string	A data paga até.
Situação	subscription.status	string	O status de verificação atual desse objeto.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Versão	subscription.version	integer	A versão atual deste objeto.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscription.source.name	string	O nome.

Cancelar check-out do terminal

ID da operação:: TerminalCancelCheckout

Cancela uma solicitação de check-out do Terminal se o status da solicitação permitir.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do check-out	checkout_id	True	string	O identificador do check-out.

Retornos

Nome	Caminho	Tipo	Description
ID	checkout.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	checkout.amount_money.amount	integer	O valor.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Uma ID de referência opcional definida pelo usuário.
ID do dispositivo	checkout.device_options.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalCheckout.
Permitir tombamento	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a inflexão está habilitada para esse check-out. O padrão é false.
Ignorar tela de recebimento	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recebimento. O padrão é false.
Situação	checkout.status	string	O status de verificação atual desse objeto.
Cancelar Motivo	checkout.cancel_reason	string	O motivo da transação cancelada.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	checkout.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	checkout.app_id	string	A ID do aplicativo que criou o check-out.
Duração do prazo	checkout.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação

Cancelar fatura

ID da operação:: InvoiceCancel

Cancela uma fatura. O vendedor não pode coletar pagamentos para a fatura cancelada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Versão	version		integer	A versão.

Retornos

Nome	Caminho	Tipo	Description
ID	invoice.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoice.version	integer	A versão atual deste objeto.
ID do Local	invoice.location_id	string	O identificador do local.
ID do pedido	invoice.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	A ID gerada por quadrado.
Tipo de solicitação	invoice.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoice.payment_requests.due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Lembretes	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado.
Dias agendados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoice.payment_requests.reminders.message	string	A mensagem.
Situação	invoice.payment_requests.reminders.status	string	O status atual.
Quantidade	invoice.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoice.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoice.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Número da fatura	invoice.invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	invoice.title	string	O título.
Description	invoice.description	string	A descrição.
Agendado em	invoice.scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
Situação	invoice.status	string	O status de verificação atual desse objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoice.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	invoice.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do cliente	invoice.primary_recipient.customer_id	string	A ID do cliente associado ao pedido.
Nome	invoice.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoice.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoice.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
Card	invoice.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoice.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoice.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	O local do campo personalizado na fatura.
Método de entrega	invoice.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Data de venda ou serviço	invoice.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Cancelar o pagamento por chave de idempotency

ID da operação:: PaymentCancelIdempotency

Cancela (nulos) um pagamento identificado pela chave de idempotency especificada na solicitação. Use esse método quando o status de uma solicitação CreatePayment for desconhecido (por exemplo, depois de enviar uma solicitação CreatePayment, ocorrerá um erro de rede e você não obterá uma resposta). Nesse caso, você pode direcionar a Square para cancelar o pagamento usando esse ponto de extremidade. Na solicitação, você fornece a mesma chave de idempotency que você forneceu em sua solicitação CreatePayment que deseja cancelar. Depois de cancelar o pagamento, você pode enviar sua solicitação CreatePayment novamente. Observe que, se nenhum pagamento com a chave de idempotação especificada for encontrado, nenhuma ação será tomada e o ponto de extremidade retornará com êxito.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

response: object

Cancelar pagamento

ID da operação:: PaymentCancel

Cancela (anula) um pagamento. Você pode usar esse ponto de extremidade para cancelar um pagamento com o status APPROVED.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Retornos

Nome	Caminho	Tipo	Description
ID	payment.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	payment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	payment.amount_money.amount	integer	O valor.
Moeda	payment.amount_money.currency	string	A moeda.
Quantidade	payment.tip_money.amount	integer	O valor.
Moeda	payment.tip_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual desse objeto.
Duração do atraso	payment.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento. Esse delay_action automático se aplica somente a pagamentos que não atingem um estado terminal (CONCLUÍDO, CANCELADO ou COM FALHA) antes do período de delay_duration. Esse campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de Fonte	payment.source_type	string	O tipo de origem desse pagamento. Os valores atuais incluem CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Situação	payment.card_details.status	string	O status atual.
Marca de cartão	payment.card_details.card.card_brand	string	A marca do cartão.
Últimos 4	payment.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payment.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payment.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payment.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payment.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Método entry	payment.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
CVV Status	payment.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
AVS Status	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payment.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payment.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payment.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
Nulo em	payment.card_details.card_payment_timeline.voided_at	string	O carimbo de data/hora quando o pagamento foi anulado, no formato RFC 3339.
ID do Local	payment.location_id	string	O identificador do local.
ID do pedido	payment.order_id	string	A ID da ordem.
Criado em	payment.risk_evaluation.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
Nível de risco	payment.risk_evaluation.risk_level	string	O nível de risco associado ao pagamento.
Observação	payment.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do cliente	payment.customer_id	string	A ID desse objeto que representa o cliente.
Quantidade	payment.total_money.amount	integer	O valor.
Moeda	payment.total_money.currency	string	A moeda.
Quantidade	payment.approved_money.amount	integer	O valor.
Moeda	payment.approved_money.currency	string	A moeda.
Ação de atraso	payment.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payment.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payment.application_details.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Token da versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Cancelar reembolso do terminal

ID da operação:: TerminalCancelRefund

Cancela uma solicitação de reembolso do Terminal Interac por ID de solicitação de reembolso se o status da solicitação permitir.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de reembolso do terminal	terminal_refund_id	True	string	O identificador do reembolso do terminal.

Retornos

Nome	Caminho	Tipo	Description
ID	refund.id	string	O identificador exclusivo emitido por Quadrado.
ID de pagamento	refund.payment_id	string	A ID exclusiva do pagamento.
Quantidade	refund.amount_money.amount	integer	O valor.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	O motivo desse objeto.
ID do dispositivo	refund.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalRefund.
Duração do prazo	refund.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Situação	refund.status	string	O status de verificação atual desse objeto.
Cancelar Motivo	refund.cancel_reason	string	O motivo da transação cancelada.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	refund.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	refund.app_id	string	A ID do aplicativo que criou o check-out.
Marca de cartão	refund.card.card_brand	string	A marca do cartão.
last_4	refund.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	refund.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	refund.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	refund.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	refund.card.card_type	string	O tipo do cartão.
ESCANINHO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
ID do pedido	refund.order_id	string	A ID da ordem.
ID do Local	refund.location_id	string	O identificador do local.

Catálogo de listas

ID da operação:: CatalogList

Retorna uma lista de CatalogObjects que inclui todos os objetos de um conjunto de tipos desejados (por exemplo, todos os objetos CatalogItem e CatalogTax) no catálogo. ListCatalog não retorna itens de catálogo excluídos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Cursor	cursor		integer	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Tipos	types		string	Uma lista opcional sem diferenciação de maiúsculas e minúsculas de tipos de objeto a serem recuperados. Os valores válidos são definidos na enumeração CatalogObjectType, incluindo ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST ou IMAGE. Se isso não for especificado, a operação retornará objetos de todos os tipos na versão da API Quadrada usada para fazer a solicitação.

Retornos

Nome	Caminho	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	O tipo desse objeto.
ID	objects.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	objects.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.version	integer	A versão atual do objeto.
Está Excluído	objects.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	objects.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	objects.category_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Nome	objects.tax_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Fase de cálculo	objects.tax_data.calculation_phase	string	Se o imposto é calculado com base no subtotal ou no total de um pagamento.
Tipo de inclusão	objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Porcentagem	objects.tax_data.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Enabled	objects.tax_data.enabled	boolean	Indica se um objeto pode ou não ser usado.

Concluir o pagamento

ID da operação:: PaymentComplete

Conclui (captura) um pagamento. Por padrão, os pagamentos são definidos para serem concluídos imediatamente após serem criados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Retornos

Nome	Caminho	Tipo	Description
ID	payment.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	payment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	payment.amount_money.amount	integer	O valor.
Moeda	payment.amount_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual desse objeto.
Duração do atraso	payment.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento. Esse delay_action automático se aplica somente a pagamentos que não atingem um estado terminal (CONCLUÍDO, CANCELADO ou COM FALHA) antes do período de delay_duration. Esse campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de Fonte	payment.source_type	string	O tipo de origem desse pagamento. Os valores atuais incluem CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Situação	payment.card_details.status	string	O status atual.
Marca de cartão	payment.card_details.card.card_brand	string	A marca do cartão.
Últimos 4	payment.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payment.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payment.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payment.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payment.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Método entry	payment.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
CVV Status	payment.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
AVS Status	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payment.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payment.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payment.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
Capturado em	payment.card_details.card_payment_timeline.captured_at	string	O carimbo de data/hora quando o pagamento foi capturado, no formato RFC 3339.
ID do Local	payment.location_id	string	O identificador do local.
ID do pedido	payment.order_id	string	A ID da ordem.
Taxa de Processamento	payment.processing_fee	array of object
Efetivo em	payment.processing_fee.effective_at	string	O carimbo de data/hora de quando a taxa entra em vigor, no formato RFC 3339.
Tipo	payment.processing_fee.type	string	Indica o tipo.
Quantidade	payment.processing_fee.amount_money.amount	integer	O valor.
Moeda	payment.processing_fee.amount_money.currency	string	A moeda.
Observação	payment.note	string	Uma anotação personalizada associada ao perfil do cliente.
Quantidade	payment.total_money.amount	integer	O valor.
Moeda	payment.total_money.currency	string	A moeda.
Quantidade	payment.approved_money.amount	integer	O valor.
Moeda	payment.approved_money.currency	string	A moeda.
ID do Funcionário	payment.employee_id	string	A ID gerada por quadrado do Funcionário.
Número do recibo	payment.receipt_number	string	O número do recibo do pagamento. O campo estará ausente se um pagamento for cancelado.
URL de recebimento	payment.receipt_url	string	A URL do recibo do pagamento. O campo só é preenchido para pagamentos COMPLETED.
Ação de atraso	payment.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payment.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
ID do membro da equipe	payment.team_member_id	string	A ID do membro da equipe.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payment.application_details.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Token da versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Contagens de inventário de recuperação de lote

ID da operação:: InventoryBatchRetrieveCounts

Retorna as contagens atuais para os CatalogObjects fornecidos nos Locais solicitados.

Parâmetros

Nome	Chave	Tipo	Description
IDs de objeto de catálogo	catalog_object_ids	array of string
IDs de localização	location_ids	array of string
Atualizado após	updated_after	string	O filtro para retornar resultados com seu valor de calculated_at após o determinado tempo, conforme especificado em um carimbo de data/hora RFC 3339.

Retornos

Nome	Caminho	Tipo	Description
Conta	counts	array of object
ID do objeto catalog	counts.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	counts.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Estado	counts.state	string	O estado atual.
ID do Local	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física ou o ajuste mais recente que afeta a contagem estimada é recebido.

Criar assinatura

ID da operação:: SubscriptionCreate

Cria uma assinatura para um cliente para um plano de assinatura. Se você fornecer um cartão no arquivo na solicitação, o Square cobra o cartão pela assinatura. Caso contrário, a Square fatura uma fatura no endereço de email do cliente. A assinatura é iniciada imediatamente, a menos que a solicitação inclua o start_date opcional. Cada assinatura individual está associada a um local específico.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do Local	location_id	string	O identificador de local.
ID do Plano	plan_id	string	A ID do plano de assinatura criado usando a API de Catálogo.
ID do cliente	customer_id	string	A ID do cliente a ser vinculado.
ID do Cartão	card_id	string	A ID do cartão do cliente a ser cobrado.
Data de Início	start_date	string	A data de início da assinatura, no formato YYYY-MM-DD.
Percentual de Impostos	tax_percentage	string	O imposto a ser adicionado ao cobrar a assinatura.
Quantidade	amount	integer	A quantidade de dinheiro a aceitar para esse pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.
Timezone	timezone	string	O fuso horário usado nos cálculos de data para a assinatura.
Nome	name	string	O nome do objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	subscription.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscription.location_id	string	O identificador do local.
ID do Plano	subscription.plan_id	string	A ID do plano de assinatura associado.
ID do cliente	subscription.customer_id	string	A ID desse objeto que representa o cliente.
Data de Início	subscription.start_date	string	A data de início da assinatura, no formato YYYY-MM-DD.
Situação	subscription.status	string	O status de verificação atual desse objeto.
Percentual de Impostos	subscription.tax_percentage	string	O valor do imposto aplicado ao cobrar a assinatura.
Quantidade	subscription.price_override_money.amount	integer	O valor.
Moeda	subscription.price_override_money.currency	string	A moeda.
Versão	subscription.version	integer	A versão atual deste objeto.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do Cartão	subscription.card_id	string	A ID do cartão do cliente que é cobrado pela assinatura.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscription.source.name	string	O nome.

Criar cartão

ID da operação:: CardCreate

Adiciona um cartão no arquivo a um comerciante existente.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	A chave de idempotency.
ID de origem	source_id	string	O identificador da origem.
Linha de endereço 1	address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	address_line_2	string	A segunda linha do endereço, se houver.
Localidade	locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	postal_code	string	O código postal do endereço.
País	country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Nome do titular do cartão	cardholder_name	string	O nome do titular do cartão.
ID do cliente	customer_id	string	A ID desse objeto que representa o cliente.
ID de Referência	reference_id	string	Uma ID de referência opcional definida pelo usuário.

Retornos

Nome	Caminho	Tipo	Description
ID	card.id	string	O identificador exclusivo emitido por Quadrado.
Linha de endereço 1	card.billing_address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	card.billing_address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	card.billing_address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	card.billing_address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	card.billing_address.postal_code	string	O código postal do endereço.
País	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
ESCANINHO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Marca de cartão	card.card_brand	string	A marca do cartão.
Tipo de cartão	card.card_type	string	O tipo do cartão.
Nome do titular do cartão	card.cardholder_name	string	O nome do titular do cartão.
ID do cliente	card.customer_id	string	A ID desse objeto que representa o cliente.
Enabled	card.enabled	boolean	Se estiver habilitado.
Mês exp	card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Últimos 4	card.last_4	string	Os últimos 4 dígitos do número do cartão.
Tipo pré-pago	card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ID de Referência	card.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Versão	card.version	integer	A versão atual deste objeto.

Criar check-out de terminal

ID da operação:: TerminalCreateCheckout

Cria uma solicitação de check-out do Terminal e a envia para o dispositivo especificado para receber um pagamento pelo valor solicitado.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.
ID de Referência	reference_id	string	Uma ID de referência opcional definida pelo usuário.
ID do dispositivo	device_id	string	A ID exclusiva do dispositivo destinado a este TerminalCheckout.
Observação	note	string	Uma anotação personalizada associada ao perfil do cliente.

Retornos

Nome	Caminho	Tipo	Description
ID	checkout.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	checkout.amount_money.amount	integer	O valor.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Observação	checkout.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do dispositivo	checkout.device_options.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalCheckout.
Permitir tombamento	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a inflexão está habilitada para esse check-out. O padrão é false.
Ignorar tela de recebimento	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recebimento. O padrão é false.
Situação	checkout.status	string	O status de verificação atual desse objeto.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	checkout.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	checkout.app_id	string	A ID do aplicativo que criou o check-out.
Duração do prazo	checkout.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Tipo de pagamento	checkout.payment_type	string	O tipo de pagamento do qual o terminal deve tentar capturar. O padrão é CARD_PRESENT.

Criar fatura

ID da operação:: InvoiceCreate

Cria uma fatura de rascunho para um pedido criado usando a API orders. Uma fatura de rascunho permanece em sua conta e nenhuma ação é tomada. Você deve publicar a fatura antes que a Square possa processá-la (envie-a para o endereço de email do cliente ou carregue o cartão do cliente no arquivo).

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do Local	location_id	string	O identificador do local.
ID do pedido	order_id	string	A ID da ordem.
Agendado em	scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
ID do cliente	customer_id	string	A ID do cliente associado ao pedido.
Método de entrega	delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Tipo de solicitação	request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Fonte de pagamento automática	automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Message	message	string	A mensagem.
Dias agendados relativos	relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Número da fatura	invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	title	string	O título.
Description	description	string	A descrição.
Card	card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Etiqueta	label	string	O rótulo ou título do campo personalizado.
Value	value	string	O texto do campo personalizado.
Colocação	placement	string	O local do campo personalizado na fatura.
Data de venda ou serviço	sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Retornos

Nome	Caminho	Tipo	Description
ID	invoice.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoice.version	integer	A versão atual deste objeto.
ID do Local	invoice.location_id	string	O identificador do local.
ID do pedido	invoice.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	A ID gerada por quadrado.
Tipo de solicitação	invoice.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoice.payment_requests.due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Lembretes	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado.
Dias agendados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoice.payment_requests.reminders.message	string	A mensagem.
Situação	invoice.payment_requests.reminders.status	string	O status atual.
Quantidade	invoice.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoice.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoice.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Número da fatura	invoice.invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	invoice.title	string	O título.
Description	invoice.description	string	A descrição.
Agendado em	invoice.scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
Situação	invoice.status	string	O status de verificação atual desse objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoice.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	invoice.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do cliente	invoice.primary_recipient.customer_id	string	A ID do cliente associado ao pedido.
Nome	invoice.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoice.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoice.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
Card	invoice.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoice.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoice.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	O local do campo personalizado na fatura.
Método de entrega	invoice.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Data de venda ou serviço	invoice.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Criar grupo de clientes

ID da operação:: CustomGroupCreate

Cria um novo grupo de clientes para uma empresa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name		string	O nome do objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	group.id	string	O identificador exclusivo emitido por Quadrado.
Nome	group.name	string	O nome do objeto.
Criado em	group.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	group.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Criar ordem

ID da operação:: OrderCreate

Cria um novo pedido que pode incluir informações sobre produtos para compra e configurações a serem aplicadas à compra.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID de Referência	reference_id	string	Uma ID de referência opcional definida pelo usuário.
ID do Local	location_id	string	O identificador do local.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.
ID do objeto catalog	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
ID do objeto catalog	catalog_object_id	string	A ID do objeto de catálogo.
UID de desconto	discount_uid	string	A uid do desconto que o desconto aplicado representa.
UID	uid	string	A ID gerada por quadrado.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Porcentagem	percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Scope	scope	string	Indica o nível atual.
UID	uid	string	A ID gerada por quadrado.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Porcentagem	percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Scope	scope	string	Indica o nível atual.
ID do objeto catalog	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.

Retornos

Nome	Caminho	Tipo	Description
ID	order.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	order.location_id	string	O identificador do local.
Itens de Linha	order.line_items	array of object
UID	order.line_items.uid	string	A ID gerada por quadrado.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Impostos Aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Uma ID atribuída por quadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	A UID do imposto para o qual esse imposto aplicado representa.
Quantidade	order.line_items.applied_taxes.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_taxes.applied_money.currency	string	A moeda.
Descontos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Uma ID atribuída por quadrado.
UID de desconto	order.line_items.applied_discounts.discount_uid	string	A uid do desconto que o desconto aplicado representa.
Quantidade	order.line_items.applied_discounts.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Quantidade	order.line_items.variation_total_price_money.amount	integer	O valor.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
ID do objeto catalog	order.line_items.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Nome da variação	order.line_items.variation_name	string	O nome da variação aplicada a este item de linha.
Modificadores	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Uma ID atribuída por quadrado.
ID do objeto catalog	order.line_items.modifiers.catalog_object_id	string	A ID do objeto de catálogo.
Nome	order.line_items.modifiers.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.modifiers.base_price_money.amount	integer	O valor.
Moeda	order.line_items.modifiers.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.modifiers.total_price_money.amount	integer	O valor.
Moeda	order.line_items.modifiers.total_price_money.currency	string	A moeda.
Impostos	order.taxes	array of object
UID	order.taxes.uid	string	A ID gerada por quadrado.
Nome	order.taxes.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Tipo	order.taxes.type	string	Indica o tipo.
Porcentagem	order.taxes.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.taxes.applied_money.amount	integer	O valor.
Moeda	order.taxes.applied_money.currency	string	A moeda.
Scope	order.taxes.scope	string	Indica o nível atual.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	A ID gerada por quadrado.
ID do objeto catalog	order.discounts.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Nome	order.discounts.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Tipo	order.discounts.type	string	Indica o tipo.
Porcentagem	order.discounts.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.discounts.applied_money.amount	integer	O valor.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Scope	order.discounts.scope	string	Indica o nível atual.
Quantidade	order.discounts.amount_money.amount	integer	O valor.
Moeda	order.discounts.amount_money.currency	string	A moeda.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
ID de Referência	order.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Quantidade	order.total_money.amount	integer	O valor.
Moeda	order.total_money.currency	string	A moeda.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Quantidade	order.total_tip_money.amount	integer	O valor.
Moeda	order.total_tip_money.currency	string	A moeda.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.tip_money.amount	integer	O valor.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Nome	order.source.name	string	O nome.

Criar pagamento

ID da operação:: PaymentCreate

Cria um pagamento usando a fonte fornecida. Você pode usar esse ponto de extremidade para cobrar um cartão (cartão de crédito/débito ou cartão de presente square) ou registrar um pagamento que o vendedor recebeu fora da Square (pagamento em dinheiro de um comprador ou um pagamento que uma entidade externa processou em nome do vendedor).

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Quantidade	amount	integer	A quantidade de dinheiro a aceitar para esse pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.
ID de origem	source_id	string	A ID da fonte de fundos para esse pagamento. Isso pode ser um token de pagamento (nonce de cartão) gerado pelo formulário de pagamento Square ou um cartão no arquivo feito com a API de Clientes. Se estiver gravando um pagamento que o vendedor recebeu fora da Praça, especifique CASH ou EXTERNAL.
Preenchimento automático	autocomplete	boolean	Se definido como true, esse pagamento será concluído quando possível. Se definido como false, esse pagamento será mantido em um estado aprovado até que seja concluído explicitamente (capturado) ou cancelado (anulado).
ID do cliente	customer_id	string	A ID do cliente a ser vinculado.
ID do Local	location_id	string	O identificador de local.
ID de Referência	reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Observação	note	string	Uma anotação personalizada associada ao perfil do cliente.
Quantidade	amount	integer	A quantidade de dinheiro a aceitar para esse pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.

Retornos

Nome	Caminho	Tipo	Description
ID	payment.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	payment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	payment.amount_money.amount	integer	O valor.
Moeda	payment.amount_money.currency	string	A moeda.
Quantidade	payment.app_fee_money.amount	integer	O valor.
Moeda	payment.app_fee_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual desse objeto.
Duração do atraso	payment.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento. Esse delay_action automático se aplica somente a pagamentos que não atingem um estado terminal (CONCLUÍDO, CANCELADO ou COM FALHA) antes do período de delay_duration. Esse campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de Fonte	payment.source_type	string	O tipo de origem desse pagamento. Os valores atuais incluem CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Situação	payment.card_details.status	string	O status atual.
Marca de cartão	payment.card_details.card.card_brand	string	A marca do cartão.
Últimos 4	payment.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payment.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payment.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payment.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payment.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Método entry	payment.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
CVV Status	payment.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
AVS Status	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payment.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payment.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payment.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
Capturado em	payment.card_details.card_payment_timeline.captured_at	string	O carimbo de data/hora quando o pagamento foi capturado, no formato RFC 3339.
ID do Local	payment.location_id	string	O identificador do local.
ID do pedido	payment.order_id	string	A ID da ordem.
ID de Referência	payment.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Criado em	payment.risk_evaluation.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
Nível de risco	payment.risk_evaluation.risk_level	string	O nível de risco associado ao pagamento.
Observação	payment.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do cliente	payment.customer_id	string	A ID desse objeto que representa o cliente.
Quantidade	payment.total_money.amount	integer	O valor.
Moeda	payment.total_money.currency	string	A moeda.
Quantidade	payment.approved_money.amount	integer	O valor.
Moeda	payment.approved_money.currency	string	A moeda.
Número do recibo	payment.receipt_number	string	O número do recibo do pagamento. O campo estará ausente se um pagamento for cancelado.
URL de recebimento	payment.receipt_url	string	A URL do recibo do pagamento. O campo só é preenchido para pagamentos COMPLETED.
Ação de atraso	payment.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payment.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payment.application_details.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Token da versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Criar reembolso de terminal

ID da operação:: TerminalCreateRefund

Cria uma solicitação para reembolsar um pagamento interac concluído em um Terminal Quadrado.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.
ID do dispositivo	device_id	string	A ID exclusiva do dispositivo destinado a este TerminalRefund.
Reason	reason	string	O motivo desse objeto.
ID de pagamento	payment_id	string	A ID exclusiva do pagamento.

Retornos

Nome	Caminho	Tipo	Description
ID	refund.id	string	O identificador exclusivo emitido por Quadrado.
ID de pagamento	refund.payment_id	string	A ID exclusiva do pagamento.
Quantidade	refund.amount_money.amount	integer	O valor.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	O motivo desse objeto.
ID do dispositivo	refund.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalRefund.
Duração do prazo	refund.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Situação	refund.status	string	O status de verificação atual desse objeto.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	refund.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	refund.app_id	string	A ID do aplicativo que criou o check-out.
Marca de cartão	refund.card.card_brand	string	A marca do cartão.
last_4	refund.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	refund.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	refund.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	refund.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	refund.card.card_type	string	O tipo do cartão.
ESCANINHO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
ID do pedido	refund.order_id	string	A ID da ordem.
ID do Local	refund.location_id	string	O identificador do local.

Criar texto de evidência de controvérsia

ID da operação:: DisputeCreateEvidenceText

Carrega o texto a ser usado como evidência para um desafio de disputa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.
Tipo de evidência	evidence_type		string	O tipo de evidência que você está carregando.
Texto de evidência	evidence_text		string	A cadeia de caracteres de evidência.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	evidence.id	string	O identificador exclusivo emitido por Quadrado.
ID da disputa	evidence.dispute_id	string	A ID da disputa à qual a evidência está associada.
Texto de evidência	evidence.evidence_text	string	O texto bruto.
Tipo de evidência	evidence.evidence_type	string	O tipo de evidência pf.
Carregado em	evidence.uploaded_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.

Criar um cliente

ID da operação:: CustomerCreate

Cria um novo cliente para uma empresa.

Parâmetros

Nome	Chave	Tipo	Description
Nome	given_name	string	O nome fornecido (ou seja, o primeiro nome) associado ao perfil do cliente.
Sobrenome	family_name	string	O nome da família (ou seja, o sobrenome) associado ao perfil do cliente.
Endereço de Email	email_address	string	O endereço de email associado ao perfil do cliente.
Nome da Empresa	company_name	string	Um nome comercial associado ao perfil do cliente.
Nickname	nickname	string	Um apelido para o perfil do cliente.
Linha de endereço 1	address_line_1	string	A primeira linha do endereço.
Linha de endereço 2	address_line_2	string	A segunda linha do endereço, se houver.
Localidade	locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	postal_code	string	O código postal do endereço.
País	country	string	O código de país ISO 3166 Alpha-2.
Número de Telefone	phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
ID de Referência	reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Observação	note	string	Uma anotação personalizada associada ao perfil do cliente.
Aniversário	birthday	string	O aniversário associado ao perfil do cliente, no formato RFC 3339. O ano é opcional. O fuso horário e a hora não são permitidos. Por exemplo, 0000-09-21T00:00:00-00:00 representa um aniversário em 21 de setembro e 1998-09-21T00:00:00-00:00 representa um aniversário em 21 de setembro de 1998. Você também pode especificar esse valor no formato YYYY-MM-DD.

Retornos

Nome	Caminho	Tipo	Description
ID	customer.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	customer.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Nome	customer.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	customer.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	customer.email_address	string	O endereço de email associado ao perfil do cliente.
Nome da Empresa	customer.company_name	string	Um nome comercial associado ao perfil do cliente.
Nickname	customer.nickname	string	Um apelido para o perfil do cliente.
Linha de endereço 1	customer.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	customer.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	customer.address.postal_code	string	O código postal do endereço.
País	customer.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Número de Telefone	customer.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
ID de Referência	customer.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Observação	customer.note	string	Uma anotação personalizada associada ao perfil do cliente.
Aniversário	customer.birthday	string	O aniversário associado ao perfil do cliente, no formato RFC 3339. O ano é opcional. O fuso horário e a hora não são permitidos. Por exemplo, 0000-09-21T00:00:00-00:00 representa um aniversário em 21 de setembro e 1998-09-21T00:00:00-00:00 representa um aniversário em 21 de setembro de 1998.
Email não assinado	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a assinatura de emails de campanha de marketing. Um valor verdadeiro significa que o cliente optou por recusar o marketing de email do vendedor da Square atual ou de todos os vendedores da Square.
Origem da criação	customer.creation_source	string	Uma fonte de criação representa o método usado para criar o perfil do cliente.
Versão	customer.version	integer	A versão atual deste objeto.

Desabilitar cartão

ID da operação:: CardDisable

Desabilita o cartão, impedindo quaisquer atualizações ou encargos adicionais. A desabilitação de um cartão já desabilitado é permitida, mas não tem efeito.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Cartão	card_id	True	string	O identificador do cartão.

Retornos

Nome	Caminho	Tipo	Description
ID	card.id	string	O identificador exclusivo emitido por Quadrado.
Linha de endereço 1	card.billing_address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	card.billing_address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	card.billing_address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	card.billing_address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	card.billing_address.postal_code	string	O código postal do endereço.
País	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
ESCANINHO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Marca de cartão	card.card_brand	string	A marca do cartão.
Tipo de cartão	card.card_type	string	O tipo do cartão.
Nome do titular do cartão	card.cardholder_name	string	O nome do titular do cartão.
ID do cliente	card.customer_id	string	A ID desse objeto que representa o cliente.
Enabled	card.enabled	boolean	Se estiver habilitado.
Mês exp	card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Últimos 4	card.last_4	string	Os últimos 4 dígitos do número do cartão.
Tipo pré-pago	card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ID de Referência	card.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Versão	card.version	integer	A versão atual deste objeto.

Enviar evidência

ID da operação:: EvidenceSubmit

Envia provas ao banco do titular do cartão. Antes de enviar provas, Square compila todas as evidências disponíveis. Isso inclui evidências carregadas usando os pontos de extremidade CreateDisputeEvidenceFile e CreateDisputeEvidenceText e evidências fornecidas automaticamente pelo Square, quando disponíveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.

Retornos

Nome	Caminho	Tipo	Description
ID	dispute.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	dispute.amount_money.amount	integer	O valor.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	O motivo desse objeto.
Estado	dispute.state	string	O estado atual.
Conclusão em	dispute.due_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.
Pagamentos Contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID exclusiva gerada por quadrado do pagamento.
Marca de cartão	dispute.card_brand	string	A marca do cartão.
Criado em	dispute.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	dispute.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	A ID da disputa no sistema de marca de cartão, gerada pela marca de cartão.

Excluir clientes

ID da operação:: CustomerDelete

Exclui um perfil de cliente de uma empresa. Essa operação também desvincula os cartões associados no arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customer_id	True	string	O identificador do cliente.

Retornos

response: object

Excluir evidência de controvérsia

ID da operação:: DisputeDeleteEvidence

Remove a evidência especificada de uma disputa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.
ID da evidência	evidence_id	True	string	O identificador da evidência.

Retornos

response: object

Excluir fatura

ID da operação:: InvoiceDelete

Exclui a fatura especificada. Quando uma fatura é excluída, o status do pedido associado é alterado para CANCELED. Você só pode excluir uma fatura de rascunho (não é possível excluir uma fatura publicada, incluindo uma agendada para processamento).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Versão	version		integer	A versão da fatura a ser excluída.

Retornos

response: object

Excluir grupo de clientes

ID da operação:: CustomerGroupDelete

Exclui um grupo de clientes, conforme identificado pelo valor group_id.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.

Retornos

response: object

Excluir objeto de catálogo

ID da operação:: CatalogDelete

Exclui um único CatalogObject com base na ID fornecida e retorna o conjunto de IDs excluídas com êxito na resposta. A exclusão é um evento em cascata, de modo que todos os filhos do objeto de destino também sejam excluídos. Por exemplo, excluir um CatalogItem também excluirá todos os seus filhos CatalogItemVariation.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do objeto	object_id	True	string	O identificador do objeto.

Retornos

Nome	Caminho	Tipo	Description
IDs de objeto excluídas	deleted_object_ids	array of string
Excluído em	deleted_at	string	O carimbo de data/hora do banco de dados dessa exclusão no formato RFC 3339

Informações do catálogo

ID da operação:: CatalogInfo

Recupera informações sobre a API do Catálogo Quadrado, como limites de tamanho de lote que podem ser usados pelo ponto de extremidade BatchUpsertCatalogObjects.

Retornos

Nome	Caminho	Tipo	Description
Objetos máximos upsert do lote por lote	limits.batch_upsert_max_objects_per_batch	integer	O número máximo de objetos que podem aparecer em um único lote em uma solicitação /v2/catalog/batch-upsert.
Total máximo de objetos upsert do lote	limits.batch_upsert_max_total_objects	integer	O número máximo de objetos que podem aparecer em todos os lotes em uma solicitação /v2/catalog/batch-upsert.
Recuperar IDs máximas do objeto em lote	limits.batch_retrieve_max_object_ids	integer	O número máximo de IDs de objeto que podem aparecer em uma solicitação /v2/catalog/batch-retrieve.
Limite máximo de página de pesquisa	limits.search_max_page_limit	integer	O número máximo de resultados que podem ser retornados em uma página de uma resposta /v2/catalog/search.
IDs máximas de objeto de exclusão em lote	limits.batch_delete_max_object_ids	integer	O número máximo de IDs de objeto que podem ser incluídas em uma única solicitação /v2/catalog/batch-delete.
Atualizar IDs máximas de item de impostos de item	limits.update_item_taxes_max_item_ids	integer	O número máximo de IDs de item que podem ser incluídas em uma única solicitação /v2/catalog/update-item-taxes.
Atualizar impostos de item máximo impostos para habilitar	limits.update_item_taxes_max_taxes_to_enable	integer	O número máximo de IDs fiscais a serem habilitadas que podem ser incluídas em uma única solicitação /v2/catalog/update-item-tax.
Atualizar impostos de item máximo impostos para desabilitar	limits.update_item_taxes_max_taxes_to_disable	integer	O número máximo de IDs fiscais a serem desabilitadas que podem ser incluídas em uma única solicitação /v2/catalog/update-item-tax.
Atualizar modificador de item lista ids máximas de item	limits.update_item_modifier_lists_max_item_ids	integer	O número máximo de IDs fiscais a serem desabilitadas que podem ser incluídas em uma única solicitação /v2/catalog/update-item-tax.
Modificador de item de atualização lista listas de modificadores máximos para habilitar	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	O número máximo de IDs de lista de modificadores a serem habilitadas que podem ser incluídas em uma única solicitação /v2/catalog/update-item-modifier-lists.
Modificador de Item de Atualização lista listas de modificadores máximos para desabilitar	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	O número máximo de IDs de lista de modificadores a serem desabilitadas que podem ser incluídas em uma única solicitação /v2/catalog/update-item-modifier-lists.

Inventário de alteração em lote

ID da operação:: InventoryBatchChange

Aplica ajustes e contagens às quantidades de item fornecidas. Com êxito: retorna as contagens calculadas atuais para todos os objetos referenciados na solicitação.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Tipo	type	string	O tipo desse objeto.
ID de Referência	reference_id	string	Uma ID de referência opcional definida pelo usuário que associa esse cartão a outra entidade em um sistema externo.
ID do objeto catalog	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Estado	state	string	O estado de inventário atual para a quantidade relacionada de itens.
ID do Local	location_id	string	A ID do local de um destinatário (diferente do comerciante) recebendo uma parte desta licitação.
Quantidade	quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
ID do Funcionário	employee_id	string	A ID gerada por quadrado do Funcionário responsável pela contagem física.
Ocorreu em	occurred_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando a contagem física foi examinada. Para atualizações de contagem física, o carimbo de data/hora occurred_at não pode ter mais de 24 horas ou no futuro em relação à hora da solicitação.
Ignorar contagens inalteradas	ignore_unchanged_counts	boolean	Indica se a contagem física atual deve ser ignorada se a quantidade estiver inalterada desde a última contagem física.

Retornos

Nome	Caminho	Tipo	Description
Conta	counts	array of object
ID do objeto catalog	counts.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	counts.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Estado	counts.state	string	O estado atual.
ID do Local	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física ou o ajuste mais recente que afeta a contagem estimada é recebido.

Listar cartões

ID da operação:: CardList

Recupera uma lista de cartões pertencentes à conta que está fazendo a solicitação.

Parâmetros

Nome	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
ID do cliente	customer_id	string	Limite os resultados aos cartões associados ao cliente fornecido. Por padrão, todos os cartões pertencentes ao comerciante são retornados.
Incluir Desabilitado	include_disabled	boolean	Inclui cartões desabilitados. Por padrão, todos os cartões habilitados pertencentes ao comerciante são retornados.
ID de Referência	reference_id	string	Limite os resultados aos cartões associados ao reference_id fornecido.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.

Retornos

Nome	Caminho	Tipo	Description
Cards	cards	array of object
ID	cards.card.id	string	O identificador do objeto
Linha de endereço 1	cards.card.billing_address.address_line_1	string	Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	cards.card.billing_address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	cards.card.billing_address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	cards.card.billing_address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	cards.card.billing_address.postal_code	string	O código postal do endereço.
País	cards.card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	cards.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
ESCANINHO	cards.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Marca de cartão	cards.card.card_brand	string	A marca do cartão.
Tipo de cartão	cards.card.card_type	string	O tipo do cartão.
Nome do titular do cartão	cards.card.cardholder_name	string	O nome do titular do cartão.
ID do cliente	cards.card.customer_id	string	A ID de um cliente a ser associada ao cartão.
Enabled	cards.card.enabled	boolean	Indica se um objeto pode ou não ser usado.
Mês de Expiração	cards.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano de Expiração	cards.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Últimos 4	cards.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Tipo pré-pago	cards.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ID de Referência	cards.card.reference_id	string	Uma ID de referência opcional definida pelo usuário que associa esse cartão a outra entidade em um sistema externo.
Versão	cards.card.version	integer	Número da versão atual do cartão. Incrementos com cada atualização de cartão. As solicitações para atualizar um objeto Card existente serão rejeitadas, a menos que a versão na solicitação corresponda à versão atual do Cartão.

Listar clientes

ID da operação:: CustomerList

Lista perfis de clientes associados a uma conta Square. Em condições operacionais normais, os perfis de cliente recém-criados ou atualizados ficam disponíveis para a operação de listagem em menos de 30 segundos. Ocasionalmente, a propagação dos perfis novos ou atualizados pode levar mais de um minuto ou mais, especialmente durante incidentes de rede e interrupções.

Parâmetros

Nome	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Campo classificar	sort_field	string	Indica como os clientes devem ser classificados. O valor padrão é DEFAULT.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.

Retornos

Nome	Caminho	Tipo	Description
Clientes	customers	array of object
ID	customers.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	customers.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	customers.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Nome	customers.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	customers.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	customers.email_address	string	O endereço de email associado ao perfil do cliente.
Linha de endereço 1	customers.address.address_line_1	string	A primeira linha do endereço.
Linha de endereço 2	customers.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customers.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	customers.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	customers.address.postal_code	string	O código postal do endereço.
País	customers.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Número de Telefone	customers.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
ID de Referência	customers.reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Observação	customers.note	string	Uma anotação personalizada associada ao perfil do cliente.
Email não assinado	customers.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a assinatura de emails de campanha de marketing. Um valor verdadeiro significa que o cliente optou por recusar o marketing de email do vendedor da Square atual ou de todos os vendedores da Square. Esse valor é somente leitura da API de Clientes.
Origem da criação	customers.creation_source	string	Uma fonte de criação representa o método usado para criar o perfil do cliente.
IDs de grupo	customers.group_ids	array of string
IDs de segmento	customers.segment_ids	array of string
Versão	customers.version	integer	A versão atual do objeto.

Listar disputas

ID da operação:: DisputeList

Retorna uma lista de disputas associadas a uma conta específica.

Parâmetros

Nome	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
States	states	string	A disputa se declara para filtrar o resultado. Se não for especificado, o ponto de extremidade retornará todas as disputas abertas (o status da disputa não é INQUIRY_CLOSED, WON ou LOST).
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Retornos

Nome	Caminho	Tipo	Description
Disputas	disputes	array of object
ID	disputes.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	disputes.amount_money.amount	integer	O valor.
Moeda	disputes.amount_money.currency	string	A moeda.
Reason	disputes.reason	string	O motivo da disputa pelo qual o titular do cartão iniciou a disputa com seu banco.
Estado	disputes.state	string	O estado atual.
Conclusão em	disputes.due_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.
Pagamentos Contestados	disputes.disputed_payments	array of object
ID de pagamento	disputes.disputed_payments.payment_id	string	ID exclusiva gerada por quadrado do pagamento que está sendo contestado.
Marca de cartão	disputes.card_brand	string	A marca de cartão usada no pagamento contestado.
Criado em	disputes.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	disputes.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
ID de disputa de marca	disputes.brand_dispute_id	string	A ID da disputa no sistema de marca de cartão, gerada pela marca de cartão.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar eventos de assinatura

ID da operação:: SubscriptionListEvents

Lista todos os eventos para uma assinatura específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscription_id	True	string	O identificador da assinatura.

Retornos

Nome	Caminho	Tipo	Description
Eventos de assinatura	subscription_events	array of object
ID	subscription_events.id	string	O identificador exclusivo emitido por Quadrado.
Tipo de evento de assinatura	subscription_events.subscription_event_type	string	Tipo do evento de assinatura.
Data de Vigência	subscription_events.effective_date	string	A data, no formato YYYY-MM-DD, quando o evento de assinatura entrou em vigor.
ID do Plano	subscription_events.plan_id	string	A ID do plano de assinatura associado

Listar faturas

ID da operação:: InvoiceList

Retorna uma lista de faturas para um determinado local.

Parâmetros

Nome	Chave	Tipo	Description
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.

Retornos

Nome	Caminho	Tipo	Description
Invoices	invoices	array of object
ID	invoices.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoices.version	integer	A versão atual do objeto.
ID do Local	invoices.location_id	string	O identificador do local.
ID do pedido	invoices.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	A ID gerada por Quadrado da solicitação de pagamento em uma fatura.
Tipo de solicitação	invoices.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoices.payment_requests.due_date	string	A data de conclusão (no fuso horário da fatura) para a solicitação de pagamento, no formato YYY-MM-DD.
Inflexão Habilitada	invoices.payment_requests.tipping_enabled	boolean	Se definido como true, a página da fatura hospedada na Praça (o campo public_url da fatura) fornece um local para o cliente pagar uma gorjeta.
Lembretes	invoices.payment_requests.reminders	array of object	Lembretes
UID	invoices.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado que identifica exclusivamente o lembrete no InvoicePaymentRequest.
Dias agendados relativos	invoices.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoices.payment_requests.reminders.message	string	A mensagem de lembrete.
Situação	invoices.payment_requests.reminders.status	string	O status do lembrete.
Quantidade	invoices.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoices.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoices.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoices.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoices.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Porcentagem solicitada	invoices.payment_requests.percentage_requested	string	Especifica o valor da solicitação de pagamento em porcentagem.
ID do Cartão	invoices.payment_requests.card_id	string	A ID do cartão de crédito ou débito no arquivo a ser cobrado pela solicitação de pagamento.
Número da fatura	invoices.invoice_number	string	Um número de fatura amigável.
Title	invoices.title	string	O título da fatura.
Description	invoices.description	string	A descrição.
Agendado em	invoices.scheduled_at	string	O carimbo de data/hora quando a fatura é agendada para processamento, no formato RFC 3339. Depois que a fatura é publicada, a Square processa a fatura na data especificada, de acordo com o método de entrega e as configurações de solicitação de pagamento.
Situação	invoices.status	string	O status de verificação atual desse objeto.
Timezone	invoices.timezone	string	O fuso horário usado para interpretar datas de calendário na fatura, como due_date. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoices.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	invoices.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
ID do cliente	invoices.primary_recipient.customer_id	string	A ID de um cliente a ser associada ao cartão.
Nome	invoices.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoices.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoices.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoices.primary_recipient.phone_number	string	O número de telefone do destinatário.
Card	invoices.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoices.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoices.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoices.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoices.custom_fields.placement	string	O local do campo personalizado na fatura
Método de entrega	invoices.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente.
Data de venda ou serviço	invoices.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.
URL pública	invoices.public_url	string	A URL da página da fatura hospedada na Praça. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, o Square hospeda a página da fatura e retorna a URL da página na resposta.
Quantidade	invoices.next_payment_amount_money.amount	integer	O valor.
Moeda	invoices.next_payment_amount_money.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar grupos de clientes

ID da operação:: CustomerGroupList

Recupera a lista de grupos de clientes de uma empresa.

Retornos

Nome	Caminho	Tipo	Description
Groups	groups	array of object
ID	groups.id	string	O identificador exclusivo emitido por Quadrado.
Nome	groups.name	string	O nome do objeto.
Criado em	groups.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	groups.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339

Listar pagamentos

ID da operação:: PaymentList

Recupera uma lista de pagamentos feitos pela conta que está fazendo a solicitação. Os resultados são eventualmente consistentes, e novos pagamentos ou alterações nos pagamentos podem levar vários segundos para aparecer.

Parâmetros

Nome	Chave	Tipo	Description
Hora de Início	begin_time	string	A hora de início inclusiva da consulta em opened_at, no formato ISO 8601.
Hora de Término	end_time	string	A data de término exclusiva da consulta em opened_at, no formato ISO 8601.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Total	total	integer	O valor exato no total_money para um pagamento.
Últimos 4	last_4	string	Os últimos quatro dígitos de um cartão de pagamento.
Marca de cartão	card_brand	string	A marca do cartão de pagamento (por exemplo, VISA).
Limit	limit	integer	Limite superior no número a ser retornado na resposta.

Retornos

Nome	Caminho	Tipo	Description
Payments	payments	array of object
ID	payments.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payments.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	payments.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Quantidade	payments.amount_money.amount	integer	O valor.
Moeda	payments.amount_money.currency	string	A moeda.
Situação	payments.status	string	O status de verificação atual desse objeto.
Duração do atraso	payments.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento.
Tipo de Fonte	payments.source_type	string	O tipo de origem desse pagamento.
Situação	payments.card_details.status	string	O estado atual do pagamento do cartão. O estado pode ser AUTHORIZED, CAPTURED, VOIDED ou FAILED.
Marca de cartão	payments.card_details.card.card_brand	string	A marca do cartão.
last_4	payments.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payments.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payments.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payments.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payments.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payments.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payments.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária)
Método entry	payments.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Cvv Status	payments.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Avs Status	payments.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payments.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payments.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payments.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
Capturado em	payments.card_details.card_payment_timeline.captured_at	string	O carimbo de data/hora quando o pagamento foi capturado, no formato RFC 3339.
ID do Local	payments.location_id	string	O identificador do local.
ID do pedido	payments.order_id	string	A ID da ordem.
Taxa de Processamento	payments.processing_fee	array of object
Efetivo em	payments.processing_fee.effective_at	string	O carimbo de data/hora de quando a taxa entra em vigor, no formato RFC 3339.
Tipo	payments.processing_fee.type	string	O tipo desse objeto.
Quantidade	payments.processing_fee.amount_money.amount	integer	O valor.
Moeda	payments.processing_fee.amount_money.currency	string	A moeda.
Observação	payments.note	string	Uma anotação personalizada associada ao perfil do cliente.
Quantidade	payments.total_money.amount	integer	O valor.
Moeda	payments.total_money.currency	string	A moeda.
Quantidade	payments.approved_money.amount	integer	O valor.
Moeda	payments.approved_money.currency	string	A moeda.
Número do recibo	payments.receipt_number	string	O número do recibo do pagamento. O campo estará ausente se um pagamento for cancelado.
URL de recebimento	payments.receipt_url	string	A URL do recibo do pagamento. O campo só é preenchido para pagamentos COMPLETED.
Ação de atraso	payments.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payments.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
ID do membro da equipe	payments.team_member_id	string	A ID do objeto TeamMember para o membro da equipe associado ao objeto.
Produto Quadrado	payments.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payments.application_details.application_id	string	A ID quadrada atribuída ao aplicativo usado para receber o pagamento. Os desenvolvedores de aplicativos podem usar essas informações para identificar pagamentos processados pelo aplicativo. Por exemplo, se um desenvolvedor usa um aplicativo personalizado para processar pagamentos, esse campo contém a ID do aplicativo do Painel do Desenvolvedor. Se um vendedor usar um aplicativo do Square App Marketplace para processar pagamentos, o campo conterá a ID do aplicativo correspondente.
Token da versão	payments.version_token	string	Usado para simultaneidade otimista. Esse token opaco identifica uma versão específica do objeto Payment.

Listar provas de controvérsia

ID da operação:: DisputeListEvidence

Retorna uma lista de evidências associadas a uma disputa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.

Retornos

Nome	Caminho	Tipo	Description
Evidence	evidence	array of object
ID	evidence.id	string	O identificador exclusivo emitido por Quadrado.
ID da disputa	evidence.dispute_id	string	A ID da disputa à qual a evidência está associada.
Texto de evidência	evidence.evidence_text	string	O texto bruto.
Tipo de evidência	evidence.evidence_type	string	O tipo da evidência.
Carregado em	evidence.uploaded_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.
ID da evidência	evidence.evidence_id	string	A ID gerada por Quadrado da evidência.
Nome do Arquivo	evidence.evidence_file.filename	string	O nome do arquivo, incluindo a extensão de arquivo
Tipo de arquivo	evidence.evidence_file.filetype	string	Os arquivos de evidência de controvérsia devem ser formatos application/pdf, image/heic, image/heif, image/jpeg, image/png ou image/tiff.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar reembolsos de pagamento

ID da operação:: RefundList

Recupera uma lista de reembolsos para a conta que está fazendo a solicitação. Os resultados são eventualmente consistentes, e novos reembolsos ou alterações nos reembolsos podem levar vários segundos para aparecer.

Parâmetros

Nome	Chave	Tipo	Description
Hora de Início	begin_time	string	A hora de início inclusiva da consulta em opened_at, no formato ISO 8601.
Hora de Término	end_time	string	A data de término exclusiva da consulta em opened_at, no formato ISO 8601.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Situação	status	string	Se especificado, retorna apenas objetos que correspondem aos status especificados.
Tipo de Fonte	source_type	string	Se fornecido, somente os reembolsos com o tipo de origem fornecido serão retornados.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.

Retornos

Nome	Caminho	Tipo	Description
Restituições	refunds	array of object
ID	refunds.id	string	O identificador exclusivo emitido por Quadrado.
Situação	refunds.status	string	O status de verificação atual desse objeto.
Quantidade	refunds.amount_money.amount	integer	O valor.
Moeda	refunds.amount_money.currency	string	A moeda.
ID de pagamento	refunds.payment_id	string	A ID do pagamento.
ID do pedido	refunds.order_id	string	A ID da ordem.
Criado em	refunds.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	refunds.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Taxa de Processamento	refunds.processing_fee	array of object
Efetivo em	refunds.processing_fee.effective_at	string	O carimbo de data/hora de quando a taxa entra em vigor, no formato RFC 3339.
Tipo	refunds.processing_fee.type	string	O tipo desse objeto.
Quantidade	refunds.processing_fee.amount_money.amount	integer	O valor.
Moeda	refunds.processing_fee.amount_money.currency	string	A moeda.
ID do Local	refunds.location_id	string	O identificador do local.
Reason	refunds.reason	string	O motivo da disputa pelo qual o titular do cartão iniciou a disputa com seu banco.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar segmentos de clientes

ID da operação:: CustomerSegmentList

Recupera a lista de segmentos de clientes de uma empresa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Limit	limit		integer	Limite superior no número a ser retornado na resposta.

Retornos

Nome	Caminho	Tipo	Description
Segmentos	segments	array of object
ID	segments.id	string	O identificador exclusivo emitido por Quadrado.
Nome	segments.name	string	O nome do objeto.
Criado em	segments.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	segments.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339

Objeto de catálogo upsert

ID da operação:: CatalogUpsert

Cria ou atualiza o CatalogObject de destino.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID	id	string	O identificador exclusivo emitido por Quadrado.
Tipo	type	string	O tipo desse objeto.
Abreviação	abbreviation	string	O texto do rótulo de exibição do item no aplicativo Square Point of Sale. Somente até os cinco primeiros caracteres da cadeia de caracteres são usados. Esse atributo é pesquisável e seu tamanho de valor é de pontos de código Unicode.
Description	title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Nome	name	string	O nome.
ID	id	string	Um identificador para fazer referência a esse objeto no catálogo.
Tipo	type	string	O tipo desse objeto.
Item ID	item_id	string	A ID do CatalogItem associado a essa variação de item.
Nome	name	string	O nome da variação do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Tipo de preço	pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.

Retornos

Nome	Caminho	Tipo	Description
Tipo	catalog_object.type	string	O tipo desse objeto.
ID	catalog_object.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	catalog_object.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Versão	catalog_object.version	integer	A versão atual deste objeto.
Está Excluído	catalog_object.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	catalog_object.item_data.name	string	O nome.
Description	catalog_object.item_data.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Abreviação	catalog_object.item_data.abbreviation	string	O texto do rótulo de exibição do item no aplicativo Square Point of Sale. Somente até os cinco primeiros caracteres da cadeia de caracteres são usados. Esse atributo é pesquisável e seu tamanho de valor é de pontos de código Unicode.
Variações	catalog_object.item_data.variations	array of object
Tipo	catalog_object.item_data.variations.type	string	O tipo desse objeto.
ID	catalog_object.item_data.variations.id	string	Um identificador para fazer referência a esse objeto no catálogo.
Atualizado em	catalog_object.item_data.variations.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339.
Versão	catalog_object.item_data.variations.version	integer	A versão do objeto. Ao atualizar um objeto, a versão fornecida deve corresponder à versão no banco de dados, caso contrário, a gravação será rejeitada como conflitante.
Está Excluído	catalog_object.item_data.variations.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	catalog_object.item_data.variations.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Item ID	catalog_object.item_data.variations.item_variation_data.item_id	string	A ID do CatalogItem associado a essa variação de item.
Nome	catalog_object.item_data.variations.item_variation_data.name	string	O nome da variação do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Ordinal	catalog_object.item_data.variations.item_variation_data.ordinal	integer	A ordem na qual essa variação de item deve ser exibida. Esse valor é somente leitura. Em gravações, o ordinal para cada variação de item em um CatalogItem pai é definido de acordo com a posição das variações de item. Em leituras, o valor não é garantido como sequencial ou exclusivo.
Tipo de preço	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Abastecável	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Se as ações são contadas diretamente nessa variação (TRUE) ou apenas em seus componentes (FALSE). Para valores ausentes de compatibilidade com versões anteriores, serão interpretados como TRUE.
Quantidade	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	O valor.
Moeda	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	A moeda.
Tipo de Produto	catalog_object.item_data.product_type	string	O tipo de produto do item. Pode não ser alterado depois que um item é criado.
Mapeamentos de ID	id_mappings	array of object
ID do objeto cliente	id_mappings.client_object_id	string	A ID #prefixada temporária fornecida pelo cliente para um novo CatalogObject.
ID do objeto	id_mappings.object_id	string	A ID permanente criada pelo servidor.

Objetos de catálogo de exclusão em lote

ID da operação:: CatalogBatchDelete

Exclui um conjunto de CatalogItems com base na lista fornecida de IDs de destino e retorna um conjunto de IDs excluídas com êxito na resposta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
IDs de objeto	object_ids		array of string

Retornos

Nome	Caminho	Tipo	Description
IDs de objeto excluídas	deleted_object_ids	array of string
Excluído em	deleted_at	string	O carimbo de data/hora do banco de dados dessa exclusão no formato RFC 3339

Objetos de catálogo de recuperação de lote

ID da operação:: CatalogBatchRetrieve

Retorna um conjunto de objetos com base na ID fornecida. Cada CatalogItem retornado no conjunto inclui todas as suas informações filho, incluindo: todos os seus objetos CatalogItemVariation, referências a seus objetos CatalogModifierList e as IDs de todos os objetos CatalogTax que se aplicam a ele.

Parâmetros

Nome	Chave	Tipo	Description
IDs de objeto	object_ids	array of string
Versão do catálogo	catalog_version	integer	A versão específica dos objetos de catálogo a serem incluídos na resposta. Isso permite que você recupere versões históricas de objetos. O valor de versão especificado é correspondido ao atributo de versão do CatalogObjects.
Incluir objetos relacionados	include_related_objects	boolean	Se for true, a resposta incluirá objetos adicionais relacionados aos objetos solicitados, da seguinte maneira: se o campo objetos da resposta contiver um CatalogItem, seus objetos CatalogCategory associados, objetos CatalogTax, objetos CatalogImage e CatalogModifierLists serão retornados no campo related_objects da resposta. Se o campo objetos da resposta contiver uma CatalogItemVariation, seu CatalogItem pai será retornado no campo related_objects da resposta.

Retornos

Nome	Caminho	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	O tipo desse objeto.
ID	objects.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	objects.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.version	integer	A versão atual do objeto.
Está Excluído	objects.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	objects.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	objects.item_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Description	objects.item_data.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
ID da categoria	objects.item_data.category_id	string	A ID da categoria do item, se houver.
IDs tributários	objects.item_data.tax_ids	array of string
Variações	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	O tipo desse objeto. Cada tipo de objeto tem propriedades esperadas expressas em um formato estruturado dentro de seu campo *_data correspondente abaixo.
ID	objects.item_data.variations.id	string	Um identificador para fazer referência a esse objeto.
Atualizado em	objects.item_data.variations.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.item_data.variations.version	integer	A versão do objeto. Ao atualizar um objeto, a versão fornecida deve corresponder à versão no banco de dados, caso contrário, a gravação será rejeitada como conflitante.
Está Excluído	objects.item_data.variations.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Apresentar em todos os locais	objects.item_data.variations.present_at_all_locations	boolean	Uma lista de locais em que o objeto está presente, mesmo que present_at_all_locations seja false. Isso pode incluir locais desativados.
Item ID	objects.item_data.variations.item_variation_data.item_id	string	A ID do objeto com essa variação de item.
Nome	objects.item_data.variations.item_variation_data.name	string	O nome deste item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem na qual essa variação de item deve ser exibida. Esse valor é somente leitura.
Tipo de preço	objects.item_data.variations.item_variation_data.pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Quantidade	objects.item_data.variations.item_variation_data.price_money.amount	integer	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda. Por exemplo, quando a moeda é USD, o valor está em centavos. Os valores monetários podem ser positivos ou negativos. Consulte a descrição de campo específica para determinar o significado do sinal em um caso específico.
Moeda	objects.item_data.variations.item_variation_data.price_money.currency	string	O tipo de moeda, no formato ISO 4217. Por exemplo, o código de moeda para dólares americanos é USD.
Objetos relacionados	related_objects	array of object
Tipo	related_objects.type	string	O tipo desse objeto.
ID	related_objects.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	related_objects.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	related_objects.version	integer	A versão atual do objeto.
Está Excluído	related_objects.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	related_objects.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	related_objects.category_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Nome	related_objects.tax_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Fase de cálculo	related_objects.tax_data.calculation_phase	string	Se o imposto é calculado com base no subtotal ou no total de um pagamento.
Tipo de inclusão	related_objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Porcentagem	related_objects.tax_data.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Enabled	related_objects.tax_data.enabled	boolean	Indica se um objeto pode ou não ser usado.

Objetos de catálogo upsert do lote

ID da operação:: CatalogBatchUpsert

Cria ou atualiza até 10.000 objetos de destino com base na lista de objetos fornecida. Os objetos de destino são agrupados em lotes e cada lote é inserido/atualizado de maneira tudo ou nada. Se um objeto dentro de um lote for malformado de alguma forma ou violar uma restrição de banco de dados, todo o lote que contém esse item será desconsiderado. No entanto, outros lotes na mesma solicitação ainda podem ter êxito. Cada lote pode conter até 1.000 objetos e lotes serão processados em ordem, desde que a contagem total de objetos para a solicitação (itens, variações, listas de modificadores, descontos e impostos) não seja superior a 10.000.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Tipo	type	string	O tipo desse objeto.
ID	id	string	Um identificador para fazer referência a esse objeto.
Presente em Todos os Locais	present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Description	title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
ID da categoria	category_id	string	A ID da categoria do item, se houver.
IDs tributários	tax_ids	array of string
Tipo	type	string	O tipo desse objeto. Cada tipo de objeto tem propriedades esperadas expressas em um formato estruturado dentro de seu campo *_data correspondente abaixo.
ID	id	string	Um identificador para fazer referência a esse objeto.
Apresentar em todos os locais	present_at_all_locations	boolean	Se estiver presente em todos os locais.
Item ID	item_id	string	O identificador do item.
Nome	name	string	O nome do item.
Tipo de preço	pricing_type	string	O tipo de preço.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Fase de cálculo	calculation_phase	string	Se o imposto é calculado com base no subtotal ou no total de um pagamento.
Tipo de inclusão	inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Porcentagem	percentage	string	A porcentagem do imposto na forma decimal, usando um '.' como separador decimal e sem um sinal de '%'. Um valor de 7,5 corresponde a 7,5%.
Aplica-se a valores personalizados	applies_to_custom_amounts	boolean	Se for true, a taxa se aplica a valores personalizados inseridos no aplicativo Square Point of Sale que não estão associados a um CatalogItem específico.
Enabled	enabled	boolean	Um sinalizador booliano para indicar se o imposto é exibido como habilitado (true) no aplicativo Square Point of Sale ou não (false).

Retornos

Nome	Caminho	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	O tipo desse objeto.
ID	objects.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	objects.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.version	integer	A versão atual do objeto.
Está Excluído	objects.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	objects.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	objects.item_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Description	objects.item_data.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
ID da categoria	objects.item_data.category_id	string	A ID da categoria do item, se houver.
IDs tributários	objects.item_data.tax_ids	array of string
Variações	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	O tipo desse objeto. Cada tipo de objeto tem propriedades esperadas expressas em um formato estruturado dentro de seu campo *_data correspondente abaixo.
ID	objects.item_data.variations.id	string	Um identificador para fazer referência a esse objeto.
Atualizado em	objects.item_data.variations.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.item_data.variations.version	integer	A versão do objeto. Ao atualizar um objeto, a versão fornecida deve corresponder à versão no banco de dados, caso contrário, a gravação será rejeitada como conflitante.
Está Excluído	objects.item_data.variations.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Apresentar em todos os locais	objects.item_data.variations.present_at_all_locations	boolean	Uma lista de locais em que o objeto está presente, mesmo que present_at_all_locations seja false. Isso pode incluir locais desativados.
Item ID	objects.item_data.variations.item_variation_data.item_id	string	A ID do objeto com essa variação de item.
Nome	objects.item_data.variations.item_variation_data.name	string	O nome deste item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem na qual essa variação de item deve ser exibida. Esse valor é somente leitura.
Tipo de preço	objects.item_data.variations.item_variation_data.pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Quantidade	objects.item_data.variations.item_variation_data.price_money.amount	integer	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda. Por exemplo, quando a moeda é USD, o valor está em centavos. Os valores monetários podem ser positivos ou negativos. Consulte a descrição de campo específica para determinar o significado do sinal em um caso específico.
Moeda	objects.item_data.variations.item_variation_data.price_money.currency	string	O tipo de moeda, no formato ISO 4217. Por exemplo, o código de moeda para dólares americanos é USD.
Nome	objects.category_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Nome	objects.tax_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Fase de cálculo	objects.tax_data.calculation_phase	string	Se o imposto é calculado com base no subtotal ou no total de um pagamento.
Tipo de inclusão	objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Porcentagem	objects.tax_data.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Aplica-se a valores personalizados	objects.tax_data.applies_to_custom_amounts	boolean	Se for true, a taxa se aplica a valores personalizados inseridos no aplicativo Square Point of Sale que não estão associados a um CatalogItem específico.
Enabled	objects.tax_data.enabled	boolean	Indica se um objeto pode ou não ser usado.
Mapeamentos de ID	id_mappings	array of object
ID do objeto cliente	id_mappings.client_object_id	string	A ID #prefixada temporária fornecida pelo cliente para um novo CatalogObject.
ID do objeto	id_mappings.object_id	string	A ID permanente criada pelo servidor.

Obter check-out do terminal

ID da operação:: TerminalGetCheckout

Recupera uma solicitação de check-out do terminal checkout_id.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do check-out	checkout_id	True	string	O identificador do check-out.

Retornos

Nome	Caminho	Tipo	Description
ID	checkout.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	checkout.amount_money.amount	integer	O valor.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Observação	checkout.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do dispositivo	checkout.device_options.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalCheckout.
Permitir tombamento	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a inflexão está habilitada para esse check-out. O padrão é false.
Ignorar tela de recebimento	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recebimento. O padrão é false.
Situação	checkout.status	string	O status de verificação atual desse objeto.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	checkout.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	checkout.app_id	string	A ID do aplicativo que criou o check-out.
Duração do prazo	checkout.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação

Obter fatura

ID da operação:: InvoiceGet

Recupera uma fatura por ID da fatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.

Retornos

Nome	Caminho	Tipo	Description
ID	invoice.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoice.version	integer	A versão atual deste objeto.
ID do Local	invoice.location_id	string	O identificador do local.
ID do pedido	invoice.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	A ID gerada por quadrado.
Tipo de solicitação	invoice.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoice.payment_requests.due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Lembretes	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado.
Dias agendados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoice.payment_requests.reminders.message	string	A mensagem.
Situação	invoice.payment_requests.reminders.status	string	O status atual.
Quantidade	invoice.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoice.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoice.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Número da fatura	invoice.invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	invoice.title	string	O título.
Description	invoice.description	string	A descrição.
Agendado em	invoice.scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
Situação	invoice.status	string	O status de verificação atual desse objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoice.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	invoice.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do cliente	invoice.primary_recipient.customer_id	string	A ID do cliente associado ao pedido.
Nome	invoice.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoice.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoice.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
Card	invoice.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoice.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoice.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	O local do campo personalizado na fatura.
Método de entrega	invoice.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Data de venda ou serviço	invoice.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Obter pagamento

ID da operação:: PaymentGet

Recupera detalhes de um pagamento específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Retornos

Nome	Caminho	Tipo	Description
ID	payment.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	payment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	payment.amount_money.amount	integer	O valor.
Moeda	payment.amount_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual desse objeto.
Duração do atraso	payment.delay_duration	string	A duração do tempo após a criação do pagamento, quando a Square aplica automaticamente o delay_action ao pagamento. Esse delay_action automático se aplica somente a pagamentos que não atingem um estado terminal (CONCLUÍDO, CANCELADO ou COM FALHA) antes do período de delay_duration. Esse campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de Fonte	payment.source_type	string	O tipo de origem desse pagamento. Os valores atuais incluem CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Situação	payment.card_details.status	string	O status atual.
Marca de cartão	payment.card_details.card.card_brand	string	A marca do cartão.
Últimos 4	payment.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	payment.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	payment.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	payment.card_details.card.card_type	string	O tipo do cartão.
Tipo pré-pago	payment.card_details.card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ESCANINHO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Método entry	payment.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
CVV Status	payment.card_details.cvv_status	string	O código de status retornado da verificação de valor de verificação de cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
AVS Status	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereços (AVS). O código pode ser AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Código de resultado de autenticação	payment.card_details.auth_result_code	string	O código de status retornado pelo emissor do cartão que descreve o status de autorização do pagamento.
Descrição da instrução	payment.card_details.statement_description	string	A descrição da instrução enviada às redes de cartão.
Autorizado em	payment.card_details.card_payment_timeline.authorized_at	string	O carimbo de data/hora quando o pagamento foi autorizado, no formato RFC 3339.
Capturado em	payment.card_details.card_payment_timeline.captured_at	string	O carimbo de data/hora quando o pagamento foi capturado, no formato RFC 3339.
ID do Local	payment.location_id	string	O identificador do local.
ID do pedido	payment.order_id	string	A ID da ordem.
Taxa de Processamento	payment.processing_fee	array of object
Efetivo em	payment.processing_fee.effective_at	string	O carimbo de data/hora de quando a taxa entra em vigor, no formato RFC 3339.
Tipo	payment.processing_fee.type	string	Indica o tipo.
Quantidade	payment.processing_fee.amount_money.amount	integer	O valor.
Moeda	payment.processing_fee.amount_money.currency	string	A moeda.
Observação	payment.note	string	Uma anotação personalizada associada ao perfil do cliente.
Quantidade	payment.total_money.amount	integer	O valor.
Moeda	payment.total_money.currency	string	A moeda.
Quantidade	payment.approved_money.amount	integer	O valor.
Moeda	payment.approved_money.currency	string	A moeda.
ID do Funcionário	payment.employee_id	string	A ID gerada por quadrado do Funcionário.
Número do recibo	payment.receipt_number	string	O número do recibo do pagamento. O campo estará ausente se um pagamento for cancelado.
URL de recebimento	payment.receipt_url	string	A URL do recibo do pagamento. O campo só é preenchido para pagamentos COMPLETED.
Ação de atraso	payment.delay_action	string	A ação a ser aplicada ao pagamento quando o delay_duration tiver decorrido.
Atraso até	payment.delayed_until	string	O carimbo de data/hora somente leitura de quando o delay_action é aplicado automaticamente, no formato RFC 3339.
ID do membro da equipe	payment.team_member_id	string	A ID do membro da equipe.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como POS (Ponto de Venda Quadrado), Faturas Quadradas ou Terminal Virtual Quadrado.
ID do aplicativo	payment.application_details.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Token da versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Obter reembolso de pagamento

ID da operação:: RefundGet

Recupera um reembolso específico usando o refund_id.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de reembolso	refund_id	True	string	O identificador do reembolso.

Retornos

Nome	Caminho	Tipo	Description
ID	refund.id	string	O identificador exclusivo emitido por Quadrado.
Situação	refund.status	string	O status de verificação atual desse objeto.
Quantidade	refund.amount_money.amount	integer	O valor.
Moeda	refund.amount_money.currency	string	A moeda.
ID de pagamento	refund.payment_id	string	A ID exclusiva do pagamento.
ID do pedido	refund.order_id	string	A ID da ordem.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	refund.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Taxa de Processamento	refund.processing_fee	array of object
Efetivo em	refund.processing_fee.effective_at	string	O carimbo de data/hora de quando a taxa entra em vigor, no formato RFC 3339.
Tipo	refund.processing_fee.type	string	Indica o tipo.
Quantidade	refund.processing_fee.amount_money.amount	integer	O valor.
Moeda	refund.processing_fee.amount_money.currency	string	A moeda.
ID do Local	refund.location_id	string	O identificador do local.
Reason	refund.reason	string	O motivo desse objeto.

Obter reembolso do terminal

ID da operação:: TerminalGetRefund

Recupera um objeto de reembolso do Terminal Interac por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de reembolso do terminal	terminal_refund_id	True	string	O identificador do reembolso do terminal.

Retornos

Nome	Caminho	Tipo	Description
ID	refund.id	string	O identificador exclusivo emitido por Quadrado.
ID de reembolso	refund.refund_id	string	A ID exclusiva desse reembolso, gerada pela Square.
ID de pagamento	refund.payment_id	string	A ID exclusiva do pagamento.
Quantidade	refund.amount_money.amount	integer	O valor.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	O motivo desse objeto.
ID do dispositivo	refund.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalRefund.
Duração do prazo	refund.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Situação	refund.status	string	O status de verificação atual desse objeto.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	refund.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Aplicativo	refund.app_id	string	A ID do aplicativo que criou o check-out.
Marca de cartão	refund.card.card_brand	string	A marca do cartão.
last_4	refund.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	refund.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	refund.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	refund.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	refund.card.card_type	string	O tipo do cartão.
ESCANINHO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
ID do pedido	refund.order_id	string	A ID da ordem.
ID do Local	refund.location_id	string	O identificador do local.

Ordem de atualização (Beta)

ID da operação:: OrderUpdate

Atualiza uma ordem aberta adicionando, substituindo ou excluindo campos. Os pedidos com um estado COMPLETED ou CANCELED não podem ser atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id	True	string	O identificador da ordem.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Versão	version		integer	A versão atual deste objeto.
UID	uid		string	A ID gerada por quadrado.
Quantidade	quantity		string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Nome	name		string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
Campos a serem limpos	fields_to_clear		array of string

Retornos

Nome	Caminho	Tipo	Description
Versão	order.version	integer	A versão atual deste objeto.
Moeda	order.total_money.currency	string	A moeda.
Quantidade	order.total_money.amount	integer	O valor.
Nome	order.source.name	string	O nome.
Itens de Linha	order.line_items	array of object
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
UID	order.line_items.uid	string	A ID gerada por quadrado.
Quantidade	order.line_items.variation_total_price_money.amount	integer	O valor.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
Estado	order.state	string	O estado atual.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
ID	order.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	order.location_id	string	O identificador do local.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Ordem de clonagem (Beta)

ID da operação:: OrderClone

Cria uma nova ordem, no estado DRAFT, duplicando uma ordem existente. O pedido recém-criado tem apenas os campos principais (como itens de linha, impostos e descontos) copiados do pedido original.

Parâmetros

Nome	Chave	Tipo	Description
ID do pedido	order_id	string	O identificador da ordem.
Versão	version	integer	A versão.
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	order.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	order.location_id	string	O identificador do local.
Itens de Linha	order.line_items	array of object
UID	order.line_items.uid	string	A ID gerada por quadrado.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Impostos Aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Uma ID atribuída por quadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	A UID do imposto para o qual esse imposto aplicado representa.
Quantidade	order.line_items.applied_taxes.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_taxes.applied_money.currency	string	A moeda.
Descontos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Uma ID atribuída por quadrado.
UID de desconto	order.line_items.applied_discounts.discount_uid	string	A uid do desconto que o desconto aplicado representa.
Quantidade	order.line_items.applied_discounts.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Quantidade	order.line_items.variation_total_price_money.amount	integer	O valor.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
ID do objeto catalog	order.line_items.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Nome da variação	order.line_items.variation_name	string	O nome da variação aplicada a este item de linha.
Modificadores	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Uma ID atribuída por quadrado.
ID do objeto catalog	order.line_items.modifiers.catalog_object_id	string	A ID do objeto de catálogo.
Nome	order.line_items.modifiers.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.modifiers.base_price_money.amount	integer	O valor.
Moeda	order.line_items.modifiers.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.modifiers.total_price_money.amount	integer	O valor.
Moeda	order.line_items.modifiers.total_price_money.currency	string	A moeda.
Impostos	order.taxes	array of object
UID	order.taxes.uid	string	A ID gerada por quadrado.
Nome	order.taxes.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Tipo	order.taxes.type	string	Indica o tipo.
Porcentagem	order.taxes.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.taxes.applied_money.amount	integer	O valor.
Moeda	order.taxes.applied_money.currency	string	A moeda.
Scope	order.taxes.scope	string	Indica o nível atual.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	A ID gerada por quadrado.
ID do objeto catalog	order.discounts.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Nome	order.discounts.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Tipo	order.discounts.type	string	Indica o tipo.
Porcentagem	order.discounts.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.discounts.applied_money.amount	integer	O valor.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Scope	order.discounts.scope	string	Indica o nível atual.
Quantidade	order.discounts.amount_money.amount	integer	O valor.
Moeda	order.discounts.amount_money.currency	string	A moeda.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
ID de Referência	order.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Quantidade	order.total_money.amount	integer	O valor.
Moeda	order.total_money.currency	string	A moeda.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Quantidade	order.total_tip_money.amount	integer	O valor.
Moeda	order.total_tip_money.currency	string	A moeda.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.tip_money.amount	integer	O valor.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Nome	order.source.name	string	O nome.

Ordem de pagamento (Beta)

ID da operação:: OrderPay

Pague um pedido usando um ou mais pagamentos aprovados ou resolva um pedido com um total de 0. O total do payment_ids listado na solicitação deve ser igual ao total da ordem. Os pedidos com um valor total de 0 podem ser marcados como pagos especificando uma matriz vazia de payment_ids na solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id	True	string	O identificador da ordem.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
IDs de pagamento	payment_ids		array of string

Retornos

Nome	Caminho	Tipo	Description
ID	order.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	order.location_id	string	O identificador do local.
Itens de Linha	order.line_items	array of object
UID	order.line_items.uid	string	A ID gerada por quadrado.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Versão	order.version	integer	A versão atual deste objeto.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Quantidade	order.total_money.amount	integer	O valor.
Moeda	order.total_money.currency	string	A moeda.
Fechado em	order.closed_at	string	A hora quando fechada, no formato ISO 8601.
Propostas	order.tenders	array of object
ID	order.tenders.id	string	O identificador do objeto
ID do Local	order.tenders.location_id	string	A ID do local de um destinatário (diferente do comerciante) recebendo uma parte desta licitação.
ID da transação	order.tenders.transaction_id	string	A ID da transação associada da licitação.
Criado em	order.tenders.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
Quantidade	order.tenders.amount_money.amount	integer	O valor.
Moeda	order.tenders.amount_money.currency	string	A moeda.
Tipo	order.tenders.type	string	Indica o tipo.
Situação	order.tenders.card_details.status	string	O estado atual do pagamento do cartão de crédito (como AUTHORIZED ou CAPTURED)
Marca de cartão	order.tenders.card_details.card.card_brand	string	A marca do cartão.
last_4	order.tenders.card_details.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês exp	order.tenders.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	order.tenders.card_details.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	order.tenders.card_details.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Método entry	order.tenders.card_details.entry_method	string	O método usado para inserir os detalhes do cartão para a transação.
ID de pagamento	order.tenders.payment_id	string	ID exclusiva gerada por quadrado do pagamento.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.tip_money.amount	integer	O valor.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Nome	order.source.name	string	O nome.
Estado	order.state	string	O estado atual.

Pagamento de reembolso

ID da operação:: RefundPayment

Reembolsa um pagamento. Você pode reembolsar todo o valor de pagamento ou uma parte dele. Você pode usar esse ponto de extremidade para reembolsar um pagamento com cartão ou registrar um reembolso de um pagamento em dinheiro ou externo.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID de pagamento	payment_id	string	A ID exclusiva do pagamento que está sendo reembolsado.
Quantidade	amount	integer	A quantidade de dinheiro a aceitar para esse pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.
Quantidade	amount	integer	A quantidade de dinheiro a aceitar para esse pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.
Reason	reason	string	Uma descrição do motivo do reembolso.

Retornos

Nome	Caminho	Tipo	Description
ID	refund.id	string	O identificador exclusivo emitido por Quadrado.
Situação	refund.status	string	O status de verificação atual desse objeto.
Quantidade	refund.amount_money.amount	integer	O valor.
Moeda	refund.amount_money.currency	string	A moeda.
ID de pagamento	refund.payment_id	string	A ID exclusiva do pagamento.
ID do pedido	refund.order_id	string	A ID da ordem.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	refund.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Quantidade	refund.app_fee_money.amount	integer	O valor.
Moeda	refund.app_fee_money.currency	string	A moeda.
ID do Local	refund.location_id	string	O identificador do local.
Reason	refund.reason	string	O motivo desse objeto.

Pedidos de pesquisa

ID da operação:: OrderSearch

Pesquise todos os pedidos por um ou mais locais. Os pedidos incluem todas as vendas, retornos e trocas, independentemente de como ou quando entraram no ecossistema quadrado (como Ponto de Venda, Faturas e APIs de Conexão).

Parâmetros

Nome	Chave	Tipo	Description
Entradas de retorno	return_entries	boolean	Um booliano que controla o formato dos resultados da pesquisa. Se for true, SearchOrders retornará objetos OrderEntry. Se for falso, SearchOrders retornará objetos de ordem completos.
Limit	limit	integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.
IDs de localização	location_ids	array of string
Iniciar em	start_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo é iniciado.
Terminar em	end_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
States	states	array of string
Campo classificar	sort_field	string	O campo pelo qual classificar.
Ordem de Classificação	sort_order	string	A ordem cronológica na qual os resultados são retornados.

Retornos

Nome	Caminho	Tipo	Description
Entradas de pedido	order_entries	array of object
ID do pedido	order_entries.order_id	string	A ID da ordem.
ID do Local	order_entries.location_id	string	O identificador do local.
Versão	order_entries.version	integer	A versão atual do objeto.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Pedidos de recuperação de lote

ID da operação:: OrderBatchRetrieve

Recupera um conjunto de pedidos por suas IDs. Se uma determinada ID de pedido não existir, a ID será ignorada em vez de gerar um erro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Local	location_id		string	O identificador de local.
IDs do pedido	order_ids		array of string

Retornos

Nome	Caminho	Tipo	Description
Pedidos	orders	array of object
ID	orders.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	orders.location_id	string	O identificador do local.
ID de Referência	orders.reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Itens de Linha	orders.line_items	array of object
UID	orders.line_items.uid	string	A ID gerada por Quadrado da solicitação de pagamento em uma fatura.
Nome	orders.line_items.name	string	Um nome legível por humanos.
Quantidade	orders.line_items.quantity	string	A quantidade adquirida, formatada como um número decimal.
Quantidade	orders.line_items.base_price_money.amount	integer	O valor.
Moeda	orders.line_items.base_price_money.currency	string	A moeda.
Quantidade	orders.line_items.total_money.amount	integer	O valor.
Moeda	orders.line_items.total_money.currency	string	A moeda.
Quantidade	orders.total_money.amount	integer	O valor.
Moeda	orders.total_money.currency	string	A moeda.

Pesquisar assinaturas

ID da operação:: SubscriptionSearch

Pesquisa assinaturas. Os resultados são ordenados cronologicamente pela data de criação da assinatura. Se a solicitação especificar mais de uma ID de local, o ponto de extremidade ordenará o resultado por ID de local e, em seguida, por data de criação em cada local. Se nenhum local for dado na consulta, todos os locais serão pesquisados.

Parâmetros

Nome	Chave	Tipo
IDs de localização	location_ids	array of string
IDs do cliente	customer_ids	array of string
Nomes de origem	source_names	array of string

Retornos

Nome	Caminho	Tipo	Description
Subscriptions	subscriptions	array of object
ID	subscriptions.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscriptions.location_id	string	O identificador do local.
ID do Plano	subscriptions.plan_id	string	A ID do plano de assinatura associado
ID do cliente	subscriptions.customer_id	string	A ID atribuída por Quadrado do cliente associado à conta.
Data de Início	subscriptions.start_date	string	A data de início da assinatura, no formato YYYY-MM-DD.
Data cancelada	subscriptions.canceled_date	string	A data de cancelamento da assinatura, no formato YYYY-MM-DD.
Cobrado por data	subscriptions.charged_through_date	string	A data em que o cliente é faturado para a assinatura, no formato YYYY-MM-DD.
Situação	subscriptions.status	string	O status de verificação atual desse objeto.
Criado em	subscriptions.created_at	string	A hora do evento no formato ISO 8601.
ID do Cartão	subscriptions.card_id	string	A ID do cartão do cliente que é cobrado pela assinatura.
Data de pagamento até a data	subscriptions.paid_until_date	string	A data paga até.
Timezone	subscriptions.timezone	string	O fuso horário usado para interpretar datas de calendário na fatura, como due_date. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscriptions.source.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Percentual de Impostos	subscriptions.tax_percentage	string	O valor do imposto aplicado ao cobrar a assinatura.
Quantidade	subscriptions.price_override_money.amount	integer	O valor.
Moeda	subscriptions.price_override_money.currency	string	A moeda.
Versão	subscriptions.version	integer	A versão atual do objeto.
IDs da fatura	subscriptions.invoice_ids	array of string

Pesquisar check-outs do terminal

ID da operação:: TerminalSearchCheckouts

Recupera uma lista filtrada de solicitações de check-out de terminal criadas pela conta que está fazendo a solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.
Situação	status		string	O status atual.

Retornos

Nome	Caminho	Tipo	Description
Checkouts	checkouts	array of object
ID	checkouts.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	checkouts.amount_money.amount	integer	O valor.
Moeda	checkouts.amount_money.currency	string	A moeda.
ID de Referência	checkouts.reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Observação	checkouts.note	string	Uma anotação personalizada associada ao perfil do cliente.
ID do dispositivo	checkouts.device_options.device_id	string	A ID exclusiva do dispositivo destinado a este TerminalCheckout.
Permitir tombamento	checkouts.device_options.tip_settings.allow_tipping	boolean	Indica se a inflexão está habilitada para esse check-out. O padrão é false.
Ignorar tela de recebimento	checkouts.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recebimento. O padrão é false.
Situação	checkouts.status	string	O status de verificação atual desse objeto.
IDs de pagamento	checkouts.payment_ids	array of string
Criado em	checkouts.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	checkouts.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
ID do Aplicativo	checkouts.app_id	string	A ID do aplicativo que criou o check-out.
Duração do prazo	checkouts.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Pesquisar clientes

ID da operação:: CustomerSearch

Pesquisa os perfis de cliente associados a uma conta Square usando um filtro de consulta com suporte. Chamar SearchCustomers sem qualquer filtro de consulta explícito retorna todos os perfis de cliente ordenados em ordem alfabética com base em given_name e family_name.

Parâmetros

Nome	Chave	Tipo	Description
Indistinto	fuzzy	string	Use o filtro difuso para selecionar clientes cujos atributos correspondem à consulta especificada de maneira difusa. Quando a opção difusa é usada, as consultas de pesquisa são tokenizadas e, em seguida, cada token de consulta deve ser correspondido em algum lugar no atributo pesquisado. Para consultas de token único, esse é efetivamente o mesmo comportamento de uma operação de correspondência parcial.
Valores	values	array of string
Regra	rule	string	Indica se um perfil de cliente que corresponde aos critérios de filtro deve ser incluído no resultado ou excluído do resultado.
Iniciar em	start_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo é iniciado.
Terminar em	end_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
All	all	array of string
Campo	field	string	Use um ou mais atributos do cliente como a chave de classificação para classificar perfis de clientes pesquisados.
Pedido	order	string	Indica a ordem na qual os resultados devem ser classificados com base no valor do campo de classificação. Cadeias de caracteres usam comparação alfabética padrão para determinar a ordem.
Limit	limit	integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Clientes	customers	array of object
ID	customers.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	customers.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	customers.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Nome	customers.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	customers.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	customers.email_address	string	O endereço de email associado ao perfil do cliente.
Linha de endereço 1	customers.address.address_line_1	string	A primeira linha do endereço.
Linha de endereço 2	customers.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customers.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	customers.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	customers.address.postal_code	string	O código postal do endereço.
País	customers.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Número de Telefone	customers.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
ID de Referência	customers.reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
Email não assinado	customers.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a assinatura de emails de campanha de marketing. Um valor verdadeiro significa que o cliente optou por recusar o marketing de email do vendedor da Square atual ou de todos os vendedores da Square. Esse valor é somente leitura da API de Clientes.
Origem da criação	customers.creation_source	string	Uma fonte de criação representa o método usado para criar o perfil do cliente.
IDs de grupo	customers.group_ids	array of string
IDs de segmento	customers.segment_ids	array of string
Versão	customers.version	integer	A versão atual do objeto.
Observação	customers.note	string	Uma anotação personalizada associada ao perfil do cliente.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Pesquisar faturas

ID da operação:: InvoiceSearch

Pesquisa faturas de um local especificado no filtro.

Parâmetros

Nome	Chave	Tipo	Description
IDs de localização	location_ids	array of string
IDs do cliente	customer_ids	array of string
Campo	field	string	Use um ou mais atributos do cliente como a chave de classificação para classificar perfis de clientes pesquisados.
Pedido	order	string	Indica a ordem na qual os resultados devem ser classificados com base no valor do campo de classificação. Cadeias de caracteres usam comparação alfabética padrão para determinar a ordem.
Limit	limit	integer	O número máximo de faturas a serem retornadas (200 é o limite máximo). Se não for fornecido, o servidor usará um limite padrão de 100 faturas.

Retornos

Nome	Caminho	Tipo	Description
Invoices	invoices	array of object
ID	invoices.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoices.version	integer	A versão atual do objeto.
ID do Local	invoices.location_id	string	O identificador do local.
ID do pedido	invoices.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	A ID gerada por Quadrado da solicitação de pagamento em uma fatura.
Tipo de solicitação	invoices.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoices.payment_requests.due_date	string	A data de conclusão (no fuso horário da fatura) para a solicitação de pagamento, no formato YYY-MM-DD.
Inflexão Habilitada	invoices.payment_requests.tipping_enabled	boolean	Se definido como true, a página da fatura hospedada na Praça (o campo public_url da fatura) fornece um local para o cliente pagar uma gorjeta.
Lembretes	invoices.payment_requests.reminders	array of object	Lembretes
UID	invoices.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado que identifica exclusivamente o lembrete no InvoicePaymentRequest.
Dias agendados relativos	invoices.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoices.payment_requests.reminders.message	string	A mensagem de lembrete.
Situação	invoices.payment_requests.reminders.status	string	O status do lembrete.
Quantidade	invoices.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoices.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoices.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoices.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoices.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Porcentagem solicitada	invoices.payment_requests.percentage_requested	string	Especifica o valor da solicitação de pagamento em porcentagem.
ID do Cartão	invoices.payment_requests.card_id	string	A ID do cartão de crédito ou débito no arquivo a ser cobrado pela solicitação de pagamento.
Número da fatura	invoices.invoice_number	string	Um número de fatura amigável.
Title	invoices.title	string	O título da fatura.
Description	invoices.description	string	A descrição.
Agendado em	invoices.scheduled_at	string	O carimbo de data/hora quando a fatura é agendada para processamento, no formato RFC 3339. Depois que a fatura é publicada, a Square processa a fatura na data especificada, de acordo com o método de entrega e as configurações de solicitação de pagamento.
Situação	invoices.status	string	O status de verificação atual desse objeto.
Timezone	invoices.timezone	string	O fuso horário usado para interpretar datas de calendário na fatura, como due_date. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoices.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	invoices.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
ID do cliente	invoices.primary_recipient.customer_id	string	A ID de um cliente a ser associada ao cartão.
Nome	invoices.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoices.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoices.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoices.primary_recipient.phone_number	string	O número de telefone do destinatário.
Card	invoices.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoices.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoices.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoices.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoices.custom_fields.placement	string	O local do campo personalizado na fatura
Método de entrega	invoices.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente.
Data de venda ou serviço	invoices.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.
URL pública	invoices.public_url	string	A URL da página da fatura hospedada na Praça. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, o Square hospeda a página da fatura e retorna a URL da página na resposta.
Quantidade	invoices.next_payment_amount_money.amount	integer	O valor.
Moeda	invoices.next_payment_amount_money.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Pesquisar objetos do catálogo

ID da operação:: CatalogSearch

Pesquisa catalogObject de qualquer tipo, correspondendo a valores de atributo de pesquisa com suporte, excluindo valores de atributo personalizados em itens ou variações de item, em relação a um ou mais dos filtros de consulta especificados.

Parâmetros

Nome	Chave	Tipo	Description
Tipos de objeto	object_types	array of string
Nome do atributo	attribute_name	string	O nome do atributo a ser pesquisado.
Prefixo de atributo	attribute_prefix	string	O prefixo desejado do valor do atributo de pesquisa.
Limit	limit	integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	O tipo desse objeto.
ID	objects.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	objects.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.version	integer	A versão atual do objeto.
Está Excluído	objects.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	objects.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	objects.item_data.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Description	objects.item_data.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
ID da categoria	objects.item_data.category_id	string	A ID da categoria do item, se houver.
Tipo de Produto	objects.item_data.product_type	string	A expressão de consulta de tipos de produto para retornar itens ou variações de item com os tipos de produto especificados.
IDs tributários	objects.item_data.tax_ids	array of string
Variações	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	O tipo desse objeto. Cada tipo de objeto tem propriedades esperadas expressas em um formato estruturado dentro de seu campo *_data correspondente abaixo.
ID	objects.item_data.variations.id	string	Um identificador para fazer referência a esse objeto.
Atualizado em	objects.item_data.variations.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Versão	objects.item_data.variations.version	integer	A versão do objeto. Ao atualizar um objeto, a versão fornecida deve corresponder à versão no banco de dados, caso contrário, a gravação será rejeitada como conflitante.
Está Excluído	objects.item_data.variations.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Apresentar em todos os locais	objects.item_data.variations.present_at_all_locations	boolean	Uma lista de locais em que o objeto está presente, mesmo que present_at_all_locations seja false. Isso pode incluir locais desativados.
Item ID	objects.item_data.variations.item_variation_data.item_id	string	A ID do objeto com essa variação de item.
Nome	objects.item_data.variations.item_variation_data.name	string	O nome deste item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem na qual essa variação de item deve ser exibida. Esse valor é somente leitura.
Quantidade	objects.item_data.variations.item_variation_data.price_money.amount	integer	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda. Por exemplo, quando a moeda é USD, o valor está em centavos. Os valores monetários podem ser positivos ou negativos. Consulte a descrição de campo específica para determinar o significado do sinal em um caso específico.
Moeda	objects.item_data.variations.item_variation_data.price_money.currency	string	O tipo de moeda, no formato ISO 4217. Por exemplo, o código de moeda para dólares americanos é USD.
Tipo de preço	objects.item_data.variations.item_variation_data.pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Visibilidade	objects.item_data.visibility	string	A visibilidade.

Pesquisar reembolsos do terminal

ID da operação:: TerminalSearchRefunds

Recupera uma lista filtrada de solicitações de reembolso do Terminal Interac criadas pelo vendedor que está fazendo a solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.
Situação	status		string	O status atual.

Retornos

Nome	Caminho	Tipo	Description
Restituições	refunds	array of object
ID	refunds.id	string	O identificador exclusivo emitido por Quadrado.
ID de reembolso	refunds.refund_id	string	A ID exclusiva desse reembolso, gerada pela Square.
ID de pagamento	refunds.payment_id	string	A ID do pagamento.
Quantidade	refunds.amount_money.amount	integer	O valor.
Moeda	refunds.amount_money.currency	string	A moeda.
Reason	refunds.reason	string	O motivo da disputa pelo qual o titular do cartão iniciou a disputa com seu banco.
ID do dispositivo	refunds.device_id	string	A ID exclusiva do dispositivo que usou esse código. Populado quando o dispositivo é emparelhado.
Duração do prazo	refunds.deadline_duration	string	Uma duração rfc 3339, após a qual o check-out é cancelado automaticamente. Um TerminalCheckout pendente é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos após a criação
Situação	refunds.status	string	O status de verificação atual desse objeto.
Criado em	refunds.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	refunds.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
ID do Aplicativo	refunds.app_id	string	A ID do aplicativo que criou o check-out.
Marca de cartão	refunds.card.card_brand	string	A marca do cartão.
Últimos 4	refunds.card.last_4	string	Os últimos 4 dígitos do número do cartão.
Mês de Expiração	refunds.card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano de Expiração	refunds.card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Impressão digital	refunds.card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
Tipo de cartão	refunds.card.card_type	string	O tipo do cartão.
ESCANINHO	refunds.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
ID do pedido	refunds.order_id	string	A ID da ordem.
ID do Local	refunds.location_id	string	O identificador do local.

Publicar fatura

ID da operação:: InvoicePublish

Publica a fatura de rascunho especificada. Depois que uma fatura é publicada, o Square faz o acompanhamento com base na configuração da fatura. Por exemplo, a Square envia a fatura para o endereço de email do cliente, cobra o cartão do cliente no arquivo ou não faz nada. A Square também disponibiliza a fatura em uma página de fatura hospedada na Praça.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Versão	version		integer	A versão.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	invoice.id	string	O identificador exclusivo emitido por Quadrado.
Versão	invoice.version	integer	A versão atual deste objeto.
ID do Local	invoice.location_id	string	O identificador do local.
ID do pedido	invoice.order_id	string	A ID da ordem.
Solicitações de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	A ID gerada por quadrado.
Tipo de solicitação	invoice.payment_requests.request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data de vencimento	invoice.payment_requests.due_date	string	A data de conclusão da solicitação de pagamento, no formato YYYY-MM-DD.
Inflexão Habilitada	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Lembretes	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Uma ID atribuída por quadrado.
Dias agendados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	O número de dias antes (um número negativo) ou depois (um número positivo) que a solicitação de pagamento due_date quando o lembrete é enviado.
Message	invoice.payment_requests.reminders.message	string	A mensagem.
Situação	invoice.payment_requests.reminders.status	string	O status atual.
Quantidade	invoice.payment_requests.computed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Quantidade	invoice.payment_requests.total_completed_amount_money.amount	integer	O valor.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de pagamento automática	invoice.payment_requests.automatic_payment_source	string	A forma de pagamento de um pagamento automático.
Número da fatura	invoice.invoice_number	string	Um número de fatura amigável. O valor é exclusivo em um local. Se não for fornecido ao criar uma fatura, o Square atribuirá um valor.
Title	invoice.title	string	O título.
Description	invoice.description	string	A descrição.
Agendado em	invoice.scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
Situação	invoice.status	string	O status de verificação atual desse objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Criado em	invoice.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	invoice.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do cliente	invoice.primary_recipient.customer_id	string	A ID do cliente associado ao pedido.
Nome	invoice.primary_recipient.given_name	string	O nome fornecido pelo destinatário (ou seja, primeiro).
Sobrenome	invoice.primary_recipient.family_name	string	O nome da família do destinatário (ou seja, sobrenome).
Endereço de Email	invoice.primary_recipient.email_address	string	O endereço de email do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
URL pública	invoice.public_url	string	A URL da página da fatura hospedada na Praça. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, o Square hospeda a página da fatura e retorna a URL da página na resposta.
Card	invoice.accepted_payment_methods.card	boolean	Indica se pagamentos com cartão de crédito ou cartão de débito são aceitos.
Cartão-presente quadrado	invoice.accepted_payment_methods.square_gift_card	boolean	Indica se os pagamentos com cartão presente square são aceitos.
Conta bancária	invoice.accepted_payment_methods.bank_account	boolean	Indica se os pagamentos de transferência bancária são aceitos.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Value	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	O local do campo personalizado na fatura.
Método de entrega	invoice.delivery_method	string	O método de entrega que o Square usa para enviar a fatura, lembretes e recibos para o cliente. Depois que a fatura é publicada, a Square processa a fatura com base no método de entrega e nas configurações de solicitação de pagamento, imediatamente ou na data de scheduled_at, se especificado.
Data de venda ou serviço	invoice.sale_or_service_date	string	A data da venda ou a data em que o serviço é renderizado, no formato YYYY-MM-DD. Esse campo pode ser usado para especificar uma data passada ou futura exibida na fatura.

Recuperar ajuste de inventário

ID da operação:: InventoryRetrieveAdjustment

Retorna o objeto InventoryAdjustment com o adjustment_id fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de ajuste	adjustment_id	True	string	O identificador do ajuste.

Retornos

Nome	Caminho	Tipo	Description
ID	adjustment.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	adjustment.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Do Estado	adjustment.from_state	string	O estado de inventário da quantidade relacionada de itens antes do ajuste.
Para Estado	adjustment.to_state	string	O estado de inventário da quantidade de itens relacionada após o ajuste.
ID do Local	adjustment.location_id	string	O identificador do local.
ID do objeto catalog	adjustment.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	adjustment.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Quantidade	adjustment.quantity	string	O número de itens afetados pelo ajuste como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
Quantidade	adjustment.total_price_money.amount	integer	O valor.
Moeda	adjustment.total_price_money.currency	string	A moeda.
Ocorreu em	adjustment.occurred_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando o ajuste de inventário ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora occurred_at não pode ter mais de 24 horas ou no futuro em relação à hora da solicitação.
Criado em	adjustment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Product	adjustment.source.product	string	Tipo de produto para o aplicativo.
ID do aplicativo	adjustment.source.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Nome	adjustment.source.name	string	O nome.
ID do Funcionário	adjustment.employee_id	string	A ID gerada por quadrado do Funcionário.

Recuperar assinatura

ID da operação:: SubscriptionRetrieve

Recupera uma assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscription_id	True	string	O identificador da assinatura.

Retornos

Nome	Caminho	Tipo	Description
ID	subscription.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscription.location_id	string	O identificador do local.
ID do Plano	subscription.plan_id	string	A ID do plano de assinatura associado.
ID do cliente	subscription.customer_id	string	A ID desse objeto que representa o cliente.
Data de Início	subscription.start_date	string	A data de início da assinatura, no formato YYYY-MM-DD.
Cobrado por data	subscription.charged_through_date	string	A data em que o cliente é faturado para a assinatura, no formato YYYY-MM-DD.
Situação	subscription.status	string	O status de verificação atual desse objeto.
IDs da fatura	subscription.invoice_ids	array of string
Quantidade	subscription.price_override_money.amount	integer	O valor.
Moeda	subscription.price_override_money.currency	string	A moeda.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Data de pagamento até a data	subscription.paid_until_date	string	A data paga até.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscription.source.name	string	O nome.

Recuperar cartão

ID da operação:: CardRetrieve

Recupera detalhes de um Cartão específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Cartão	card_id	True	string	O identificador do cartão.

Retornos

Nome	Caminho	Tipo	Description
ID	card.id	string	O identificador exclusivo emitido por Quadrado.
Linha de endereço 1	card.billing_address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	card.billing_address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	card.billing_address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	card.billing_address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	card.billing_address.postal_code	string	O código postal do endereço.
País	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Pretendido como um identificador atribuído por quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
ESCANINHO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como BIN (Número de Identificação Bancária).
Marca de cartão	card.card_brand	string	A marca do cartão.
Tipo de cartão	card.card_type	string	O tipo do cartão.
Nome do titular do cartão	card.cardholder_name	string	O nome do titular do cartão.
ID do cliente	card.customer_id	string	A ID desse objeto que representa o cliente.
Enabled	card.enabled	boolean	Se estiver habilitado.
Mês exp	card.exp_month	integer	O mês de expiração do cartão associado como um inteiro entre 1 e 12.
Ano exp	card.exp_year	integer	O ano de quatro dígitos da data de validade do cartão.
Últimos 4	card.last_4	string	Os últimos 4 dígitos do número do cartão.
Tipo pré-pago	card.prepaid_type	string	Indica se o Cartão é pré-pago ou não.
ID de Referência	card.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Versão	card.version	integer	A versão atual deste objeto.

Recuperar cliente

ID da operação:: CustomerRetrieve

Retorna detalhes para um único cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customer_id	True	string	O identificador do cliente.

Retornos

Nome	Caminho	Tipo	Description
ID	customer.id	string	O identificador exclusivo emitido por Quadrado.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	customer.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Nome	customer.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	customer.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	customer.email_address	string	O endereço de email associado ao perfil do cliente.
Linha de endereço 1	customer.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	customer.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	customer.address.postal_code	string	O código postal do endereço.
País	customer.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Número de Telefone	customer.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
ID de Referência	customer.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Observação	customer.note	string	Uma anotação personalizada associada ao perfil do cliente.
Email não assinado	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a assinatura de emails de campanha de marketing. Um valor verdadeiro significa que o cliente optou por recusar o marketing de email do vendedor da Square atual ou de todos os vendedores da Square.
Origem da criação	customer.creation_source	string	Uma fonte de criação representa o método usado para criar o perfil do cliente.
IDs de grupo	customer.group_ids	array of string
IDs de segmento	customer.segment_ids	array of string
Versão	customer.version	integer	A versão atual deste objeto.

Recuperar contagem de inventário

ID da operação:: InventoryRetrieveCount

Recupera a contagem atual de ações calculadas para um determinado CatalogObject em um determinado conjunto de Locais.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do objeto catalog	catalog_object_id	True	string	O identificador do objeto de catálogo.
IDs de localização	location_ids		string	As IDs de localização a serem pesquisadas como uma lista separada por vírgulas. Uma lista vazia consulta todos os locais.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Conta	counts	array of object
ID do objeto catalog	counts.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	counts.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Estado	counts.state	string	O estado atual.
ID do Local	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física ou o ajuste mais recente que afeta a contagem estimada é recebido.

Recuperar contagem física de inventário

ID da operação:: InventoryRetrievePhysicalCount

Retorna o objeto InventoryPhysicalCount com o physical_count_id fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Contagem Física	physical_count_id	True	string	O identificador da contagem física.

Retornos

Nome	Caminho	Tipo	Description
ID	count.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	count.reference_id	string	Uma ID de referência opcional definida pelo usuário.
ID do objeto catalog	count.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	count.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Estado	count.state	string	O estado atual.
ID do Local	count.location_id	string	O identificador do local.
Quantidade	count.quantity	string	O número de itens afetados pelo ajuste como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
Product	count.source.product	string	Tipo de produto para o aplicativo.
ID do aplicativo	count.source.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Nome	count.source.name	string	O nome.
ID do Funcionário	count.employee_id	string	A ID gerada por quadrado do Funcionário.
Ocorreu em	count.occurred_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando o ajuste de inventário ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora occurred_at não pode ter mais de 24 horas ou no futuro em relação à hora da solicitação.
Criado em	count.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.

Recuperar disputa

ID da operação:: DisputeRetrieve

Retorna detalhes sobre uma disputa específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.

Retornos

Nome	Caminho	Tipo	Description
ID	dispute.id	string	O identificador exclusivo emitido por Quadrado.
Quantidade	dispute.amount_money.amount	integer	O valor.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	O motivo desse objeto.
Estado	dispute.state	string	O estado atual.
Conclusão em	dispute.due_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.
Pagamentos Contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID exclusiva gerada por quadrado do pagamento.
Marca de cartão	dispute.card_brand	string	A marca do cartão.
Criado em	dispute.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	dispute.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	A ID da disputa no sistema de marca de cartão, gerada pela marca de cartão.

Recuperar evidência de controvérsia

ID da operação:: DisputeRetrieveEvidence

Retorna os metadados de evidência especificados pela ID da evidência no caminho da URL da solicitação. Você deve manter uma cópia da evidência carregada se quiser referenciá-la mais tarde. Você não pode baixar a evidência depois de carregá-la.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da disputa	dispute_id	True	string	O identificador da disputa.
ID da evidência	evidence_id	True	string	O identificador da evidência.

Retornos

Nome	Caminho	Tipo	Description
ID	evidence.id	string	O identificador exclusivo emitido por Quadrado.
ID da disputa	evidence.dispute_id	string	A ID da disputa à qual a evidência está associada.
Nome do Arquivo	evidence.evidence_file.filename	string	Os arquivos de evidência de controvérsia devem ser formatos application/pdf, image/heic, image/heif, image/jpeg, image/png ou image/tiff.
Tipo de arquivo	evidence.evidence_file.filetype	string	O nome do arquivo, incluindo a extensão de arquivo.
Tipo de evidência	evidence.evidence_type	string	O tipo de evidência pf.
Carregado em	evidence.uploaded_at	string	A hora em que a próxima ação for concluída, no formato RFC 3339.

Recuperar grupo de clientes

ID da operação:: CustomerGroupRetrieve

Recupera um grupo de clientes específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.

Retornos

Nome	Caminho	Tipo	Description
ID	group.id	string	O identificador exclusivo emitido por Quadrado.
Nome	group.name	string	O nome do objeto.
Criado em	group.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	group.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Recuperar objeto de catálogo

ID da operação:: CatalogRetrieve

Retorna um único CatalogItem como um CatalogObject com base na ID fornecida. O objeto retornado inclui todas as informações relevantes do CatalogItem, incluindo: catalogItemVariation children, referências a seus objetos CatalogModifierList e as IDs de todos os objetos CatalogTax que se aplicam a ele.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do objeto	object_id	True	string	O identificador do objeto.
Incluir objetos relacionados	include_related_objects		boolean	Se for true, a resposta incluirá objetos adicionais relacionados ao objeto solicitado, da seguinte maneira: se o campo de objeto da resposta contiver um CatalogItem, seus objetos CatalogCategory, CatalogTax, CatalogImage e CatalogModifierList associados serão retornados no campo related_objects da resposta. Se o campo de objeto da resposta contiver uma CatalogItemVariation, seu CatalogItem pai será retornado no campo related_objects da resposta.

Retornos

Nome	Caminho	Tipo	Description
Tipo	object.type	string	O tipo desse objeto.
ID	object.id	string	O identificador exclusivo emitido por Quadrado.
Atualizado em	object.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Versão	object.version	integer	A versão atual deste objeto.
Está Excluído	object.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
present_at_all_locations	object.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Nome	object.item_data.name	string	O nome.
Description	object.item_data.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
ID da categoria	object.item_data.category_id	string	A ID da categoria do item, se houver.
IDs tributários	object.item_data.tax_ids	array of string
Variações	object.item_data.variations	array of object
Tipo	object.item_data.variations.type	string	O tipo desse objeto.
ID	object.item_data.variations.id	string	Um identificador para fazer referência a esse objeto no catálogo.
Atualizado em	object.item_data.variations.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339.
Versão	object.item_data.variations.version	integer	A versão do objeto. Ao atualizar um objeto, a versão fornecida deve corresponder à versão no banco de dados, caso contrário, a gravação será rejeitada como conflitante.
Está Excluído	object.item_data.variations.is_deleted	boolean	Se for true, o objeto foi excluído do banco de dados. Deve ser falso para novos objetos que estão sendo inseridos. Quando excluído, o campo updated_at será igual ao tempo de exclusão.
Presente em Todos os Locais	object.item_data.variations.present_at_all_locations	boolean	Se for true, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se for falso, esse objeto não estará presente em nenhum local (incluindo locais futuros), exceto quando especificado no campo present_at_location_ids. Se não for especificado, o padrão será true.
Item ID	object.item_data.variations.item_variation_data.item_id	string	A ID do CatalogItem associado a essa variação de item.
Nome	object.item_data.variations.item_variation_data.name	string	O nome da variação do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Ordinal	object.item_data.variations.item_variation_data.ordinal	integer	A ordem na qual essa variação de item deve ser exibida. Esse valor é somente leitura. Em gravações, o ordinal para cada variação de item em um CatalogItem pai é definido de acordo com a posição das variações de item. Em leituras, o valor não é garantido como sequencial ou exclusivo.
Tipo de preço	object.item_data.variations.item_variation_data.pricing_type	string	Indica se o preço da variação do item é fixo ou determinado no momento da venda.
Quantidade	object.item_data.variations.item_variation_data.price_money.amount	integer	O valor.
Moeda	object.item_data.variations.item_variation_data.price_money.currency	string	A moeda.

Recuperar ordem

ID da operação:: OrderRetrieve

Recupera um pedido por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id	True	string	O identificador da ordem.

Retornos

Nome	Caminho	Tipo	Description
ID	order.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	order.location_id	string	O identificador do local.
Itens de Linha	order.line_items	array of object
UID	order.line_items.uid	string	A ID gerada por quadrado.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia de caracteres decimal. O número pode dar suporte a até 5 dígitos após o ponto decimal.
Nome	order.line_items.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Quantidade	order.line_items.base_price_money.amount	integer	O valor.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Quantidade	order.line_items.gross_sales_money.amount	integer	O valor.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Quantidade	order.line_items.total_tax_money.amount	integer	O valor.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	order.line_items.total_discount_money.amount	integer	O valor.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	order.line_items.total_money.amount	integer	O valor.
Moeda	order.line_items.total_money.currency	string	A moeda.
Quantidade	order.line_items.variation_total_price_money.amount	integer	O valor.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
Descontos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Uma ID atribuída por quadrado.
UID de desconto	order.line_items.applied_discounts.discount_uid	string	A uid do desconto que o desconto aplicado representa.
Quantidade	order.line_items.applied_discounts.applied_money.amount	integer	O valor.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	A ID gerada por quadrado.
Nome	order.discounts.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Porcentagem	order.discounts.percentage	string	A porcentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Quantidade	order.discounts.applied_money.amount	integer	O valor.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Tipo	order.discounts.type	string	Indica o tipo.
Scope	order.discounts.scope	string	Indica o nível atual.
Criado em	order.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
Quantidade	order.total_tax_money.amount	integer	O valor.
Moeda	order.total_tax_money.currency	string	A moeda.
Quantidade	order.total_discount_money.amount	integer	O valor.
Moeda	order.total_discount_money.currency	string	A moeda.
Quantidade	order.total_tip_money.amount	integer	O valor.
Moeda	order.total_tip_money.currency	string	A moeda.
Quantidade	order.total_money.amount	integer	O valor.
Moeda	order.total_money.currency	string	A moeda.
Quantidade	order.total_service_charge_money.amount	integer	O valor.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Quantidade	order.net_amounts.total_money.amount	integer	O valor.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Quantidade	order.net_amounts.tax_money.amount	integer	O valor.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Quantidade	order.net_amounts.discount_money.amount	integer	O valor.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Quantidade	order.net_amounts.tip_money.amount	integer	O valor.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Quantidade	order.net_amounts.service_charge_money.amount	integer	O valor.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.

Recuperar segmento do cliente

ID da operação:: CustomerSegmentRetrieve

Recupera um segmento de cliente específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Segmento	segment_id	True	string	O identificador do segmento.

Retornos

Nome	Caminho	Tipo	Description
ID	segment.id	string	O identificador exclusivo emitido por Quadrado.
Nome	segment.name	string	O nome do objeto.
Criado em	segment.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	segment.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Recuperar transferência de inventário (Beta)

ID da operação:: InventoryRetrieveTransfer

Retorna o objeto InventoryTransfer com o transfer_id fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da transferência	transfer_id	True	string	O identificador da transferência.

Retornos

Nome	Caminho	Tipo	Description
ID	transfer.id	string	O identificador exclusivo emitido por Quadrado.
ID do objeto catalog	transfer.catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Tipo de objeto de catálogo	transfer.catalog_object_type	string	O tipo do CatalogObject que está sendo rastreado.
Criado em	transfer.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do Funcionário	transfer.employee_id	string	A ID gerada por quadrado do Funcionário.
Da ID do local	transfer.from_location_id	string	A ID gerada por quadrado do Local em que a quantidade relacionada de itens foi rastreada antes da transferência.
ID de localização para	transfer.to_location_id	string	A ID gerada por quadrado do Local em que a quantidade relacionada de itens foi rastreada após a transferência.
Ocorreu em	transfer.occurred_at	string	Um carimbo de data/hora com formato RFC 3339 gerado pelo cliente que indica quando o ajuste de inventário ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora occurred_at não pode ter mais de 24 horas ou no futuro em relação à hora da solicitação.
Quantidade	transfer.quantity	string	O número de itens afetados pelo ajuste como uma cadeia de caracteres decimal. Pode dar suporte a até 5 dígitos após o ponto decimal.
ID de Referência	transfer.reference_id	string	Uma ID de referência opcional definida pelo usuário.
Product	transfer.source.product	string	Tipo de produto para o aplicativo.
ID do aplicativo	transfer.source.application_id	string	ID quadrada somente leitura atribuída ao aplicativo.
Nome	transfer.source.name	string	O nome.
Estado	transfer.state	string	O estado atual.

Registrar domínio para Apple Pay

ID da operação:: ApplePayRegister

Ativa um domínio para uso com o Apple Pay na Web e no Square. Uma validação é executada nesse domínio pela Apple para garantir que ela seja configurada corretamente como um domínio habilitado para Apple Pay.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome de domínio	domain_name	True	string	Um nome de domínio conforme descrito no RFC-1034 que será registrado no Apple Pay.

Retornos

Nome	Caminho	Tipo	Description
Situação	status	string	O status do registro de domínio.

Remover grupo do cliente

ID da operação:: CustomerRemoveGroup

Remove uma associação de grupo de um cliente. O cliente é identificado pelo valor customer_id e o grupo de clientes é identificado pelo valor group_id.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customer_id	True	string	O identificador do cliente.
ID do grupo	group_id	True	string	O identificador do grupo.

Retornos

response: object

Retomar assinatura

ID da operação:: SubscriptionResume

Retoma uma assinatura desativada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscription_id	True	string	O identificador da assinatura.

Retornos

Nome	Caminho	Tipo	Description
ID	subscription.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	subscription.location_id	string	O identificador do local.
ID do Plano	subscription.plan_id	string	A ID do plano de assinatura associado.
ID do cliente	subscription.customer_id	string	A ID desse objeto que representa o cliente.
Situação	subscription.status	string	O status de verificação atual desse objeto.
Quantidade	subscription.price_override_money.amount	integer	O valor.
Moeda	subscription.price_override_money.currency	string	A moeda.
Versão	subscription.version	integer	A versão atual deste objeto.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Nome	subscription.source.name	string	O nome.

Definições

objeto

Esse é o tipo 'object'.

Compartilhar via

Pagamentos Quadrados (Editor Independente) (Versão Prévia)

Limitações

Ações

Aceitar disputa

Parâmetros

Retornos

Adicionar grupo ao cliente

Parâmetros

Retornos

Alterações de inventário de recuperação de lote

Parâmetros

Retornos

Atualizar assinatura

Parâmetros

Retornos

Atualizar fatura

Parâmetros

Retornos

Atualizar grupo de clientes

Parâmetros

Retornos

Atualizar impostos sobre itens

Parâmetros

Retornos

Atualizar listas de modificadores de item

Parâmetros

Retornos

Atualizar o pagamento

Parâmetros

Retornos

Atualização de cliente

Parâmetros

Retornos

Calcular ordem (Beta)

Parâmetros

Retornos

Cancelar assinatura

Parâmetros

Retornos

Cancelar check-out do terminal

Parâmetros

Retornos

Cancelar fatura

Parâmetros

Retornos

Cancelar o pagamento por chave de idempotency

Parâmetros

Retornos

Cancelar pagamento

Parâmetros

Retornos

Cancelar reembolso do terminal

Parâmetros

Retornos

Catálogo de listas

Parâmetros

Retornos

Concluir o pagamento

Parâmetros

Retornos

Contagens de inventário de recuperação de lote

Parâmetros

Retornos

Criar assinatura

Parâmetros

Retornos

Criar cartão

Parâmetros

Retornos

Criar check-out de terminal

Parâmetros

Retornos

Criar fatura

Parâmetros

Retornos

Criar grupo de clientes

Parâmetros

Retornos

Criar ordem