Square Payments (Editora Independente) (Pré-visualização)

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

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Troia Taylor
Sítio Web	https://squareup.com/
Política de privacidade	https://squareup.com/us/en/legal/general/privacy
Categorias	Comércio; Vendas e CRM

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Aceitar disputa	Aceita a perda em uma disputa. A Square devolve o valor contestado ao titular do cartão e atualiza o estado de disputa para ACEITO. A Square debita o valor contestado da conta Square 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.
Apresentar elementos de prova	Apresenta provas ao banco do titular do cartão. Antes de apresentar provas, a Square compila todas as provas disponíveis. Isso inclui evidências carregadas usando os pontos de extremidade CreateDisputeEvidenceFile e CreateDisputeEvidenceText e evidências fornecidas automaticamente pela Square, quando disponíveis.
Atualizar 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 um objeto vazio.
Atualizar fatura	Atualiza uma fatura modificando campos, limpando campos ou ambos.
Atualizar grupo de clientes	Atualiza um grupo de clientes.
Atualizar impostos de itens	Atualiza os objetos CatalogTax que se aplicam ao CatalogItem de destino sem ter que executar um upsert em todo o item.
Atualizar listas de modificadores de itens	Atualiza os objetos CatalogModifierList que se aplicam ao CatalogItem de destino sem precisar executar um upsert em todo o item.
Atualizar pagamento	Atualiza um pagamento com o status APROVADO. Você pode atualizar o amount_money e tip_money usando esse ponto de extremidade.
Atualizar subscrição	Atualiza uma assinatura. Você pode definir, modificar e limpar os valores do campo de assinatura.
Calcular ordem (Beta)	Permite que os aplicativos visualizem os preços dos pedidos sem criar um pedido.
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 cobrar pagamentos pela fatura cancelada.
Cancelar pagamento	Cancela (anula) um pagamento. Você pode usar esse ponto de extremidade para cancelar um pagamento com o status APROVADO.
Cancelar pagamento por chave idempotency	Cancela (anula) um pagamento identificado pela chave de idempotência especificada na solicitação. Use esse método quando o status de uma solicitação CreatePayment é desconhecido (por exemplo, depois de enviar uma solicitação CreatePayment, ocorre um erro de rede e você não obtém uma resposta). Neste caso, você pode direcionar a Square para cancelar o pagamento usando este endpoint. Na solicitação, você fornece a mesma chave de idempotência fornecida na 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 idempotência especificada for encontrado, nenhuma ação será executada e o ponto de extremidade retornará com êxito.
Cancelar reembolso do terminal	Cancela um pedido de reembolso do Terminal Interac pelo ID do pedido de reembolso se o estado do pedido o permitir.
Cancelar subscrição	Define o campo canceled_date como o final do período de faturamento ativo. Após essa data, o status muda de ATIVO para CANCELADO.
Checkouts no terminal de pesquisa	Recupera uma lista filtrada de solicitações de check-out do Terminal criadas pela conta que faz a solicitação.
Contagens de inventário de recuperação de lote	Retorna contagens atuais para os CatalogObjects fornecidos nos locais solicitados.
Criar cartão	Adiciona um cartão registado a um comerciante existente.
Criar check-out de terminal	Cria uma solicitação de checkout do Terminal e a envia para o dispositivo especificado para receber um pagamento pelo valor solicitado.
Criar cliente	Cria um novo cliente para uma empresa.
Criar encomenda	Cria um novo pedido que pode incluir informações sobre produtos para compra e configurações a serem aplicadas à compra.
Criar fatura	Cria uma fatura de rascunho para um pedido criado usando a API de pedidos. Um rascunho de fatura permanece na sua conta e nenhuma ação é tomada. Você deve publicar a fatura antes que a Square possa processá-la (enviá-la para o endereço de e-mail do cliente ou cobrar o cartão do cliente em arquivo).
Criar grupo de clientes	Cria um novo grupo de clientes para uma empresa.
Criar pagamento	Cria um pagamento usando a fonte fornecida. Pode utilizar este ponto final para cobrar um cartão (cartão de crédito/débito ou cartão-presente Square) ou registar 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 Square.
Criar subscrição	Cria uma assinatura para um cliente de um plano de assinatura. Se você fornecer um cartão registrado na solicitação, a Square cobrará o cartão pela assinatura. Caso contrário, a Square cobra uma fatura para o endereço de e-mail do cliente. A assinatura começa imediatamente, a menos que a solicitação inclua o start_date opcional. Cada assinatura individual está associada a um local específico.
Criar texto de evidência de disputa	Carrega texto para usar como prova para uma contestação de disputa.
Desativar cartão	Desativa o cartão, impedindo novas atualizações ou cobranças. A desativação de um cartão já desativado é permitida, mas não tem efeito.
Eliminar provas de litígio	Remove provas especificadas de uma disputa.
Excluir cliente	Exclui um perfil de cliente de uma empresa. Esta operação também desvincula todos os cartões associados no arquivo.
Excluir fatura	Exclui a fatura especificada. Quando uma fatura é excluída, o status do pedido associado muda para CANCELADO. Só pode eliminar uma fatura de rascunho (não pode eliminar uma fatura publicada, incluindo uma fatura 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 tal que todos os filhos do objeto de destino também são excluídos. Por exemplo, excluir um CatalogItem também excluirá todos os seus filhos CatalogItemVariation .
Excluir objetos de catálogo em lote	Exclui um conjunto de CatalogItems com base na lista fornecida de IDs de destino e retorna um conjunto de IDs excluídos com êxito na resposta.
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 de lote	Aplica ajustes e contagens às quantidades de itens fornecidas. Em caso de êxito: retorna as contagens calculadas atuais para todos os objetos referenciados na solicitação.
Listar cartões	Recupera uma lista de cartões de propriedade da conta que faz a solicitação.
Listar catálogo	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.
Listar clientes	Lista os perfis de clientes associados a uma conta Square. Em condições normais de funcionamento, os perfis de clientes 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 cerca de um minuto ou mais, especialmente durante incidentes de rede e interrupções.
Listar disputas	Devolve uma lista de litígios associados a uma conta específica.
Listar eventos de assinatura	Lista todos os eventos de 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 faz 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 disputa	Devolve uma lista de provas associadas a um litígio.
Listar reembolsos de pagamento	Recupera uma lista de reembolsos para a conta que faz 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 recuperação em lote	Retorna um conjunto de objetos com base na ID fornecida. Cada CatalogItem retornado no conjunto inclui todas as suas informações filhas, incluindo: todos os seus objetos CatalogItemVariation , referências a seus objetos CatalogModifierList e as ids de quaisquer objetos CatalogTax que se aplicam a ele.
Objetos de catálogo de upsert em 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 estiver 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 ser bem-sucedidos. Cada lote pode conter até 1.000 objetos, e os lotes serão processados em ordem, desde que a contagem total de objetos para a solicitação (itens, variações, listas modificadoras, descontos e impostos) não seja superior a 10.000.
Obter checkout do terminal	Recupera uma solicitação de check-out do Terminal por checkout_id.
Obter fatura	Recupera uma fatura por ID de fatura.
Obter reembolso do 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. Pedidos com um estado CONCLUÍDO ou CANCELADO não podem ser atualizados.
Ordem de clonagem (Beta)	Cria uma nova ordem, no estado DRAFT, duplicando uma ordem existente. A ordem recém-criada tem apenas os campos principais (como itens de linha, impostos e descontos) copiados da ordem original.
Ordem de pagamento (Beta)	Pague por uma encomenda utilizando um ou mais pagamentos aprovados ou liquide uma encomenda com um total de 0. O total dos payment_ids listados na solicitação deve ser igual ao total do pedido. Pedidos com um valor total de 0 podem ser marcados como pagos especificando uma matriz vazia de payment_ids na solicitação.
Pagamento completo	Conclui (captura) um pagamento. Por padrão, os pagamentos são definidos para serem concluídos imediatamente após serem criados.
Pagamento do reembolso	Reembolsa um pagamento. Você pode reembolsar o valor total do 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 recuperação de lote	Recupera um conjunto de ordens por seus IDs. Se um determinado ID de ordem não existir, o ID será ignorado em vez de gerar um erro.
Pesquisar clientes	Pesquisa os perfis de clientes associados a uma conta Square usando um filtro de consulta suportado. Chamar SearchCustomers sem qualquer filtro de consulta explícito retorna todos os perfis de clientes ordenados alfabeticamente com base em given_name e family_name.
Pesquisar faturas	Procura faturas a partir de um local especificado no filtro.
Pesquisar objetos do catálogo	Procura CatalogObject de qualquer tipo fazendo a correspondência de valores de atributos de pesquisa suportados, excluindo valores de atributos personalizados em itens ou variações de itens, em relação a um ou mais dos filtros de consulta especificados.
Pesquisar subscrições	Procura subscrições. Os resultados são ordenados cronologicamente por data de criação da subscrição. 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 dentro de cada local. Se nenhum local for fornecido na consulta, todos os locais serão pesquisados.
Procurar encomendas	Pesquise todos os pedidos para um ou mais locais. Os pedidos incluem todas as vendas, devoluções e trocas, independentemente de como ou quando entraram no ecossistema da Square (como Ponto de Venda, Faturas e APIs Connect).
Publicar fatura	Publica o rascunho de fatura especificado. Depois que uma fatura é publicada, a Square faz o acompanhamento com base na configuração da fatura. Por exemplo, a Square envia a fatura para o endereço de e-mail do cliente, cobra o cartão do cliente em arquivo ou não faz nada. A Square também disponibiliza a fatura em uma página de fatura hospedada pela Square.
Receba o pagamento	Recupera detalhes de um pagamento específico.
Recuperar ajuste de estoque	Retorna o objeto InventoryAdjustment com a adjustment_id fornecida.
Recuperar cartão	Recupera detalhes de um Cartão específico.
Recuperar cliente	Retorna detalhes de um único cliente.
Recuperar contagem de inventário	Recupera a contagem de estoque calculada atual para um determinado CatalogObject em um determinado conjunto de Locations.
Recuperar contagem física de inventário	Retorna o objeto InventoryPhysicalCount com a physical_count_id fornecida.
Recuperar disputa	Retorna detalhes sobre uma disputa específica.
Recuperar encomenda	Recupera um pedido por ID.
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 de CatalogItem, incluindo: filhos CatalogItemVariation , referências a seus objetos CatalogModifierList e as ids de quaisquer objetos CatalogTax que se aplicam a ele.
Recuperar provas de litígio	Retorna os metadados de evidência especificados pelo ID de evidência no caminho da URL da solicitação. Deve manter uma cópia dos elementos de prova carregados se pretender consultá-los mais tarde. Não é possível descarregar as provas depois de as carregar.
Recuperar segmento de clientes	Recupera um segmento de cliente específico.
Recuperar subscrição	Recupera uma assinatura.
Recuperar transferência de inventário (Beta)	Retorna o objeto InventoryTransfer com a transfer_id fornecida.
Reembolsos do terminal de pesquisa	Recupera uma lista filtrada de solicitações de reembolso do Terminal Interac criadas pelo vendedor que faz a solicitação.
Registrar domínio para o Apple Pay	Ativa um domínio para uso com o Apple Pay na Web e no Square. Uma validação é realizada neste domínio pela Apple para garantir que ele esteja configurado 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 subscrição	Retoma uma subscrição desativada.

Aceitar disputa

ID da Operação:: DisputeAccept

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.

Devoluções

Name	Caminho	Tipo	Description
ID	dispute.id	string	O identificador único, emitido pela Square.
Montante	dispute.amount_money.amount	integer	O montante.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	A razão para este objeto.
Estado	dispute.state	string	O estado atual.
Vencimento em	dispute.due_at	string	A hora em que a próxima ação é devida, no formato RFC 3339.
Pagamentos contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID único do pagamento gerado pela Square.
Marca do 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 deste 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 deste objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	O ID da disputa no sistema de marca do cartão, gerado pela marca do 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

Name	Chave	Necessá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.

Devoluções

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

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

Devoluções

Name	Caminho	Tipo	Description
Changes	changes	array of object
Tipo	changes.type	string	O tipo deste objeto.
ID	changes.physical_count.id	string	O identificador do objeto
ID de Referência	changes.physical_count.reference_id	string	Um ID de referência opcional definido pelo utilizador que associa este cartão a outra entidade num sistema externo.
ID do objeto do catálogo	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 atual do estoque para a quantidade relacionada de itens.
ID da Localização	changes.physical_count.location_id	string	O ID de localização de um destinatário (que não o comerciante) que recebe uma parte desta proposta.
Quantidade	changes.physical_count.quantity	string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Produto	changes.physical_count.source.product	string	Tipo de produto para a aplicação.
ID da aplicação	changes.physical_count.source.application_id	string	ID quadrado atribuído ao aplicativo.
Nome	changes.physical_count.source.name	string	O nome do item.
ID do funcionário	changes.physical_count.employee_id	string	O ID gerado pela Praça do Funcionário responsável pela contagem física.
ocorreu em	changes.physical_count.occurred_at	string	Um carimbo de data/hora formatado em 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 formatado RFC 3339 gerado pelo cliente que indica quando a contagem física foi criada.

Apresentar elementos de prova

ID da Operação:: EvidenceSubmit

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.

Devoluções

Name	Caminho	Tipo	Description
ID	dispute.id	string	O identificador único, emitido pela Square.
Montante	dispute.amount_money.amount	integer	O montante.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	A razão para este objeto.
Estado	dispute.state	string	O estado atual.
Vencimento em	dispute.due_at	string	A hora em que a próxima ação é devida, no formato RFC 3339.
Pagamentos contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID único do pagamento gerado pela Square.
Marca do 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 deste 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 deste objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	O ID da disputa no sistema de marca do cartão, gerado pela marca do cartão.

Atualizar 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 um objeto vazio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Cliente	customer_id	True	string	O identificador do cliente.

Devoluções

Name	Caminho	Tipo	Description
ID	customer.id	string	O identificador único, emitido pela Square.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Nome Próprio	customer.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	customer.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	customer.email_address	string	O endereço de e-mail 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 da rua, nome da rua e nome do edifício.
Endereço Linha 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um ID de referência opcional definido pelo usuário.
Observação	customer.note	string	Uma nota personalizada associada ao perfil do cliente.
E-mail não inscrito	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a inscrição nos e-mails da campanha de marketing. Um valor verdadeiro significa que o cliente optou por não receber e-mail marketing do vendedor atual da Square ou de todos os vendedores da Square.
Fonte de 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.

Atualizar fatura

ID da Operação:: InvoiceUpdate

Atualiza uma fatura modificando campos, limpando campos ou ambos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
UID	uid		string	O ID gerado pela Square.
Gorjetas ativadas	tipping_enabled		boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Campos a limpar	fields_to_clear		array of string

Devoluções

Name	Caminho	Tipo	Description
ID	invoice.id	string	O identificador único, emitido pela Square.
Versão	invoice.version	integer	A versão atual deste objeto.
ID da Localização	invoice.location_id	string	O identificador do local.
ID da encomenda	invoice.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	O ID gerado pela Square.
Tipo de Pedido	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 Para Conclusão	invoice.payment_requests.due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	invoice.payment_requests.tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Montante	invoice.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoice.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoice.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Número da Fatura	invoice.invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui 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 deste objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar 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 deste 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 deste objeto, no formato RFC 3339.
ID do Cliente	invoice.primary_recipient.customer_id	string	O ID do cliente associado ao pedido.
Nome Próprio	invoice.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoice.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoice.primary_recipient.email_address	string	O endereço de e-mail do destinatário.
Número de Telefone	invoice.primary_recipient.phone_number	string	O número de telefone do destinatário.
Montante	invoice.next_payment_amount_money.amount	integer	O montante.
Moeda	invoice.next_payment_amount_money.currency	string	A moeda.
Card	invoice.accepted_payment_methods.card	boolean	Indica se os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	A localização do campo personalizado na fatura.
Método de Entrega	invoice.delivery_method	string	O método de entrega que a 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 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

Atualizar grupo de clientes

ID da Operação:: CustomerGroupUpdate

Atualiza um grupo de clientes.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.
Nome	name		string	O nome do objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	group.id	string	O identificador único, emitido pela Square.
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 deste 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 deste objeto, no formato RFC 3339.

Atualizar impostos de itens

ID da Operação:: CatalogUpdateTaxes

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

Parâmetros

Name	Chave	Tipo
Item IDs	item_ids	array of string
Impostos a Habilitar	taxes_to_enable	array of string
Impostos a desativar	taxes_to_disable	array of string

Devoluções

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

Atualizar listas de modificadores de itens

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

Name	Chave	Tipo
Item IDs	item_ids	array of string
Listas de modificadores a serem habilitadas	modifier_lists_to_enable	array of string
Listas de modificadores a serem desabilitadas	modifier_lists_to_disable	array of string

Devoluções

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

Atualizar 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

Name	Chave	Necessário	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Token de versão	version_token		string	Esse token opaco identifica uma versão específica do objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	payment.id	string	O identificador único, emitido pela Square.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	payment.amount_money.amount	integer	O montante.
Moeda	payment.amount_money.currency	string	A moeda.
Montante	payment.tip_money.amount	integer	O montante.
Moeda	payment.tip_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual deste 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. Esta delay_action automática aplica-se apenas a pagamentos que não atinjam um estado terminal (CONCLUÍDO, CANCELADO ou REPROVADO) antes do período de tempo delay_duration. Este campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de fonte	payment.source_type	string	O tipo de origem para este pagamento. Os valores atuais incluem CARTÃO, BANK_ACCOUNT, CARTEIRA, DINHEIRO ou EXTERNO.
Situação	payment.card_details.status	string	O status atual.
Marca do 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.
Exp Mês	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Método de entrada	payment.card_details.entry_method	string	O método utilizado para introduzir os dados do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Situação do CVV	payment.card_details.cvv_status	string	O código de status retornado da verificação do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado do AVS	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payment.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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 da Localização	payment.location_id	string	O identificador do local.
ID da encomenda	payment.order_id	string	O ID do pedido.
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 nota personalizada associada ao perfil do cliente.
ID do Cliente	payment.customer_id	string	A ID deste objeto que representa o cliente.
Montante	payment.total_money.amount	integer	O montante.
Moeda	payment.total_money.currency	string	A moeda.
Montante	payment.approved_money.amount	integer	O montante.
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 de pagamento. O campo está ausente se um pagamento for cancelado.
Ação de atraso	payment.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payment.application_details.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Token de versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Atualizar subscrição

ID da Operação:: SubscriptionUpdate

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscription_id	True	string	O identificador da assinatura.
Versão	version		integer	A versão atual deste objeto.
Percentagem de Imposto	tax_percentage		string	O valor do imposto aplicado ao faturar a subscrição.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.

Devoluções

Name	Caminho	Tipo	Description
ID	subscription.id	string	O identificador único, emitido pela Square.
ID da Localização	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 deste objeto que representa o cliente.
Situação	subscription.status	string	O status de verificação atual deste objeto.
Montante	subscription.price_override_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar 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.

Calcular ordem (Beta)

ID da Operação:: OrderCalculate

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

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID da Localização	location_id	string	O identificador do local.
Nome	name	string	O nome do item. Este é 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.
Percentagem	percentage	string	A percentagem 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. Este é 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 decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.

Devoluções

Name	Caminho	Tipo	Description
ID da Localização	order.location_id	string	O identificador do local.
Itens de linha	order.line_items	array of object
UID	order.line_items.uid	string	O ID gerado pela Square.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Nome	order.line_items.name	string	O nome do item. Este é 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.
Montante	order.line_items.base_price_money.amount	integer	O montante.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_money.amount	integer	O montante.
Moeda	order.line_items.total_money.currency	string	A moeda.
Montante	order.line_items.variation_total_price_money.amount	integer	O montante.
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	Um ID atribuído ao quadrado.
Desconto UID	order.line_items.applied_discounts.discount_uid	string	O uid do desconto que o desconto aplicado representa.
Montante	order.line_items.applied_discounts.applied_money.amount	integer	O montante.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	O ID gerado pela Square.
Nome	order.discounts.name	string	O nome do item. Este é 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.
Percentagem	order.discounts.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.discounts.applied_money.amount	integer	O montante.
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 deste 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 deste objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
Montante	order.total_tax_money.amount	integer	O montante.
Moeda	order.total_tax_money.currency	string	A moeda.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Montante	order.total_tip_money.amount	integer	O montante.
Moeda	order.total_tip_money.currency	string	A moeda.
Montante	order.total_money.amount	integer	O montante.
Moeda	order.total_money.currency	string	A moeda.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.tip_money.amount	integer	O montante.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.

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

Name	Chave	Necessário	Tipo	Description
Checkout ID	checkout_id	True	string	O identificador do checkout.

Devoluções

Name	Caminho	Tipo	Description
ID	checkout.id	string	O identificador único, emitido pela Square.
Montante	checkout.amount_money.amount	integer	O montante.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Um ID de referência opcional definido pelo usuário.
ID do dispositivo	checkout.device_options.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalCheckout.
Permitir gorjetas	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a gorjeta está habilitada para este check-out. É definido para false por padrão.
Ignorar tela de recibo	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recibo. É definido para false por padrão.
Situação	checkout.status	string	O status de verificação atual deste 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 deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	checkout.app_id	string	A ID do aplicativo que criou o checkout.
Duração do Prazo	checkout.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação

Cancelar fatura

ID da Operação:: InvoiceCancel

Cancela uma fatura. O vendedor não pode cobrar pagamentos pela fatura cancelada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Versão	version		integer	A versão.

Devoluções

Name	Caminho	Tipo	Description
ID	invoice.id	string	O identificador único, emitido pela Square.
Versão	invoice.version	integer	A versão atual deste objeto.
ID da Localização	invoice.location_id	string	O identificador do local.
ID da encomenda	invoice.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	O ID gerado pela Square.
Tipo de Pedido	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 Para Conclusão	invoice.payment_requests.due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	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	Um ID atribuído ao 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) do pedido 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.
Montante	invoice.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoice.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoice.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Número da Fatura	invoice.invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui 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 deste objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar 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 deste 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 deste objeto, no formato RFC 3339.
ID do Cliente	invoice.primary_recipient.customer_id	string	O ID do cliente associado ao pedido.
Nome Próprio	invoice.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoice.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoice.primary_recipient.email_address	string	O endereço de e-mail 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 os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	A localização do campo personalizado na fatura.
Método de Entrega	invoice.delivery_method	string	O método de entrega que a 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 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

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 APROVADO.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Devoluções

Name	Caminho	Tipo	Description
ID	payment.id	string	O identificador único, emitido pela Square.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	payment.amount_money.amount	integer	O montante.
Moeda	payment.amount_money.currency	string	A moeda.
Montante	payment.tip_money.amount	integer	O montante.
Moeda	payment.tip_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual deste 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. Esta delay_action automática aplica-se apenas a pagamentos que não atinjam um estado terminal (CONCLUÍDO, CANCELADO ou REPROVADO) antes do período de tempo delay_duration. Este campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de fonte	payment.source_type	string	O tipo de origem para este pagamento. Os valores atuais incluem CARTÃO, BANK_ACCOUNT, CARTEIRA, DINHEIRO ou EXTERNO.
Situação	payment.card_details.status	string	O status atual.
Marca do 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.
Exp Mês	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Método de entrada	payment.card_details.entry_method	string	O método utilizado para introduzir os dados do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Situação do CVV	payment.card_details.cvv_status	string	O código de status retornado da verificação do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado do AVS	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payment.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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.
Esvaziado 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 da Localização	payment.location_id	string	O identificador do local.
ID da encomenda	payment.order_id	string	O ID do pedido.
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 nota personalizada associada ao perfil do cliente.
ID do Cliente	payment.customer_id	string	A ID deste objeto que representa o cliente.
Montante	payment.total_money.amount	integer	O montante.
Moeda	payment.total_money.currency	string	A moeda.
Montante	payment.approved_money.amount	integer	O montante.
Moeda	payment.approved_money.currency	string	A moeda.
Ação de atraso	payment.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payment.application_details.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Token de versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Cancelar pagamento por chave idempotency

ID da Operação:: PaymentCancelIdempotency

Cancela (anula) um pagamento identificado pela chave de idempotência especificada na solicitação. Use esse método quando o status de uma solicitação CreatePayment é desconhecido (por exemplo, depois de enviar uma solicitação CreatePayment, ocorre um erro de rede e você não obtém uma resposta). Neste caso, você pode direcionar a Square para cancelar o pagamento usando este endpoint. Na solicitação, você fornece a mesma chave de idempotência fornecida na 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 idempotência especificada for encontrado, nenhuma ação será executada e o ponto de extremidade retornará com êxito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

response: object

Cancelar reembolso do terminal

ID da Operação:: TerminalCancelRefund

Cancela um pedido de reembolso do Terminal Interac pelo ID do pedido de reembolso se o estado do pedido o permitir.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de reembolso do terminal	terminal_refund_id	True	string	O identificador do reembolso do terminal.

Devoluções

Name	Caminho	Tipo	Description
ID	refund.id	string	O identificador único, emitido pela Square.
ID de pagamento	refund.payment_id	string	O ID exclusivo do pagamento.
Montante	refund.amount_money.amount	integer	O montante.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	A razão para este objeto.
ID do dispositivo	refund.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalRefund.
Duração do Prazo	refund.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Situação	refund.status	string	O status de verificação atual deste 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 deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	refund.app_id	string	A ID do aplicativo que criou o checkout.
Marca do 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.
Exp Mês	refund.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
ID da encomenda	refund.order_id	string	O ID do pedido.
ID da Localização	refund.location_id	string	O identificador do local.

Cancelar subscrição

ID da Operação:: SubscriptionCancel

Define o campo canceled_date como o final do período de faturamento ativo. Após essa data, o status muda de ATIVO para CANCELADO.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscription_id	True	string	O identificador da assinatura.

Devoluções

Name	Caminho	Tipo	Description
ID	subscription.id	string	O identificador único, emitido pela Square.
ID da Localização	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 deste objeto que representa o cliente.
Identificação do cartão	subscription.card_id	string	A ID do cartão de cliente que é cobrado pela assinatura.
Data de início	subscription.start_date	string	A data de início da subscrição, no formatoMM-DD AAAA.
Data cancelada	subscription.canceled_date	string	A data de cancelamento da subscrição, no formato AAAA-MM-DD.
Pago até à data	subscription.paid_until_date	string	A data paga até.
Situação	subscription.status	string	O status de verificação atual deste objeto.
Criado em	subscription.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 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.

Checkouts no terminal de pesquisa

ID da Operação:: TerminalSearchCheckouts

Recupera uma lista filtrada de solicitações de check-out do Terminal criadas pela conta que faz a solicitação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.
Situação	status		string	O status atual.

Devoluções

Name	Caminho	Tipo	Description
Checkouts	checkouts	array of object
ID	checkouts.id	string	O identificador único, emitido pela Square.
Montante	checkouts.amount_money.amount	integer	O montante.
Moeda	checkouts.amount_money.currency	string	A moeda.
ID de Referência	checkouts.reference_id	string	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
Observação	checkouts.note	string	Uma nota personalizada associada ao perfil do cliente.
ID do dispositivo	checkouts.device_options.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalCheckout.
Permitir gorjetas	checkouts.device_options.tip_settings.allow_tipping	boolean	Indica se a gorjeta está habilitada para este check-out. É definido para false por padrão.
Ignorar tela de recibo	checkouts.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recibo. É definido para false por padrão.
Situação	checkouts.status	string	O status de verificação atual deste 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 de Aplicação	checkouts.app_id	string	A ID do aplicativo que criou o checkout.
Duração do Prazo	checkouts.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

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

ID da Operação:: InventoryBatchRetrieveCounts

Retorna contagens atuais para os CatalogObjects fornecidos nos locais solicitados.

Parâmetros

Name	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 calculated_at após o tempo determinado, conforme especificado em um carimbo de data/hora RFC 3339.

Devoluções

Name	Caminho	Tipo	Description
Contagens	counts	array of object
ID do objeto do catálogo	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 da Localização	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia decimal. Pode suportar até 5 dígitos após a vírgula decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física mais recente ou o ajuste que afeta a contagem estimada é recebido.

Criar cartão

ID da Operação:: CardCreate

Adiciona um cartão registado a um comerciante existente.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	A chave de idempotência.
ID de origem	source_id	string	O identificador da fonte.
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 da rua, nome da rua e nome do edifício.
Endereço Linha 2	address_line_2	string	A segunda linha do endereço, se houver.
Localidade	locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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 deste objeto que representa o cliente.
ID de Referência	reference_id	string	Um ID de referência opcional definido pelo usuário.

Devoluções

Name	Caminho	Tipo	Description
ID	card.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Endereço Linha 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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Concebido como um identificador atribuído ao quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
COMPARTIMENTO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Marca do 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 deste objeto que representa o cliente.
Ativado(a)	card.enabled	boolean	Se ativado.
Exp Mês	card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Um ID de referência opcional definido 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 checkout do Terminal e a envia para o dispositivo especificado para receber um pagamento pelo valor solicitado.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.
ID de Referência	reference_id	string	Um ID de referência opcional definido pelo usuário.
ID do dispositivo	device_id	string	O ID exclusivo do dispositivo destinado a este TerminalCheckout.
Observação	note	string	Uma nota personalizada associada ao perfil do cliente.

Devoluções

Name	Caminho	Tipo	Description
ID	checkout.id	string	O identificador único, emitido pela Square.
Montante	checkout.amount_money.amount	integer	O montante.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Um ID de referência opcional definido pelo usuário.
Observação	checkout.note	string	Uma nota personalizada associada ao perfil do cliente.
ID do dispositivo	checkout.device_options.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalCheckout.
Permitir gorjetas	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a gorjeta está habilitada para este check-out. É definido para false por padrão.
Ignorar tela de recibo	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recibo. É definido para false por padrão.
Situação	checkout.status	string	O status de verificação atual deste objeto.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	checkout.app_id	string	A ID do aplicativo que criou o checkout.
Duração do Prazo	checkout.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Tipo de Pagamento	checkout.payment_type	string	O tipo de pagamento que o terminal deve tentar capturar. O padrão é CARD_PRESENT.

Criar cliente

ID da Operação:: CustomerCreate

Cria um novo cliente para uma empresa.

Parâmetros

Name	Chave	Tipo	Description
Nome Próprio	given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao perfil do cliente.
Nome de família	family_name	string	O nome da família (ou seja, o sobrenome) associado ao perfil do cliente.
Endereço de E-mail	email_address	string	O endereço de e-mail associado ao perfil do cliente.
Nome da Empresa	company_name	string	Um nome comercial associado ao perfil do cliente.
Apelido	nickname	string	Um apelido para o perfil do cliente.
Linha de Endereço 1	address_line_1	string	A primeira linha do endereço.
Endereço Linha 2	address_line_2	string	A segunda linha do endereço, se houver.
Localidade	locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
Observação	note	string	Uma nota 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 deMM-DD AAAA.

Devoluções

Name	Caminho	Tipo	Description
ID	customer.id	string	O identificador único, emitido pela Square.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Nome Próprio	customer.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	customer.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	customer.email_address	string	O endereço de e-mail associado ao perfil do cliente.
Nome da Empresa	customer.company_name	string	Um nome comercial associado ao perfil do cliente.
Apelido	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 da rua, nome da rua e nome do edifício.
Endereço Linha 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um ID de referência opcional definido pelo usuário.
Observação	customer.note	string	Uma nota 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.
E-mail não inscrito	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a inscrição nos e-mails da campanha de marketing. Um valor verdadeiro significa que o cliente optou por não receber e-mail marketing do vendedor atual da Square ou de todos os vendedores da Square.
Fonte de 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.

Criar encomenda

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

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID de Referência	reference_id	string	Um ID de referência opcional definido pelo usuário.
ID da Localização	location_id	string	O identificador do local.
Nome	name	string	O nome do item. Este é 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 decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.
ID do objeto do catálogo	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
ID do objeto do catálogo	catalog_object_id	string	O ID do objeto de catálogo.
Desconto UID	discount_uid	string	O uid do desconto que o desconto aplicado representa.
UID	uid	string	O ID gerado pela Square.
Nome	name	string	O nome do item. Este é 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.
Percentagem	percentage	string	A percentagem 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	O ID gerado pela Square.
Nome	name	string	O nome do item. Este é 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.
Percentagem	percentage	string	A percentagem 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 do catálogo	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.

Devoluções

Name	Caminho	Tipo	Description
ID	order.id	string	O identificador único, emitido pela Square.
ID da Localização	order.location_id	string	O identificador do local.
Itens de linha	order.line_items	array of object
UID	order.line_items.uid	string	O ID gerado pela Square.
Nome	order.line_items.name	string	O nome do item. Este é 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 decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Impostos Aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Um ID atribuído ao quadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	O UID do imposto para o qual este imposto aplicado representa.
Montante	order.line_items.applied_taxes.applied_money.amount	integer	O montante.
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	Um ID atribuído ao quadrado.
Desconto UID	order.line_items.applied_discounts.discount_uid	string	O uid do desconto que o desconto aplicado representa.
Montante	order.line_items.applied_discounts.applied_money.amount	integer	O montante.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Montante	order.line_items.base_price_money.amount	integer	O montante.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_money.amount	integer	O montante.
Moeda	order.line_items.total_money.currency	string	A moeda.
Montante	order.line_items.variation_total_price_money.amount	integer	O montante.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
ID do objeto do catálogo	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	Um ID atribuído ao quadrado.
ID do objeto do catálogo	order.line_items.modifiers.catalog_object_id	string	O ID do objeto de catálogo.
Nome	order.line_items.modifiers.name	string	O nome do item. Este é 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.
Montante	order.line_items.modifiers.base_price_money.amount	integer	O montante.
Moeda	order.line_items.modifiers.base_price_money.currency	string	A moeda.
Montante	order.line_items.modifiers.total_price_money.amount	integer	O montante.
Moeda	order.line_items.modifiers.total_price_money.currency	string	A moeda.
Impostos	order.taxes	array of object
UID	order.taxes.uid	string	O ID gerado pela Square.
Nome	order.taxes.name	string	O nome do item. Este é 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.
Percentagem	order.taxes.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.taxes.applied_money.amount	integer	O montante.
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	O ID gerado pela Square.
ID do objeto do catálogo	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. Este é 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.
Percentagem	order.discounts.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.discounts.applied_money.amount	integer	O montante.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Scope	order.discounts.scope	string	Indica o nível atual.
Montante	order.discounts.amount_money.amount	integer	O montante.
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 deste 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 deste 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	Um ID de referência opcional definido pelo usuário.
Montante	order.total_money.amount	integer	O montante.
Moeda	order.total_money.currency	string	A moeda.
Montante	order.total_tax_money.amount	integer	O montante.
Moeda	order.total_tax_money.currency	string	A moeda.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Montante	order.total_tip_money.amount	integer	O montante.
Moeda	order.total_tip_money.currency	string	A moeda.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.tip_money.amount	integer	O montante.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Nome	order.source.name	string	O nome.

Criar fatura

ID da Operação:: InvoiceCreate

Cria uma fatura de rascunho para um pedido criado usando a API de pedidos. Um rascunho de fatura permanece na sua conta e nenhuma ação é tomada. Você deve publicar a fatura antes que a Square possa processá-la (enviá-la para o endereço de e-mail do cliente ou cobrar o cartão do cliente em arquivo).

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID da Localização	location_id	string	O identificador do local.
ID da encomenda	order_id	string	O ID do pedido.
Agendado em	scheduled_at	string	O carimbo de data/hora quando o processamento é agendado, no formato RFC 3339.
ID do Cliente	customer_id	string	O ID do cliente associado ao pedido.
Método de Entrega	delivery_method	string	O método de entrega que a 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 scheduled_at, se especificado.
Tipo de Pedido	request_type	string	Identifica o tipo de solicitação de pagamento. Esse tipo define como o valor da solicitação de pagamento é determinado.
Data Para Conclusão	due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	tipping_enabled	boolean	Se definido como true, fornece um lugar para o cliente pagar uma gorjeta.
Fonte de Pagamento Automático	automatic_payment_source	string	O método de pagamento para 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) do pedido de pagamento due_date quando o lembrete é enviado.
Número da Fatura	invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui um valor.
Title	title	string	O título.
Description	description	string	A descrição.
Card	card	boolean	Indica se os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Etiqueta	label	string	O rótulo ou título do campo personalizado.
Valor	value	string	O texto do campo personalizado.
Colocação	placement	string	A localização 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

Devoluções

Name	Caminho	Tipo	Description
ID	invoice.id	string	O identificador único, emitido pela Square.
Versão	invoice.version	integer	A versão atual deste objeto.
ID da Localização	invoice.location_id	string	O identificador do local.
ID da encomenda	invoice.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	O ID gerado pela Square.
Tipo de Pedido	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 Para Conclusão	invoice.payment_requests.due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	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	Um ID atribuído ao 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) do pedido 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.
Montante	invoice.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoice.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoice.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Número da Fatura	invoice.invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui 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 deste objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar 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 deste 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 deste objeto, no formato RFC 3339.
ID do Cliente	invoice.primary_recipient.customer_id	string	O ID do cliente associado ao pedido.
Nome Próprio	invoice.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoice.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoice.primary_recipient.email_address	string	O endereço de e-mail 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 os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	A localização do campo personalizado na fatura.
Método de Entrega	invoice.delivery_method	string	O método de entrega que a 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 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

Criar grupo de clientes

ID da Operação:: CustomGroupCreate

Cria um novo grupo de clientes para uma empresa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name		string	O nome do objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	group.id	string	O identificador único, emitido pela Square.
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 deste 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 deste objeto, no formato RFC 3339.

Criar pagamento

ID da Operação:: PaymentCreate

Cria um pagamento usando a fonte fornecida. Pode utilizar este ponto final para cobrar um cartão (cartão de crédito/débito ou cartão-presente Square) ou registar 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

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Montante	amount	integer	A quantidade de dinheiro a aceitar para este 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	O ID da fonte de financiamento para este pagamento. Pode ser um token de pagamento (cartão nonce) gerado pelo formulário de pagamento Square ou um cartão em arquivo feito com a API de Clientes. Se registrar um pagamento que o vendedor recebeu fora da Square, especifique CASH ou EXTERNAL.
Preenchimento Automático	autocomplete	boolean	Se definido como true, este pagamento será concluído quando possível. Se definido como false, esse pagamento é mantido em um estado aprovado até ser explicitamente concluído (capturado) ou cancelado (anulado).
ID do Cliente	customer_id	string	O ID do cliente a ser vinculado.
ID da Localização	location_id	string	O identificador de localização.
ID de Referência	reference_id	string	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
Observação	note	string	Uma nota personalizada associada ao perfil do cliente.
Montante	amount	integer	A quantidade de dinheiro a aceitar para este pagamento, não incluindo tip_money.
Moeda	currency	string	O código de moeda ISO 4217 de 3 caracteres.

Devoluções

Name	Caminho	Tipo	Description
ID	payment.id	string	O identificador único, emitido pela Square.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	payment.amount_money.amount	integer	O montante.
Moeda	payment.amount_money.currency	string	A moeda.
Montante	payment.app_fee_money.amount	integer	O montante.
Moeda	payment.app_fee_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual deste 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. Esta delay_action automática aplica-se apenas a pagamentos que não atinjam um estado terminal (CONCLUÍDO, CANCELADO ou REPROVADO) antes do período de tempo delay_duration. Este campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de fonte	payment.source_type	string	O tipo de origem para este pagamento. Os valores atuais incluem CARTÃO, BANK_ACCOUNT, CARTEIRA, DINHEIRO ou EXTERNO.
Situação	payment.card_details.status	string	O status atual.
Marca do 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.
Exp Mês	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Método de entrada	payment.card_details.entry_method	string	O método utilizado para introduzir os dados do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Situação do CVV	payment.card_details.cvv_status	string	O código de status retornado da verificação do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado do AVS	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payment.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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 da Localização	payment.location_id	string	O identificador do local.
ID da encomenda	payment.order_id	string	O ID do pedido.
ID de Referência	payment.reference_id	string	Um ID de referência opcional definido 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 nota personalizada associada ao perfil do cliente.
ID do Cliente	payment.customer_id	string	A ID deste objeto que representa o cliente.
Montante	payment.total_money.amount	integer	O montante.
Moeda	payment.total_money.currency	string	A moeda.
Montante	payment.approved_money.amount	integer	O montante.
Moeda	payment.approved_money.currency	string	A moeda.
Número do recibo	payment.receipt_number	string	O número do recibo de pagamento. O campo está ausente se um pagamento for cancelado.
URL do recibo	payment.receipt_url	string	O URL do recibo de pagamento. O campo só é preenchido para pagamentos CONCLUÍDOS.
Ação de atraso	payment.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payment.application_details.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Token de 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 Square.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.
ID do dispositivo	device_id	string	O ID exclusivo do dispositivo destinado a este TerminalRefund.
Reason	reason	string	A razão para este objeto.
ID de pagamento	payment_id	string	O ID exclusivo do pagamento.

Devoluções

Name	Caminho	Tipo	Description
ID	refund.id	string	O identificador único, emitido pela Square.
ID de pagamento	refund.payment_id	string	O ID exclusivo do pagamento.
Montante	refund.amount_money.amount	integer	O montante.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	A razão para este objeto.
ID do dispositivo	refund.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalRefund.
Duração do Prazo	refund.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Situação	refund.status	string	O status de verificação atual deste objeto.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	refund.app_id	string	A ID do aplicativo que criou o checkout.
Marca do 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.
Exp Mês	refund.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
ID da encomenda	refund.order_id	string	O ID do pedido.
ID da Localização	refund.location_id	string	O identificador do local.

Criar subscrição

ID da Operação:: SubscriptionCreate

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

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID da Localização	location_id	string	O identificador de localização.
ID do plano	plan_id	string	A ID do plano de assinatura criado usando a API do catálogo.
ID do Cliente	customer_id	string	O ID do cliente a ser vinculado.
Identificação do cartão	card_id	string	O ID do cartão de cliente a carregar.
Data de início	start_date	string	A data de início da subscrição, no formatoMM-DD AAAA.
Percentagem de Imposto	tax_percentage	string	O imposto a ser adicionado ao cobrar a assinatura.
Montante	amount	integer	A quantidade de dinheiro a aceitar para este 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.

Devoluções

Name	Caminho	Tipo	Description
ID	subscription.id	string	O identificador único, emitido pela Square.
ID da Localização	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 deste objeto que representa o cliente.
Data de início	subscription.start_date	string	A data de início da subscrição, no formatoMM-DD AAAA.
Situação	subscription.status	string	O status de verificação atual deste objeto.
Percentagem de Imposto	subscription.tax_percentage	string	O valor do imposto aplicado ao faturar a subscrição.
Montante	subscription.price_override_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
Identificação do cartão	subscription.card_id	string	A ID do cartão de cliente que é cobrado pela assinatura.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar 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 texto de evidência de disputa

ID da Operação:: DisputeCreateEvidenceText

Carrega texto para usar como prova para uma contestação de disputa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.
Tipo de evidência	evidence_type		string	O tipo de prova que está a carregar.
Texto de evidência	evidence_text		string	A cadeia de evidências.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	evidence.id	string	O identificador único, emitido pela Square.
ID do litígio	evidence.dispute_id	string	O ID do litígio ao qual a prova 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 é devida, no formato RFC 3339.

Desativar cartão

ID da Operação:: CardDisable

Desativa o cartão, impedindo novas atualizações ou cobranças. A desativação de um cartão já desativado é permitida, mas não tem efeito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Identificação do cartão	card_id	True	string	O identificador do cartão.

Devoluções

Name	Caminho	Tipo	Description
ID	card.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Endereço Linha 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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Concebido como um identificador atribuído ao quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
COMPARTIMENTO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Marca do 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 deste objeto que representa o cliente.
Ativado(a)	card.enabled	boolean	Se ativado.
Exp Mês	card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Um ID de referência opcional definido pelo usuário.
Versão	card.version	integer	A versão atual deste objeto.

Eliminar provas de litígio

ID da Operação:: DisputeDeleteEvidence

Remove provas especificadas de uma disputa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.
ID da prova	evidence_id	True	string	O identificador das provas.

Devoluções

response: object

Excluir cliente

ID da Operação:: CustomerDelete

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Cliente	customer_id	True	string	O identificador do cliente.

Devoluções

response: object

Excluir fatura

ID da Operação:: InvoiceDelete

Exclui a fatura especificada. Quando uma fatura é excluída, o status do pedido associado muda para CANCELADO. Só pode eliminar uma fatura de rascunho (não pode eliminar uma fatura publicada, incluindo uma fatura agendada para processamento).

Parâmetros

Name	Chave	Necessá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.

Devoluções

response: object

Excluir grupo de clientes

ID da Operação:: CustomerGroupDelete

Exclui um grupo de clientes conforme identificado pelo valor group_id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.

Devoluções

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 tal que todos os filhos do objeto de destino também são excluídos. Por exemplo, excluir um CatalogItem também excluirá todos os seus filhos CatalogItemVariation .

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do objeto	object_id	True	string	O identificador do objeto.

Devoluções

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

Excluir objetos de catálogo 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ídos com êxito na resposta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de objeto	object_ids		array of string

Devoluções

Name	Caminho	Tipo	Description
IDs de objeto excluídos	deleted_object_ids	array of string
Suprimido 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.

Devoluções

Name	Caminho	Tipo	Description
Batch Upsert Max Objects por lote	limits.batch_upsert_max_objects_per_batch	integer	O número máximo de objetos que podem aparecer dentro de um único lote em uma solicitação /v2/catalog/batch-upsert.
Batch Upsert Max Total de Objetos	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.
Batch Retrieve Max IDs de objeto	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áginas 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 de objeto máximo 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 de Item Máximos 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ídos em uma única solicitação /v2/catalog/update-item-taxes.
Atualizar impostos máximos de impostos de item para ativar	limits.update_item_taxes_max_taxes_to_enable	integer	O número máximo de IDs de imposto a serem habilitados que podem ser incluídos em uma única solicitação /v2/catalog/update-item-taxes.
Atualizar impostos de item Impostos máximos para desativar	limits.update_item_taxes_max_taxes_to_disable	integer	O número máximo de IDs fiscais a serem desabilitados que podem ser incluídos em uma única solicitação /v2/catalog/update-item-taxes.
Atualizar Modificador de Item Listas de IDs de Item Máximos	limits.update_item_modifier_lists_max_item_ids	integer	O número máximo de IDs fiscais a serem desabilitados que podem ser incluídos em uma única solicitação /v2/catalog/update-item-taxes.
Atualizar Listas de Modificadores de Itens Listas de Modificadores Máximos para Ativar	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	O número máximo de IDs de lista de modificadores a serem habilitados que podem ser incluídos em uma única solicitação /v2/catalog/update-item-modifier-lists.
Atualizar Listas de Modificadores de Itens Listas de Modificadores Máximos para Desativar	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	O número máximo de IDs de lista de modificadores a serem desabilitados que podem ser incluídos em uma única solicitação /v2/catalog/update-item-modifier-lists.

Inventário de alteração de lote

ID da Operação:: InventoryBatchChange

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

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Tipo	type	string	O tipo deste objeto.
ID de Referência	reference_id	string	Um ID de referência opcional definido pelo utilizador que associa este cartão a outra entidade num sistema externo.
ID do objeto do catálogo	catalog_object_id	string	A ID gerada por quadrado do CatalogObject que está sendo rastreado.
Estado	state	string	O estado atual do estoque para a quantidade relacionada de itens.
ID da Localização	location_id	string	O ID de localização de um destinatário (que não o comerciante) que recebe uma parte desta proposta.
Quantidade	quantity	string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
ID do funcionário	employee_id	string	O ID gerado pela Praça do Funcionário responsável pela contagem física.
ocorreu em	occurred_at	string	Um carimbo de data/hora formatado em 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.

Devoluções

Name	Caminho	Tipo	Description
Contagens	counts	array of object
ID do objeto do catálogo	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 da Localização	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia decimal. Pode suportar até 5 dígitos após a vírgula decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física mais recente ou o ajuste que afeta a contagem estimada é recebido.

Listar cartões

ID da Operação:: CardList

Recupera uma lista de cartões de propriedade da conta que faz a solicitação.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este 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 de propriedade do comerciante são devolvidos.
Incluir deficientes	include_disabled	boolean	Inclui cartões para deficientes. Por predefinição, todos os cartões ativados pertencentes ao comerciante são devolvidos.
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 por quando o cartão foi criado com a ordem especificada.

Devoluções

Name	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 da rua, nome da rua e nome do edifício.
Endereço Linha 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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Concebido como um identificador atribuído ao quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
COMPARTIMENTO	cards.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Marca do 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	O ID de um cliente a ser associado ao cartão.
Ativado(a)	cards.card.enabled	boolean	Indica se um objeto pode ou não ser usado.
Mês de Validade	cards.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Ano de Validade	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	Um ID de referência opcional definido pelo utilizador que associa este cartão a outra entidade num sistema externo.
Versão	cards.card.version	integer	Número da versão atual do cartão. Incrementos com cada atualização do 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 catálogo

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

Name	Chave	Necessário	Tipo	Description
Cursor	cursor		integer	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
Types	types		string	Uma lista opcional de tipos de objetos a serem recuperados sem distinção entre maiúsculas e vírgulas e separada por vírgula. Os valores válidos são definidos no enum 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 Square usada para fazer a solicitação.

Devoluções

Name	Caminho	Tipo	Description
Objects	objects	array of object
Tipo	objects.type	string	O tipo deste objeto.
ID	objects.id	string	O identificador único, emitido pela Square.
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.
É suprimido	objects.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é 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 total de um pagamento.
Tipo de inclusão	objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Percentagem	objects.tax_data.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Ativado(a)	objects.tax_data.enabled	boolean	Indica se um objeto pode ou não ser usado.

Listar clientes

ID da Operação:: CustomerList

Lista os perfis de clientes associados a uma conta Square. Em condições normais de funcionamento, os perfis de clientes 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 cerca de um minuto ou mais, especialmente durante incidentes de rede e interrupções.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Campo de classificação	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 por quando o cartão foi criado com a ordem especificada.

Devoluções

Name	Caminho	Tipo	Description
Clientes	customers	array of object
ID	customers.id	string	O identificador único, emitido pela Square.
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 Próprio	customers.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	customers.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	customers.email_address	string	O endereço de e-mail associado ao perfil do cliente.
Linha de Endereço 1	customers.address.address_line_1	string	A primeira linha do endereço.
Endereço Linha 2	customers.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customers.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
Observação	customers.note	string	Uma nota personalizada associada ao perfil do cliente.
E-mail não inscrito	customers.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a inscrição nos e-mails da campanha de marketing. Um valor verdadeiro significa que o cliente optou por não receber e-mail marketing do vendedor atual da Square ou de todos os vendedores da Square. Esse valor é somente leitura da API Clientes.
Fonte de 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

Devolve uma lista de litígios associados a uma conta específica.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
States	states	string	A disputa afirma 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 da Localização	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Devoluções

Name	Caminho	Tipo	Description
Litígios	disputes	array of object
ID	disputes.id	string	O identificador único, emitido pela Square.
Montante	disputes.amount_money.amount	integer	O montante.
Moeda	disputes.amount_money.currency	string	A moeda.
Reason	disputes.reason	string	O litígio levou o titular do cartão a iniciar o litígio com o seu banco.
Estado	disputes.state	string	O estado atual.
Vencimento em	disputes.due_at	string	A hora em que a próxima ação é devida, no formato RFC 3339.
Pagamentos contestados	disputes.disputed_payments	array of object
ID de pagamento	disputes.disputed_payments.payment_id	string	ID único gerado pelo quadrado do pagamento que está sendo contestado.
Marca do cartão	disputes.card_brand	string	A marca do cartão utilizada no pagamento controvertido.
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	O ID da disputa no sistema de marca do cartão, gerado pela marca do cartão.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar eventos de assinatura

ID da Operação:: SubscriptionListEvents

Lista todos os eventos de uma assinatura específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscription_id	True	string	O identificador da assinatura.

Devoluções

Name	Caminho	Tipo	Description
Eventos de Subscrição	subscription_events	array of object
ID	subscription_events.id	string	O identificador único, emitido pela Square.
Tipo de evento de subscrição	subscription_events.subscription_event_type	string	Tipo de evento de assinatura.
Data Efetiva	subscription_events.effective_date	string	A data, no formato AAAA-MM-DD, em que o evento de subscrição entrou em vigor.
ID do plano	subscription_events.plan_id	string	O ID do plano de subscrição associado

Listar faturas

ID da Operação:: InvoiceList

Retorna uma lista de faturas para um determinado local.

Parâmetros

Name	Chave	Tipo	Description
ID da Localização	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 este ponto de extremidade.
Limite	limit	integer	Limite máximo do número a devolver na resposta.

Devoluções

Name	Caminho	Tipo	Description
Invoices	invoices	array of object
ID	invoices.id	string	O identificador único, emitido pela Square.
Versão	invoices.version	integer	A versão atual do objeto.
ID da Localização	invoices.location_id	string	O identificador do local.
ID da encomenda	invoices.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	O ID gerado pela Praça da solicitação de pagamento em uma fatura.
Tipo de Pedido	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 Para Conclusão	invoices.payment_requests.due_date	string	A data de vencimento (no fuso horário da fatura) do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	invoices.payment_requests.tipping_enabled	boolean	Se definida como true, a página de fatura hospedada na Square (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	Um ID atribuído ao quadrado que identifica exclusivamente o lembrete dentro do 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) do pedido 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.
Montante	invoices.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoices.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoices.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoices.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoices.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Percentagem Solicitada	invoices.payment_requests.percentage_requested	string	Especifica o valor da solicitação de pagamento em porcentagem.
Identificação do cartão	invoices.payment_requests.card_id	string	O ID do cartão de crédito ou débito registado para cobrar o pedido de pagamento.
Número da Fatura	invoices.invoice_number	string	Um número de fatura de fácil utilização.
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 está agendada para processamento, no formato RFC 3339. Após a publicação da fatura, 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 deste objeto.
Timezone	invoices.timezone	string	O fuso horário usado para interpretar as datas do 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	O ID de um cliente a ser associado ao cartão.
Nome Próprio	invoices.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoices.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoices.primary_recipient.email_address	string	O endereço de e-mail 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 os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoices.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoices.custom_fields.placement	string	A localização do campo personalizado na fatura
Método de Entrega	invoices.delivery_method	string	O método de entrega que a 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.
URL pública	invoices.public_url	string	O URL da página de fatura hospedada na Square. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, a Square hospeda a página da fatura e retorna o URL da página na resposta.
Montante	invoices.next_payment_amount_money.amount	integer	O montante.
Moeda	invoices.next_payment_amount_money.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar grupos de clientes

ID da Operação:: CustomerGroupList

Recupera a lista de grupos de clientes de uma empresa.

Devoluções

Name	Caminho	Tipo	Description
Groups	groups	array of object
ID	groups.id	string	O identificador único, emitido pela Square.
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 faz 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

Name	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 por quando o cartão foi criado com a ordem especificada.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
ID da Localização	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 do cartão	card_brand	string	A marca do cartão de pagamento (por exemplo, VISA).
Limite	limit	integer	Limite máximo do número a devolver na resposta.

Devoluções

Name	Caminho	Tipo	Description
Payments	payments	array of object
ID	payments.id	string	O identificador único, emitido pela Square.
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
Montante	payments.amount_money.amount	integer	O montante.
Moeda	payments.amount_money.currency	string	A moeda.
Situação	payments.status	string	O status de verificação atual deste 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 para este pagamento.
Situação	payments.card_details.status	string	O estado atual do pagamento com cartão. O estado pode ser AUTORIZADO, CAPTURADO, ANULADO ou FALHADO.
Marca do 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.
Exp Mês	payments.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payments.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN)
Método de entrada	payments.card_details.entry_method	string	O método utilizado para introduzir os dados 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 do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado Avs	payments.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payments.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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 da Localização	payments.location_id	string	O identificador do local.
ID da encomenda	payments.order_id	string	O ID do pedido.
Taxa de processamento	payments.processing_fee	array of object
Eficaz na	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 deste objeto.
Montante	payments.processing_fee.amount_money.amount	integer	O montante.
Moeda	payments.processing_fee.amount_money.currency	string	A moeda.
Observação	payments.note	string	Uma nota personalizada associada ao perfil do cliente.
Montante	payments.total_money.amount	integer	O montante.
Moeda	payments.total_money.currency	string	A moeda.
Montante	payments.approved_money.amount	integer	O montante.
Moeda	payments.approved_money.currency	string	A moeda.
Número do recibo	payments.receipt_number	string	O número do recibo de pagamento. O campo está ausente se um pagamento for cancelado.
URL do recibo	payments.receipt_url	string	O URL do recibo de pagamento. O campo só é preenchido para pagamentos CONCLUÍDOS.
Ação de atraso	payments.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Equipa	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 Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payments.application_details.application_id	string	O Square ID atribuído à aplicação utilizada para receber o pagamento. Os desenvolvedores de aplicativos podem usar essas informações para identificar pagamentos que seus aplicativos processaram. 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 utilizar uma aplicação Square App Marketplace para processar pagamentos, o campo contém o ID da aplicação correspondente.
Token de 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 disputa

ID da Operação:: DisputeListEvidence

Devolve uma lista de provas associadas a um litígio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.

Devoluções

Name	Caminho	Tipo	Description
Evidence	evidence	array of object
ID	evidence.id	string	O identificador único, emitido pela Square.
ID do litígio	evidence.dispute_id	string	O ID do litígio ao qual a prova está associada.
Texto de evidência	evidence.evidence_text	string	O texto bruto.
Tipo de evidência	evidence.evidence_type	string	O tipo de prova.
Carregado em	evidence.uploaded_at	string	A hora em que a próxima ação é devida, no formato RFC 3339.
ID da prova	evidence.evidence_id	string	O ID gerado pelo quadrado da prova.
Nome do ficheiro	evidence.evidence_file.filename	string	O nome do arquivo, incluindo a extensão do arquivo
Tipo de ficheiro	evidence.evidence_file.filetype	string	Os arquivos de provas de disputa devem ser nos 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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar reembolsos de pagamento

ID da Operação:: RefundList

Recupera uma lista de reembolsos para a conta que faz 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

Name	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 por quando o cartão foi criado com a ordem especificada.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
ID da Localização	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, apenas reembolsos com o tipo de fonte fornecido são devolvidos.
Limite	limit	integer	Limite máximo do número a devolver na resposta.

Devoluções

Name	Caminho	Tipo	Description
Reembolsos	refunds	array of object
ID	refunds.id	string	O identificador único, emitido pela Square.
Situação	refunds.status	string	O status de verificação atual deste objeto.
Montante	refunds.amount_money.amount	integer	O montante.
Moeda	refunds.amount_money.currency	string	A moeda.
ID de pagamento	refunds.payment_id	string	O ID do pagamento.
ID da encomenda	refunds.order_id	string	O ID do pedido.
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
Eficaz na	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 deste objeto.
Montante	refunds.processing_fee.amount_money.amount	integer	O montante.
Moeda	refunds.processing_fee.amount_money.currency	string	A moeda.
ID da Localização	refunds.location_id	string	O identificador do local.
Reason	refunds.reason	string	O litígio levou o titular do cartão a iniciar o litígio com o seu banco.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar segmentos de clientes

ID da Operação:: CustomerSegmentList

Recupera a lista de segmentos de clientes de uma empresa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
Limite	limit		integer	Limite máximo do número a devolver na resposta.

Devoluções

Name	Caminho	Tipo	Description
Segmentos	segments	array of object
ID	segments.id	string	O identificador único, emitido pela Square.
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

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID	id	string	O identificador único, emitido pela Square.
Tipo	type	string	O tipo deste objeto.
Abreviatura	abbreviation	string	O texto da etiqueta de exibição do item no aplicativo Ponto Quadrado de Venda. Apenas até os cinco primeiros caracteres da cadeia de caracteres são usados. Esse atributo é pesquisável e seu comprimento de valor é de pontos de código Unicode.
Description	title	string	A descrição do item. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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 deste 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.

Devoluções

Name	Caminho	Tipo	Description
Tipo	catalog_object.type	string	O tipo deste objeto.
ID	catalog_object.id	string	O identificador único, emitido pela Square.
Atualizado em	catalog_object.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente deste objeto, no formato RFC 3339.
Versão	catalog_object.version	integer	A versão atual deste objeto.
É suprimido	catalog_object.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Abreviatura	catalog_object.item_data.abbreviation	string	O texto da etiqueta de exibição do item no aplicativo Ponto Quadrado de Venda. Apenas até os cinco primeiros caracteres da cadeia de caracteres são usados. Esse atributo é pesquisável e seu comprimento 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 deste 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.
É suprimido	catalog_object.item_data.variations.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Ordinal	catalog_object.item_data.variations.item_variation_data.ordinal	integer	A ordem em que essa variação de item deve ser exibida. Esse valor é somente leitura. Em gravações, o ordinal para cada variação de item dentro de um CatalogItem pai é definido de acordo com a posição das variações do item. Em leituras, não é garantido que o valor seja 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.
Armazenável	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Se o estoque é contado diretamente nesta variação (TRUE) ou apenas em seus componentes (FALSE). Para compatibilidade com versões anteriores, os valores ausentes serão interpretados como TRUE.
Montante	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	O montante.
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. Não pode ser alterado depois de um item ter sido criado.
Mapeamentos de ID	id_mappings	array of object
ID do objeto do cliente	id_mappings.client_object_id	string	A ID temporária #-prefixada fornecida pelo cliente para um novo CatalogObject.
ID do objeto	id_mappings.object_id	string	O ID permanente criado pelo servidor.

Objetos de catálogo de recuperação em 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 filhas, incluindo: todos os seus objetos CatalogItemVariation , referências a seus objetos CatalogModifierList e as ids de quaisquer objetos CatalogTax que se aplicam a ele.

Parâmetros

Name	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 da versão especificada é comparado com o atributo version de CatalogObjects.
Incluir objetos relacionados	include_related_objects	boolean	Se true, a resposta incluirá objetos adicionais relacionados aos objetos solicitados, da seguinte maneira: Se o campo de objetos da resposta contiver um CatalogItem, seus objetos CatalogCategory, objetos CatalogTax, objetos CatalogImage e CatalogModifierLists associados serão retornados no campo related_objects da resposta. Se o campo de objetos da resposta contiver um CatalogItemVariation, seu pai CatalogItem será retornado no campo related_objects da resposta.

Devoluções

Name	Caminho	Tipo	Description
Objects	objects	array of object
Tipo	objects.type	string	O tipo deste objeto.
ID	objects.id	string	O identificador único, emitido pela Square.
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.
É suprimido	objects.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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.
Identificação fiscal	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 deste 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 este 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.
É suprimido	objects.item_data.variations.is_deleted	boolean	Se verdadeiro, 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.item_data.variations.present_at_all_locations	boolean	Uma lista de locais onde o objeto está presente, mesmo que present_at_all_locations seja falsa. 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem em que 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.
Montante	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 é em centavos. Os montantes monetários podem ser positivos ou negativos. Veja a descrição do campo específico 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 deste objeto.
ID	related_objects.id	string	O identificador único, emitido pela Square.
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.
É suprimido	related_objects.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é 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 total de um pagamento.
Tipo de inclusão	related_objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Percentagem	related_objects.tax_data.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Ativado(a)	related_objects.tax_data.enabled	boolean	Indica se um objeto pode ou não ser usado.

Objetos de catálogo de upsert em 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 estiver 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 ser bem-sucedidos. Cada lote pode conter até 1.000 objetos, e os lotes serão processados em ordem, desde que a contagem total de objetos para a solicitação (itens, variações, listas modificadoras, descontos e impostos) não seja superior a 10.000.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Tipo	type	string	O tipo deste objeto.
ID	id	string	Um identificador para fazer referência a este objeto.
Presente em todos os locais	present_at_all_locations	boolean	Se verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
ID da categoria	category_id	string	A ID da categoria do item, se houver.
Identificação fiscal	tax_ids	array of string
Tipo	type	string	O tipo deste 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 este objeto.
Presente em todos os locais	present_at_all_locations	boolean	Se 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.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.
Nome	name	string	O nome do item. Este é 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. Este é 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 total de um pagamento.
Tipo de inclusão	inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Percentagem	percentage	string	A percentagem do imposto na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Aplica-se a quantidades personalizadas	applies_to_custom_amounts	boolean	Se verdadeiro, 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.
Ativado(a)	enabled	boolean	Um sinalizador booleano para indicar se o imposto é exibido como ativado (true) no aplicativo Square Point of Sale ou não (false).

Devoluções

Name	Caminho	Tipo	Description
Objects	objects	array of object
Tipo	objects.type	string	O tipo deste objeto.
ID	objects.id	string	O identificador único, emitido pela Square.
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.
É suprimido	objects.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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.
Identificação fiscal	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 deste 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 este 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.
É suprimido	objects.item_data.variations.is_deleted	boolean	Se verdadeiro, 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.item_data.variations.present_at_all_locations	boolean	Uma lista de locais onde o objeto está presente, mesmo que present_at_all_locations seja falsa. 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem em que 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.
Montante	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 é em centavos. Os montantes monetários podem ser positivos ou negativos. Veja a descrição do campo específico 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. Este é 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. Este é 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 total de um pagamento.
Tipo de inclusão	objects.tax_data.inclusion_type	string	Se o imposto é ADITIVO ou INCLUSIVO.
Percentagem	objects.tax_data.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Aplica-se a quantidades personalizadas	objects.tax_data.applies_to_custom_amounts	boolean	Se verdadeiro, 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.
Ativado(a)	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 do cliente	id_mappings.client_object_id	string	A ID temporária #-prefixada fornecida pelo cliente para um novo CatalogObject.
ID do objeto	id_mappings.object_id	string	O ID permanente criado pelo servidor.

Obter checkout do terminal

ID da Operação:: TerminalGetCheckout

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Checkout ID	checkout_id	True	string	O identificador do checkout.

Devoluções

Name	Caminho	Tipo	Description
ID	checkout.id	string	O identificador único, emitido pela Square.
Montante	checkout.amount_money.amount	integer	O montante.
Moeda	checkout.amount_money.currency	string	A moeda.
ID de Referência	checkout.reference_id	string	Um ID de referência opcional definido pelo usuário.
Observação	checkout.note	string	Uma nota personalizada associada ao perfil do cliente.
ID do dispositivo	checkout.device_options.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalCheckout.
Permitir gorjetas	checkout.device_options.tip_settings.allow_tipping	boolean	Indica se a gorjeta está habilitada para este check-out. É definido para false por padrão.
Ignorar tela de recibo	checkout.device_options.skip_receipt_screen	boolean	Instrui o dispositivo a ignorar a tela de recibo. É definido para false por padrão.
Situação	checkout.status	string	O status de verificação atual deste objeto.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	checkout.app_id	string	A ID do aplicativo que criou o checkout.
Duração do Prazo	checkout.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação

Obter fatura

ID da Operação:: InvoiceGet

Recupera uma fatura por ID de fatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.

Devoluções

Name	Caminho	Tipo	Description
ID	invoice.id	string	O identificador único, emitido pela Square.
Versão	invoice.version	integer	A versão atual deste objeto.
ID da Localização	invoice.location_id	string	O identificador do local.
ID da encomenda	invoice.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	O ID gerado pela Square.
Tipo de Pedido	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 Para Conclusão	invoice.payment_requests.due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	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	Um ID atribuído ao 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) do pedido 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.
Montante	invoice.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoice.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoice.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Número da Fatura	invoice.invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui 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 deste objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar 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 deste 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 deste objeto, no formato RFC 3339.
ID do Cliente	invoice.primary_recipient.customer_id	string	O ID do cliente associado ao pedido.
Nome Próprio	invoice.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoice.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoice.primary_recipient.email_address	string	O endereço de e-mail 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 os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	A localização do campo personalizado na fatura.
Método de Entrega	invoice.delivery_method	string	O método de entrega que a 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 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

Obter reembolso do pagamento

ID da Operação:: RefundGet

Recupera um reembolso específico usando o refund_id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do reembolso	refund_id	True	string	O identificador do reembolso.

Devoluções

Name	Caminho	Tipo	Description
ID	refund.id	string	O identificador único, emitido pela Square.
Situação	refund.status	string	O status de verificação atual deste objeto.
Montante	refund.amount_money.amount	integer	O montante.
Moeda	refund.amount_money.currency	string	A moeda.
ID de pagamento	refund.payment_id	string	O ID exclusivo do pagamento.
ID da encomenda	refund.order_id	string	O ID do pedido.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Taxa de processamento	refund.processing_fee	array of object
Eficaz na	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.
Montante	refund.processing_fee.amount_money.amount	integer	O montante.
Moeda	refund.processing_fee.amount_money.currency	string	A moeda.
ID da Localização	refund.location_id	string	O identificador do local.
Reason	refund.reason	string	A razão para este objeto.

Obter reembolso do terminal

ID da Operação:: TerminalGetRefund

Recupera um objeto de reembolso do Terminal Interac por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de reembolso do terminal	terminal_refund_id	True	string	O identificador do reembolso do terminal.

Devoluções

Name	Caminho	Tipo	Description
ID	refund.id	string	O identificador único, emitido pela Square.
ID do reembolso	refund.refund_id	string	O ID exclusivo para este reembolso, gerado pela Square.
ID de pagamento	refund.payment_id	string	O ID exclusivo do pagamento.
Montante	refund.amount_money.amount	integer	O montante.
Moeda	refund.amount_money.currency	string	A moeda.
Reason	refund.reason	string	A razão para este objeto.
ID do dispositivo	refund.device_id	string	O ID exclusivo do dispositivo destinado a este TerminalRefund.
Duração do Prazo	refund.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Situação	refund.status	string	O status de verificação atual deste objeto.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
ID de Aplicação	refund.app_id	string	A ID do aplicativo que criou o checkout.
Marca do 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.
Exp Mês	refund.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	refund.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
ID da encomenda	refund.order_id	string	O ID do pedido.
ID da Localização	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. Pedidos com um estado CONCLUÍDO ou CANCELADO não podem ser atualizados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id	True	string	O identificador da ordem.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Versão	version		integer	A versão atual deste objeto.
UID	uid		string	O ID gerado pela Square.
Quantidade	quantity		string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Nome	name		string	O nome do item. Este é 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.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Campos a limpar	fields_to_clear		array of string

Devoluções

Name	Caminho	Tipo	Description
Versão	order.version	integer	A versão atual deste objeto.
Moeda	order.total_money.currency	string	A moeda.
Montante	order.total_money.amount	integer	O montante.
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.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Montante	order.line_items.total_money.amount	integer	O montante.
Moeda	order.line_items.total_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.base_price_money.amount	integer	O montante.
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 decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Nome	order.line_items.name	string	O nome do item. Este é 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	O ID gerado pela Square.
Montante	order.line_items.variation_total_price_money.amount	integer	O montante.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
Estado	order.state	string	O estado atual.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
ID	order.id	string	O identificador único, emitido pela Square.
ID da Localização	order.location_id	string	O identificador do local.
Montante	order.total_tax_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Atualizado em	order.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente deste 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. A ordem recém-criada tem apenas os campos principais (como itens de linha, impostos e descontos) copiados da ordem original.

Parâmetros

Name	Chave	Tipo	Description
ID da encomenda	order_id	string	O identificador de ordem.
Versão	version	integer	A versão.
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	order.id	string	O identificador único, emitido pela Square.
ID da Localização	order.location_id	string	O identificador do local.
Itens de linha	order.line_items	array of object
UID	order.line_items.uid	string	O ID gerado pela Square.
Nome	order.line_items.name	string	O nome do item. Este é 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 decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Impostos Aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Um ID atribuído ao quadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	O UID do imposto para o qual este imposto aplicado representa.
Montante	order.line_items.applied_taxes.applied_money.amount	integer	O montante.
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	Um ID atribuído ao quadrado.
Desconto UID	order.line_items.applied_discounts.discount_uid	string	O uid do desconto que o desconto aplicado representa.
Montante	order.line_items.applied_discounts.applied_money.amount	integer	O montante.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Montante	order.line_items.base_price_money.amount	integer	O montante.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_money.amount	integer	O montante.
Moeda	order.line_items.total_money.currency	string	A moeda.
Montante	order.line_items.variation_total_price_money.amount	integer	O montante.
Moeda	order.line_items.variation_total_price_money.currency	string	A moeda.
ID do objeto do catálogo	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	Um ID atribuído ao quadrado.
ID do objeto do catálogo	order.line_items.modifiers.catalog_object_id	string	O ID do objeto de catálogo.
Nome	order.line_items.modifiers.name	string	O nome do item. Este é 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.
Montante	order.line_items.modifiers.base_price_money.amount	integer	O montante.
Moeda	order.line_items.modifiers.base_price_money.currency	string	A moeda.
Montante	order.line_items.modifiers.total_price_money.amount	integer	O montante.
Moeda	order.line_items.modifiers.total_price_money.currency	string	A moeda.
Impostos	order.taxes	array of object
UID	order.taxes.uid	string	O ID gerado pela Square.
Nome	order.taxes.name	string	O nome do item. Este é 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.
Percentagem	order.taxes.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.taxes.applied_money.amount	integer	O montante.
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	O ID gerado pela Square.
ID do objeto do catálogo	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. Este é 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.
Percentagem	order.discounts.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.discounts.applied_money.amount	integer	O montante.
Moeda	order.discounts.applied_money.currency	string	A moeda.
Scope	order.discounts.scope	string	Indica o nível atual.
Montante	order.discounts.amount_money.amount	integer	O montante.
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 deste 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 deste 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	Um ID de referência opcional definido pelo usuário.
Montante	order.total_money.amount	integer	O montante.
Moeda	order.total_money.currency	string	A moeda.
Montante	order.total_tax_money.amount	integer	O montante.
Moeda	order.total_tax_money.currency	string	A moeda.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Montante	order.total_tip_money.amount	integer	O montante.
Moeda	order.total_tip_money.currency	string	A moeda.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.tip_money.amount	integer	O montante.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
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 por uma encomenda utilizando um ou mais pagamentos aprovados ou liquide uma encomenda com um total de 0. O total dos payment_ids listados na solicitação deve ser igual ao total do pedido. Pedidos com um valor total de 0 podem ser marcados como pagos especificando uma matriz vazia de payment_ids na solicitação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id	True	string	O identificador da ordem.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
IDs de pagamento	payment_ids		array of string

Devoluções

Name	Caminho	Tipo	Description
ID	order.id	string	O identificador único, emitido pela Square.
ID da Localização	order.location_id	string	O identificador do local.
Itens de linha	order.line_items	array of object
UID	order.line_items.uid	string	O ID gerado pela Square.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Nome	order.line_items.name	string	O nome do item. Este é 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.
Montante	order.line_items.base_price_money.amount	integer	O montante.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_money.amount	integer	O montante.
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 deste 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 deste objeto, no formato RFC 3339.
Versão	order.version	integer	A versão atual deste objeto.
Montante	order.total_tax_money.amount	integer	O montante.
Moeda	order.total_tax_money.currency	string	A moeda.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Montante	order.total_money.amount	integer	O montante.
Moeda	order.total_money.currency	string	A moeda.
Fechado em	order.closed_at	string	O tempo quando fechado, no formato ISO 8601.
Concursos	order.tenders	array of object
ID	order.tenders.id	string	O identificador do objeto
ID da Localização	order.tenders.location_id	string	O ID de localização de um destinatário (que não o comerciante) que recebe uma parte desta proposta.
ID da transação	order.tenders.transaction_id	string	O ID da operação associada à proposta.
Criado em	order.tenders.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
Montante	order.tenders.amount_money.amount	integer	O montante.
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 com cartão de crédito (como AUTORIZADO ou CAPTURADO)
Marca do 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.
Exp Mês	order.tenders.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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 de entrada	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 único do pagamento gerado pela Square.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.tip_money.amount	integer	O montante.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
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 completo

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

Name	Chave	Necessário	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Devoluções

Name	Caminho	Tipo	Description
ID	payment.id	string	O identificador único, emitido pela Square.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	payment.amount_money.amount	integer	O montante.
Moeda	payment.amount_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual deste 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. Esta delay_action automática aplica-se apenas a pagamentos que não atinjam um estado terminal (CONCLUÍDO, CANCELADO ou REPROVADO) antes do período de tempo delay_duration. Este campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de fonte	payment.source_type	string	O tipo de origem para este pagamento. Os valores atuais incluem CARTÃO, BANK_ACCOUNT, CARTEIRA, DINHEIRO ou EXTERNO.
Situação	payment.card_details.status	string	O status atual.
Marca do 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.
Exp Mês	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Método de entrada	payment.card_details.entry_method	string	O método utilizado para introduzir os dados do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Situação do CVV	payment.card_details.cvv_status	string	O código de status retornado da verificação do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado do AVS	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payment.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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 da Localização	payment.location_id	string	O identificador do local.
ID da encomenda	payment.order_id	string	O ID do pedido.
Taxa de processamento	payment.processing_fee	array of object
Eficaz na	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.
Montante	payment.processing_fee.amount_money.amount	integer	O montante.
Moeda	payment.processing_fee.amount_money.currency	string	A moeda.
Observação	payment.note	string	Uma nota personalizada associada ao perfil do cliente.
Montante	payment.total_money.amount	integer	O montante.
Moeda	payment.total_money.currency	string	A moeda.
Montante	payment.approved_money.amount	integer	O montante.
Moeda	payment.approved_money.currency	string	A moeda.
ID do funcionário	payment.employee_id	string	O ID gerado pelo quadrado do funcionário.
Número do recibo	payment.receipt_number	string	O número do recibo de pagamento. O campo está ausente se um pagamento for cancelado.
URL do recibo	payment.receipt_url	string	O URL do recibo de pagamento. O campo só é preenchido para pagamentos CONCLUÍDOS.
Ação de atraso	payment.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Equipa	payment.team_member_id	string	O ID do membro da equipe.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payment.application_details.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Token de versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Pagamento do reembolso

ID da Operação:: RefundPayment

Reembolsa um pagamento. Você pode reembolsar o valor total do 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

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

Devoluções

Name	Caminho	Tipo	Description
ID	refund.id	string	O identificador único, emitido pela Square.
Situação	refund.status	string	O status de verificação atual deste objeto.
Montante	refund.amount_money.amount	integer	O montante.
Moeda	refund.amount_money.currency	string	A moeda.
ID de pagamento	refund.payment_id	string	O ID exclusivo do pagamento.
ID da encomenda	refund.order_id	string	O ID do pedido.
Criado em	refund.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	refund.app_fee_money.amount	integer	O montante.
Moeda	refund.app_fee_money.currency	string	A moeda.
ID da Localização	refund.location_id	string	O identificador do local.
Reason	refund.reason	string	A razão para este objeto.

Pedidos de recuperação de lote

ID da Operação:: OrderBatchRetrieve

Recupera um conjunto de ordens por seus IDs. Se um determinado ID de ordem não existir, o ID será ignorado em vez de gerar um erro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Localização	location_id		string	O identificador de localização.
IDs de encomenda	order_ids		array of string

Devoluções

Name	Caminho	Tipo	Description
Encomendas	orders	array of object
ID	orders.id	string	O identificador único, emitido pela Square.
ID da Localização	orders.location_id	string	O identificador do local.
ID de Referência	orders.reference_id	string	Um segundo ID opcional usado 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	O ID gerado pela Praça 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 comprada, formatada como um número decimal.
Montante	orders.line_items.base_price_money.amount	integer	O montante.
Moeda	orders.line_items.base_price_money.currency	string	A moeda.
Montante	orders.line_items.total_money.amount	integer	O montante.
Moeda	orders.line_items.total_money.currency	string	A moeda.
Montante	orders.total_money.amount	integer	O montante.
Moeda	orders.total_money.currency	string	A moeda.

Pesquisar clientes

ID da Operação:: CustomerSearch

Pesquisa os perfis de clientes associados a uma conta Square usando um filtro de consulta suportado. Chamar SearchCustomers sem qualquer filtro de consulta explícito retorna todos os perfis de clientes ordenados alfabeticamente com base em given_name e family_name.

Parâmetros

Name	Chave	Tipo	Description
Fuzzy	fuzzy	string	Use o filtro difuso para selecionar clientes cujos atributos correspondam à 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 correspondente aos critérios de filtro deve ser incluído no resultado ou excluído do resultado.
Comece em	start_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo começa.
Terminar em	end_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
Todos	all	array of string
Campo	field	string	Use um ou mais atributos de cliente como a chave de classificação para classificar os perfis de clientes pesquisados.
Encomenda	order	string	Indica a ordem na qual os resultados devem ser classificados com base no valor do campo de classificação. As cadeias de caracteres usam comparação alfabética padrão para determinar a ordem.
Limite	limit	integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Clientes	customers	array of object
ID	customers.id	string	O identificador único, emitido pela Square.
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 Próprio	customers.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	customers.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	customers.email_address	string	O endereço de e-mail associado ao perfil do cliente.
Linha de Endereço 1	customers.address.address_line_1	string	A primeira linha do endereço.
Endereço Linha 2	customers.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customers.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
E-mail não inscrito	customers.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a inscrição nos e-mails da campanha de marketing. Um valor verdadeiro significa que o cliente optou por não receber e-mail marketing do vendedor atual da Square ou de todos os vendedores da Square. Esse valor é somente leitura da API Clientes.
Fonte de 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 nota personalizada associada ao perfil do cliente.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Pesquisar faturas

ID da Operação:: InvoiceSearch

Procura faturas a partir de um local especificado no filtro.

Parâmetros

Name	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 de cliente como a chave de classificação para classificar os perfis de clientes pesquisados.
Encomenda	order	string	Indica a ordem na qual os resultados devem ser classificados com base no valor do campo de classificação. As cadeias de caracteres usam comparação alfabética padrão para determinar a ordem.
Limite	limit	integer	O número máximo de faturas a devolver (200 é o limite máximo). Se não for fornecido, o servidor usa um limite padrão de 100 faturas.

Devoluções

Name	Caminho	Tipo	Description
Invoices	invoices	array of object
ID	invoices.id	string	O identificador único, emitido pela Square.
Versão	invoices.version	integer	A versão atual do objeto.
ID da Localização	invoices.location_id	string	O identificador do local.
ID da encomenda	invoices.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	O ID gerado pela Praça da solicitação de pagamento em uma fatura.
Tipo de Pedido	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 Para Conclusão	invoices.payment_requests.due_date	string	A data de vencimento (no fuso horário da fatura) do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	invoices.payment_requests.tipping_enabled	boolean	Se definida como true, a página de fatura hospedada na Square (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	Um ID atribuído ao quadrado que identifica exclusivamente o lembrete dentro do 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) do pedido 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.
Montante	invoices.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoices.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoices.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoices.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoices.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Percentagem Solicitada	invoices.payment_requests.percentage_requested	string	Especifica o valor da solicitação de pagamento em porcentagem.
Identificação do cartão	invoices.payment_requests.card_id	string	O ID do cartão de crédito ou débito registado para cobrar o pedido de pagamento.
Número da Fatura	invoices.invoice_number	string	Um número de fatura de fácil utilização.
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 está agendada para processamento, no formato RFC 3339. Após a publicação da fatura, 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 deste objeto.
Timezone	invoices.timezone	string	O fuso horário usado para interpretar as datas do 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	O ID de um cliente a ser associado ao cartão.
Nome Próprio	invoices.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoices.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoices.primary_recipient.email_address	string	O endereço de e-mail 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 os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoices.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoices.custom_fields.placement	string	A localização do campo personalizado na fatura
Método de Entrega	invoices.delivery_method	string	O método de entrega que a 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.
URL pública	invoices.public_url	string	O URL da página de fatura hospedada na Square. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, a Square hospeda a página da fatura e retorna o URL da página na resposta.
Montante	invoices.next_payment_amount_money.amount	integer	O montante.
Moeda	invoices.next_payment_amount_money.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Pesquisar objetos do catálogo

ID da Operação:: CatalogSearch

Procura CatalogObject de qualquer tipo fazendo a correspondência de valores de atributos de pesquisa suportados, excluindo valores de atributos personalizados em itens ou variações de itens, em relação a um ou mais dos filtros de consulta especificados.

Parâmetros

Name	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 do atributo	attribute_prefix	string	O prefixo desejado do valor do atributo de pesquisa.
Limite	limit	integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Objects	objects	array of object
Tipo	objects.type	string	O tipo deste objeto.
ID	objects.id	string	O identificador único, emitido pela Square.
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.
É suprimido	objects.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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.
Identificação fiscal	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 deste 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 este 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.
É suprimido	objects.item_data.variations.is_deleted	boolean	Se verdadeiro, 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.item_data.variations.present_at_all_locations	boolean	Uma lista de locais onde o objeto está presente, mesmo que present_at_all_locations seja falsa. 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	A ordem em que essa variação de item deve ser exibida. Esse valor é somente leitura.
Montante	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 é em centavos. Os montantes monetários podem ser positivos ou negativos. Veja a descrição do campo específico 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 subscrições

ID da Operação:: SubscriptionSearch

Procura subscrições. Os resultados são ordenados cronologicamente por data de criação da subscrição. 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 dentro de cada local. Se nenhum local for fornecido na consulta, todos os locais serão pesquisados.

Parâmetros

Name	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

Devoluções

Name	Caminho	Tipo	Description
Subscrições	subscriptions	array of object
ID	subscriptions.id	string	O identificador único, emitido pela Square.
ID da Localização	subscriptions.location_id	string	O identificador do local.
ID do plano	subscriptions.plan_id	string	O ID do plano de subscrição associado
ID do Cliente	subscriptions.customer_id	string	O ID atribuído ao quadrado do cliente associado à conta.
Data de início	subscriptions.start_date	string	A data de início da subscrição, no formatoMM-DD AAAA.
Data cancelada	subscriptions.canceled_date	string	A data de cancelamento da subscrição, no formato AAAA-MM-DD.
Cobrado até a data	subscriptions.charged_through_date	string	A data até à qual o cliente é faturado pela subscrição, no formato AAAA-MM-DD.
Situação	subscriptions.status	string	O status de verificação atual deste objeto.
Criado em	subscriptions.created_at	string	A hora do evento no formato ISO 8601.
Identificação do cartão	subscriptions.card_id	string	A ID do cartão de cliente que é cobrado pela assinatura.
Pago até à data	subscriptions.paid_until_date	string	A data paga até.
Timezone	subscriptions.timezone	string	O fuso horário usado para interpretar as datas do 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. Este é 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.
Percentagem de Imposto	subscriptions.tax_percentage	string	O valor do imposto aplicado ao faturar a subscrição.
Montante	subscriptions.price_override_money.amount	integer	O montante.
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

Procurar encomendas

ID da Operação:: OrderSearch

Pesquise todos os pedidos para um ou mais locais. Os pedidos incluem todas as vendas, devoluções e trocas, independentemente de como ou quando entraram no ecossistema da Square (como Ponto de Venda, Faturas e APIs Connect).

Parâmetros

Name	Chave	Tipo	Description
Entradas de Retorno	return_entries	boolean	Um booleano que controla o formato dos resultados da pesquisa. Se true, SearchOrders retorna objetos OrderEntry. Se false, SearchOrders retorna objetos de ordem completos.
Limite	limit	integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.
IDs de localização	location_ids	array of string
Comece em	start_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo começa.
Terminar em	end_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
States	states	array of string
Campo de classificação	sort_field	string	O campo para classificar.
Ordem de classificação	sort_order	string	A ordem cronológica em que os resultados são retornados.

Devoluções

Name	Caminho	Tipo	Description
Entradas de Encomenda	order_entries	array of object
ID da encomenda	order_entries.order_id	string	O ID do pedido.
ID da Localização	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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Publicar fatura

ID da Operação:: InvoicePublish

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da fatura	invoice_id	True	string	O identificador da fatura.
Versão	version		integer	A versão.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	invoice.id	string	O identificador único, emitido pela Square.
Versão	invoice.version	integer	A versão atual deste objeto.
ID da Localização	invoice.location_id	string	O identificador do local.
ID da encomenda	invoice.order_id	string	O ID do pedido.
Pedidos de Pagamento	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	O ID gerado pela Square.
Tipo de Pedido	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 Para Conclusão	invoice.payment_requests.due_date	string	A data de vencimento do pedido de pagamento, no formato AAAA-MM-DD.
Gorjetas ativadas	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	Um ID atribuído ao 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) do pedido 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.
Montante	invoice.payment_requests.computed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.computed_amount_money.currency	string	A moeda.
Montante	invoice.payment_requests.total_completed_amount_money.amount	integer	O montante.
Moeda	invoice.payment_requests.total_completed_amount_money.currency	string	A moeda.
Fonte de Pagamento Automático	invoice.payment_requests.automatic_payment_source	string	O método de pagamento para um pagamento automático.
Número da Fatura	invoice.invoice_number	string	Um número de fatura de fácil utilização. O valor é único dentro de um local. Se não for fornecido ao criar uma fatura, a Square atribui 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 deste objeto.
Timezone	invoice.timezone	string	O fuso horário usado para interpretar 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 deste 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 deste objeto, no formato RFC 3339.
ID do Cliente	invoice.primary_recipient.customer_id	string	O ID do cliente associado ao pedido.
Nome Próprio	invoice.primary_recipient.given_name	string	O nome dado (ou seja, o primeiro) do destinatário.
Nome de família	invoice.primary_recipient.family_name	string	O nome da família (ou seja, o último) do destinatário.
Endereço de E-mail	invoice.primary_recipient.email_address	string	O endereço de e-mail 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	O URL da página de fatura hospedada na Square. Depois de publicar a fatura usando o ponto de extremidade PublishInvoice, a Square hospeda a página da fatura e retorna o URL da página na resposta.
Card	invoice.accepted_payment_methods.card	boolean	Indica se os pagamentos com cartão de crédito ou 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 por transferência bancária são aceites.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	O rótulo ou título do campo personalizado.
Valor	invoice.custom_fields.value	string	O texto do campo personalizado.
Colocação	invoice.custom_fields.placement	string	A localização do campo personalizado na fatura.
Método de Entrega	invoice.delivery_method	string	O método de entrega que a 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 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 é prestado, no formato AAAA-MM-DD. Este campo pode ser usado para especificar uma data passada ou futura que é exibida na fatura.

Receba o pagamento

ID da Operação:: PaymentGet

Recupera detalhes de um pagamento específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de pagamento	payment_id	True	string	O identificador do pagamento.

Devoluções

Name	Caminho	Tipo	Description
ID	payment.id	string	O identificador único, emitido pela Square.
Criado em	payment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Montante	payment.amount_money.amount	integer	O montante.
Moeda	payment.amount_money.currency	string	A moeda.
Situação	payment.status	string	O status de verificação atual deste 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. Esta delay_action automática aplica-se apenas a pagamentos que não atinjam um estado terminal (CONCLUÍDO, CANCELADO ou REPROVADO) antes do período de tempo delay_duration. Este campo é especificado como uma duração de tempo, no formato RFC 3339.
Tipo de fonte	payment.source_type	string	O tipo de origem para este pagamento. Os valores atuais incluem CARTÃO, BANK_ACCOUNT, CARTEIRA, DINHEIRO ou EXTERNO.
Situação	payment.card_details.status	string	O status atual.
Marca do 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.
Exp Mês	payment.card_details.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	payment.card_details.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Método de entrada	payment.card_details.entry_method	string	O método utilizado para introduzir os dados do cartão para o pagamento. O método pode ser KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
Situação do CVV	payment.card_details.cvv_status	string	O código de status retornado da verificação do Valor de Verificação do Cartão (CVV). O código pode ser CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
Estado do AVS	payment.card_details.avs_status	string	O código de status retornado da verificação do Sistema de Verificação de Endereço (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 declaração	payment.card_details.statement_description	string	A descrição do extrato enviado para as redes de cartões.
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 da Localização	payment.location_id	string	O identificador do local.
ID da encomenda	payment.order_id	string	O ID do pedido.
Taxa de processamento	payment.processing_fee	array of object
Eficaz na	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.
Montante	payment.processing_fee.amount_money.amount	integer	O montante.
Moeda	payment.processing_fee.amount_money.currency	string	A moeda.
Observação	payment.note	string	Uma nota personalizada associada ao perfil do cliente.
Montante	payment.total_money.amount	integer	O montante.
Moeda	payment.total_money.currency	string	A moeda.
Montante	payment.approved_money.amount	integer	O montante.
Moeda	payment.approved_money.currency	string	A moeda.
ID do funcionário	payment.employee_id	string	O ID gerado pelo quadrado do funcionário.
Número do recibo	payment.receipt_number	string	O número do recibo de pagamento. O campo está ausente se um pagamento for cancelado.
URL do recibo	payment.receipt_url	string	O URL do recibo de pagamento. O campo só é preenchido para pagamentos CONCLUÍDOS.
Ação de atraso	payment.delay_action	string	A ação a aplicar ao pagamento quando o delay_duration tiver decorrido.
Adiado 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 Equipa	payment.team_member_id	string	O ID do membro da equipe.
Produto Quadrado	payment.application_details.square_product	string	O produto Square, como Square Point of Sale (POS), Square Invoices ou Square Virtual Terminal.
ID da aplicação	payment.application_details.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Token de versão	payment.version_token	string	Esse token opaco identifica uma versão específica do objeto.

Recuperar ajuste de estoque

ID da Operação:: InventoryRetrieveAdjustment

Retorna o objeto InventoryAdjustment com a adjustment_id fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de ajuste	adjustment_id	True	string	O identificador do ajuste.

Devoluções

Name	Caminho	Tipo	Description
ID	adjustment.id	string	O identificador único, emitido pela Square.
ID de Referência	adjustment.reference_id	string	Um ID de referência opcional definido pelo usuário.
Do Estado	adjustment.from_state	string	O estado de estoque da quantidade relacionada de itens antes do ajuste.
Afirmar	adjustment.to_state	string	O estado de estoque da quantidade relacionada de itens após o ajuste.
ID da Localização	adjustment.location_id	string	O identificador do local.
ID do objeto do catálogo	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 decimal. Pode suportar até 5 dígitos após a vírgula decimal.
Montante	adjustment.total_price_money.amount	integer	O montante.
Moeda	adjustment.total_price_money.currency	string	A moeda.
ocorreu em	adjustment.occurred_at	string	Um carimbo de data/hora formatado em RFC 3339 gerado pelo cliente que indica quando o ajuste de estoque ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora do occurred_at não pode ter mais de 24 horas ou no futuro relativo à hora da solicitação.
Criado em	adjustment.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
Produto	adjustment.source.product	string	Tipo de produto para a aplicação.
ID da aplicação	adjustment.source.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Nome	adjustment.source.name	string	O nome.
ID do funcionário	adjustment.employee_id	string	O ID gerado pelo quadrado do funcionário.

Recuperar cartão

ID da Operação:: CardRetrieve

Recupera detalhes de um Cartão específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Identificação do cartão	card_id	True	string	O identificador do cartão.

Devoluções

Name	Caminho	Tipo	Description
ID	card.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Endereço Linha 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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	card.billing_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Impressão digital	card.fingerprint	string	Concebido como um identificador atribuído ao quadrado, com base no número do cartão, para identificar o cartão em vários locais dentro de um único aplicativo.
COMPARTIMENTO	card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
Marca do 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 deste objeto que representa o cliente.
Ativado(a)	card.enabled	boolean	Se ativado.
Exp Mês	card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Exp Ano	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	Um ID de referência opcional definido pelo usuário.
Versão	card.version	integer	A versão atual deste objeto.

Recuperar cliente

ID da Operação:: CustomerRetrieve

Retorna detalhes de um único cliente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Cliente	customer_id	True	string	O identificador do cliente.

Devoluções

Name	Caminho	Tipo	Description
ID	customer.id	string	O identificador único, emitido pela Square.
Criado em	customer.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
Nome Próprio	customer.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	customer.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	customer.email_address	string	O endereço de e-mail 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 da rua, nome da rua e nome do edifício.
Endereço Linha 2	customer.address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	customer.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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	Um ID de referência opcional definido pelo usuário.
Observação	customer.note	string	Uma nota personalizada associada ao perfil do cliente.
E-mail não inscrito	customer.preferences.email_unsubscribed	boolean	Indica se o cliente cancelou a inscrição nos e-mails da campanha de marketing. Um valor verdadeiro significa que o cliente optou por não receber e-mail marketing do vendedor atual da Square ou de todos os vendedores da Square.
Fonte de 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 de estoque calculada atual para um determinado CatalogObject em um determinado conjunto de Locations.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do objeto do catálogo	catalog_object_id	True	string	O identificador do objeto de catálogo.
IDs de localização	location_ids		string	Os IDs de local a serem pesquisados como uma lista separada por vírgula. Uma lista vazia consulta todos os locais.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Contagens	counts	array of object
ID do objeto do catálogo	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 da Localização	counts.location_id	string	O identificador do local.
Quantidade	counts.quantity	string	O número de itens afetados pela contagem estimada como uma cadeia decimal. Pode suportar até 5 dígitos após a vírgula decimal.
Calculado em	counts.calculated_at	string	Um carimbo de data/hora formatado em RFC 3339 que indica quando a contagem física mais recente ou o ajuste que afeta a contagem estimada é recebido.

Recuperar contagem física de inventário

ID da Operação:: InventoryRetrievePhysicalCount

Retorna o objeto InventoryPhysicalCount com a physical_count_id fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de contagem física	physical_count_id	True	string	O identificador da contagem física.

Devoluções

Name	Caminho	Tipo	Description
ID	count.id	string	O identificador único, emitido pela Square.
ID de Referência	count.reference_id	string	Um ID de referência opcional definido pelo usuário.
ID do objeto do catálogo	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 da Localização	count.location_id	string	O identificador do local.
Quantidade	count.quantity	string	O número de itens afetados pelo ajuste como uma cadeia decimal. Pode suportar até 5 dígitos após a vírgula decimal.
Produto	count.source.product	string	Tipo de produto para a aplicação.
ID da aplicação	count.source.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Nome	count.source.name	string	O nome.
ID do funcionário	count.employee_id	string	O ID gerado pelo quadrado do funcionário.
ocorreu em	count.occurred_at	string	Um carimbo de data/hora formatado em RFC 3339 gerado pelo cliente que indica quando o ajuste de estoque ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora do occurred_at não pode ter mais de 24 horas ou no futuro relativo à hora da solicitação.
Criado em	count.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.

Recuperar disputa

ID da Operação:: DisputeRetrieve

Retorna detalhes sobre uma disputa específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.

Devoluções

Name	Caminho	Tipo	Description
ID	dispute.id	string	O identificador único, emitido pela Square.
Montante	dispute.amount_money.amount	integer	O montante.
Moeda	dispute.amount_money.currency	string	A moeda.
Reason	dispute.reason	string	A razão para este objeto.
Estado	dispute.state	string	O estado atual.
Vencimento em	dispute.due_at	string	A hora em que a próxima ação é devida, no formato RFC 3339.
Pagamentos contestados	dispute.disputed_payments	array of object
ID de pagamento	dispute.disputed_payments.payment_id	string	ID único do pagamento gerado pela Square.
Marca do 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 deste 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 deste objeto, no formato RFC 3339.
ID de disputa de marca	dispute.brand_dispute_id	string	O ID da disputa no sistema de marca do cartão, gerado pela marca do cartão.

Recuperar encomenda

ID da Operação:: OrderRetrieve

Recupera um pedido por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id	True	string	O identificador da ordem.

Devoluções

Name	Caminho	Tipo	Description
ID	order.id	string	O identificador único, emitido pela Square.
ID da Localização	order.location_id	string	O identificador do local.
Itens de linha	order.line_items	array of object
UID	order.line_items.uid	string	O ID gerado pela Square.
Quantidade	order.line_items.quantity	string	O número de itens afetados pela contagem física como uma cadeia decimal. O número pode suportar até 5 dígitos após a vírgula decimal.
Nome	order.line_items.name	string	O nome do item. Este é 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.
Montante	order.line_items.base_price_money.amount	integer	O montante.
Moeda	order.line_items.base_price_money.currency	string	A moeda.
Montante	order.line_items.gross_sales_money.amount	integer	O montante.
Moeda	order.line_items.gross_sales_money.currency	string	A moeda.
Montante	order.line_items.total_tax_money.amount	integer	O montante.
Moeda	order.line_items.total_tax_money.currency	string	A moeda.
Montante	order.line_items.total_discount_money.amount	integer	O montante.
Moeda	order.line_items.total_discount_money.currency	string	A moeda.
Montante	order.line_items.total_money.amount	integer	O montante.
Moeda	order.line_items.total_money.currency	string	A moeda.
Montante	order.line_items.variation_total_price_money.amount	integer	O montante.
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	Um ID atribuído ao quadrado.
Desconto UID	order.line_items.applied_discounts.discount_uid	string	O uid do desconto que o desconto aplicado representa.
Montante	order.line_items.applied_discounts.applied_money.amount	integer	O montante.
Moeda	order.line_items.applied_discounts.applied_money.currency	string	A moeda.
Descontos	order.discounts	array of object
UID	order.discounts.uid	string	O ID gerado pela Square.
Nome	order.discounts.name	string	O nome do item. Este é 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.
Percentagem	order.discounts.percentage	string	A percentagem na forma decimal, usando um '.' como separador decimal e sem um sinal '%'. Um valor de 7,5 corresponde a 7,5%.
Montante	order.discounts.applied_money.amount	integer	O montante.
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 deste 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 deste objeto, no formato RFC 3339.
Estado	order.state	string	O estado atual.
Versão	order.version	integer	A versão atual deste objeto.
Montante	order.total_tax_money.amount	integer	O montante.
Moeda	order.total_tax_money.currency	string	A moeda.
Montante	order.total_discount_money.amount	integer	O montante.
Moeda	order.total_discount_money.currency	string	A moeda.
Montante	order.total_tip_money.amount	integer	O montante.
Moeda	order.total_tip_money.currency	string	A moeda.
Montante	order.total_money.amount	integer	O montante.
Moeda	order.total_money.currency	string	A moeda.
Montante	order.total_service_charge_money.amount	integer	O montante.
Moeda	order.total_service_charge_money.currency	string	A moeda.
Montante	order.net_amounts.total_money.amount	integer	O montante.
Moeda	order.net_amounts.total_money.currency	string	A moeda.
Montante	order.net_amounts.tax_money.amount	integer	O montante.
Moeda	order.net_amounts.tax_money.currency	string	A moeda.
Montante	order.net_amounts.discount_money.amount	integer	O montante.
Moeda	order.net_amounts.discount_money.currency	string	A moeda.
Montante	order.net_amounts.tip_money.amount	integer	O montante.
Moeda	order.net_amounts.tip_money.currency	string	A moeda.
Montante	order.net_amounts.service_charge_money.amount	integer	O montante.
Moeda	order.net_amounts.service_charge_money.currency	string	A moeda.

Recuperar grupo de clientes

ID da Operação:: CustomerGroupRetrieve

Recupera um grupo de clientes específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	group_id	True	string	O identificador do grupo.

Devoluções

Name	Caminho	Tipo	Description
ID	group.id	string	O identificador único, emitido pela Square.
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 deste 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 deste 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 de CatalogItem, incluindo: filhos CatalogItemVariation , referências a seus objetos CatalogModifierList e as ids de quaisquer objetos CatalogTax que se aplicam a ele.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do objeto	object_id	True	string	O identificador do objeto.
Incluir objetos relacionados	include_related_objects		boolean	Se 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 um CatalogItemVariation, seu pai CatalogItem será retornado no campo related_objects da resposta.

Devoluções

Name	Caminho	Tipo	Description
Tipo	object.type	string	O tipo deste objeto.
ID	object.id	string	O identificador único, emitido pela Square.
Atualizado em	object.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente deste objeto, no formato RFC 3339.
Versão	object.version	integer	A versão atual deste objeto.
É suprimido	object.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento 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.
Identificação fiscal	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 deste 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.
É suprimido	object.item_data.variations.is_deleted	boolean	Se verdadeiro, 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 verdadeiro, esse objeto estará presente em todos os locais (incluindo locais futuros), exceto quando especificado no campo absent_at_location_ids. Se false, 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. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Ordinal	object.item_data.variations.item_variation_data.ordinal	integer	A ordem em que essa variação de item deve ser exibida. Esse valor é somente leitura. Em gravações, o ordinal para cada variação de item dentro de um CatalogItem pai é definido de acordo com a posição das variações do item. Em leituras, não é garantido que o valor seja 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.
Montante	object.item_data.variations.item_variation_data.price_money.amount	integer	O montante.
Moeda	object.item_data.variations.item_variation_data.price_money.currency	string	A moeda.

Recuperar provas de litígio

ID da Operação:: DisputeRetrieveEvidence

Retorna os metadados de evidência especificados pelo ID de evidência no caminho da URL da solicitação. Deve manter uma cópia dos elementos de prova carregados se pretender consultá-los mais tarde. Não é possível descarregar as provas depois de as carregar.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do litígio	dispute_id	True	string	O identificador do litígio.
ID da prova	evidence_id	True	string	O identificador das provas.

Devoluções

Name	Caminho	Tipo	Description
ID	evidence.id	string	O identificador único, emitido pela Square.
ID do litígio	evidence.dispute_id	string	O ID do litígio ao qual a prova está associada.
Nome do ficheiro	evidence.evidence_file.filename	string	Os arquivos de provas de disputa devem ser nos formatos application/pdf, image/heic, image/heif, image/jpeg, image/png ou image/tiff.
Tipo de ficheiro	evidence.evidence_file.filetype	string	O nome do arquivo, incluindo a extensão do 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 é devida, no formato RFC 3339.

Recuperar segmento de clientes

ID da Operação:: CustomerSegmentRetrieve

Recupera um segmento de cliente específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Segmento	segment_id	True	string	O identificador do segmento.

Devoluções

Name	Caminho	Tipo	Description
ID	segment.id	string	O identificador único, emitido pela Square.
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 deste 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 deste objeto, no formato RFC 3339.

Recuperar subscrição

ID da Operação:: SubscriptionRetrieve

Recupera uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscription_id	True	string	O identificador da assinatura.

Devoluções

Name	Caminho	Tipo	Description
ID	subscription.id	string	O identificador único, emitido pela Square.
ID da Localização	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 deste objeto que representa o cliente.
Data de início	subscription.start_date	string	A data de início da subscrição, no formatoMM-DD AAAA.
Cobrado até a data	subscription.charged_through_date	string	A data até à qual o cliente é faturado pela subscrição, no formato AAAA-MM-DD.
Situação	subscription.status	string	O status de verificação atual deste objeto.
IDs da fatura	subscription.invoice_ids	array of string
Montante	subscription.price_override_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
Pago até à data	subscription.paid_until_date	string	A data paga até.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar 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 transferência de inventário (Beta)

ID da Operação:: InventoryRetrieveTransfer

Retorna o objeto InventoryTransfer com a transfer_id fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de transferência	transfer_id	True	string	O identificador da transferência.

Devoluções

Name	Caminho	Tipo	Description
ID	transfer.id	string	O identificador único, emitido pela Square.
ID do objeto do catálogo	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 deste objeto, no formato RFC 3339.
ID do funcionário	transfer.employee_id	string	O ID gerado pelo quadrado do funcionário.
Do ID do local	transfer.from_location_id	string	O ID gerado pelo quadrado do local onde a quantidade relacionada de itens foi rastreada antes da transferência.
Para ID de localização	transfer.to_location_id	string	O ID gerado pelo quadrado do local onde a quantidade relacionada de itens foi rastreada após a transferência.
ocorreu em	transfer.occurred_at	string	Um carimbo de data/hora formatado em RFC 3339 gerado pelo cliente que indica quando o ajuste de estoque ocorreu. Para atualizações de ajuste de inventário, o carimbo de data/hora do occurred_at não pode ter mais de 24 horas ou no futuro relativo à hora da solicitação.
Quantidade	transfer.quantity	string	O número de itens afetados pelo ajuste como uma cadeia decimal. Pode suportar até 5 dígitos após a vírgula decimal.
ID de Referência	transfer.reference_id	string	Um ID de referência opcional definido pelo usuário.
Produto	transfer.source.product	string	Tipo de produto para a aplicação.
ID da aplicação	transfer.source.application_id	string	ID quadrado somente leitura atribuído ao aplicativo.
Nome	transfer.source.name	string	O nome.
Estado	transfer.state	string	O estado atual.

Reembolsos do terminal de pesquisa

ID da Operação:: TerminalSearchRefunds

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.
Situação	status		string	O status atual.

Devoluções

Name	Caminho	Tipo	Description
Reembolsos	refunds	array of object
ID	refunds.id	string	O identificador único, emitido pela Square.
ID do reembolso	refunds.refund_id	string	O ID exclusivo para este reembolso, gerado pela Square.
ID de pagamento	refunds.payment_id	string	O ID do pagamento.
Montante	refunds.amount_money.amount	integer	O montante.
Moeda	refunds.amount_money.currency	string	A moeda.
Reason	refunds.reason	string	O litígio levou o titular do cartão a iniciar o litígio com o seu banco.
ID do dispositivo	refunds.device_id	string	A ID exclusiva do dispositivo que usou esse código. Preenchido quando o dispositivo está emparelhado.
Duração do Prazo	refunds.deadline_duration	string	Uma duração RFC 3339, após a qual o checkout é automaticamente cancelado. Um TerminalCheckout que está PENDENTE é automaticamente CANCELADO e tem um motivo de cancelamento de TIMED_OUT. Padrão: 5 minutos da criação
Situação	refunds.status	string	O status de verificação atual deste 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 de Aplicação	refunds.app_id	string	A ID do aplicativo que criou o checkout.
Marca do 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 Validade	refunds.card.exp_month	integer	O mês de expiração do cartão associado como um número inteiro entre 1 e 12.
Ano de Validade	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	Concebido como um identificador atribuído ao 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.
COMPARTIMENTO	refunds.card.bin	string	Os primeiros seis dígitos do número do cartão, conhecido como Número de Identificação Bancária (BIN).
ID da encomenda	refunds.order_id	string	O ID do pedido.
ID da Localização	refunds.location_id	string	O identificador do local.

Registrar domínio para o 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 é realizada neste domínio pela Apple para garantir que ele esteja configurado corretamente como um domínio habilitado para Apple Pay.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	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

Name	Chave	Necessá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.

Devoluções

response: object

Retomar subscrição

ID da Operação:: SubscriptionResume

Retoma uma subscrição desativada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscription_id	True	string	O identificador da assinatura.

Devoluções

Name	Caminho	Tipo	Description
ID	subscription.id	string	O identificador único, emitido pela Square.
ID da Localização	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 deste objeto que representa o cliente.
Situação	subscription.status	string	O status de verificação atual deste objeto.
Montante	subscription.price_override_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
Timezone	subscription.timezone	string	O fuso horário usado para interpretar 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

objecto

Este é o tipo 'objeto'.

Partilhar via

Square Payments (Editora Independente) (Pré-visualização)

Limites de Limitação

Ações

Aceitar disputa

Parâmetros

Devoluções

Adicionar grupo ao cliente

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Apresentar elementos de prova

Parâmetros

Devoluções

Atualizar cliente

Parâmetros

Devoluções

Atualizar fatura

Parâmetros

Devoluções

Atualizar grupo de clientes

Parâmetros

Devoluções

Atualizar impostos de itens

Parâmetros

Devoluções

Atualizar listas de modificadores de itens

Parâmetros

Devoluções

Atualizar pagamento

Parâmetros

Devoluções

Atualizar subscrição

Parâmetros

Devoluções

Calcular ordem (Beta)

Parâmetros

Devoluções

Cancelar check-out do terminal

Parâmetros

Devoluções

Cancelar fatura

Parâmetros

Devoluções

Cancelar pagamento

Parâmetros

Devoluções

Cancelar pagamento por chave idempotency

Parâmetros

Devoluções

Cancelar reembolso do terminal

Parâmetros

Devoluções

Cancelar subscrição

Parâmetros

Devoluções

Checkouts no terminal de pesquisa

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Criar cartão

Parâmetros

Devoluções

Criar check-out de terminal

Parâmetros

Devoluções

Criar cliente

Parâmetros

Devoluções

Criar encomenda

Parâmetros

Devoluções

Criar fatura

Parâmetros

Devoluções

Criar grupo de clientes