Paiements carrés (éditeur indépendant) (préversion)

Square aide des millions de vendeurs à gérer leur entreprise , du traitement sécurisé des cartes de crédit aux solutions de point de vente. Ce connecteur contient des actions pour les points de terminaison suivants : paiements, terminal, commandes, abonnements, factures, catalogue, inventaire et clients.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Troy Taylor
URL	https://www.hitachisolutions.com
Messagerie électronique	ttaylor@hitachisolutions.com

Métadonnées du connecteur
Éditeur	Troy Taylor
Site internet	https://squareup.com/
Politique de confidentialité	https://squareup.com/us/en/legal/general/privacy
Catégories	Commerce; Ventes et CRM

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Abonnements de recherche	Recherche des abonnements. Les résultats sont classés chronologiquement par date de création d’abonnement. Si la demande spécifie plusieurs ID d’emplacement, le point de terminaison trie le résultat par ID d’emplacement, puis par date de création dans chaque emplacement. Si aucun emplacement n’est fourni dans la requête, tous les emplacements sont recherchés.
Accepter le différend	Accepte la perte d’un litige. Square retourne le montant contesté au titulaire de carte et met à jour l’état du différend accepté. Square débite le montant contesté du compte Square du vendeur. Si le compte Square n’a pas suffisamment de fonds, Square débite le compte bancaire associé.
Ajouter un groupe au client	Ajoute une appartenance à un groupe à un client. Le client est identifié par la valeur customer_id et le groupe de clients est identifié par la valeur group_id.
Annuler la facture	Annule une facture. Le vendeur ne peut pas collecter les paiements pour la facture annulée.
Annuler le paiement	Annule (voids) un paiement. Vous pouvez utiliser ce point de terminaison pour annuler un paiement avec l’état APPROUVÉ.
Annuler le paiement par clé d’idempotency	Annule (voids) un paiement identifié par la clé d’idempotency spécifiée dans la demande. Utilisez cette méthode lorsque l’état d’une demande CreatePayment est inconnu (par exemple, après avoir envoyé une demande CreatePayment, une erreur réseau se produit et que vous n’obtenez pas de réponse). Dans ce cas, vous pouvez diriger Square pour annuler le paiement à l’aide de ce point de terminaison. Dans la demande, vous fournissez la même clé d’idempotency que celle que vous avez fournie dans votre demande CreatePayment que vous souhaitez annuler. Après avoir annulé le paiement, vous pouvez à nouveau soumettre votre demande CreatePayment. Notez que si aucun paiement avec la clé d’idempotency spécifiée est trouvé, aucune action n’est effectuée et le point de terminaison retourne correctement.
Annuler le remboursement du terminal	Annule une demande de remboursement d’un terminal De Débogage par ID de demande de remboursement si l’état de la demande l’autorise.
Annuler l’abonnement	Définit le champ canceled_date à la fin de la période de facturation active. Après cette date, l’état passe d’ACTIVE à CANCELED.
Annuler l’extraction du terminal	Annule une demande d’extraction de terminal si l’état de la demande l’autorise.
Calculer l’ordre (bêta)	Permet aux applications d’afficher un aperçu des tarifs des commandes sans créer de commande.
Cartes de liste	Récupère une liste de cartes détenues par le compte qui effectue la demande.
Commandes de recherche	Recherchez toutes les commandes pour un ou plusieurs emplacements. Les commandes incluent toutes les ventes, les retours et les échanges, indépendamment de la façon ou du moment où ils sont entrés dans l’écosystème Square (par exemple, point de vente, factures et API Connect).
Commandes de récupération par lots	Récupère un ensemble de commandes par leurs ID. S’il n’existe pas d’ID d’ordre donné, l’ID est ignoré au lieu de générer une erreur.
Créer un abonnement	Crée un abonnement pour un client à un plan d’abonnement. Si vous fournissez une carte dans la demande, Square facture la carte de l’abonnement. Sinon, Square facture une facture à l’adresse e-mail du client. L’abonnement démarre immédiatement, sauf si la demande inclut la start_date facultative. Chaque abonnement individuel est associé à un emplacement particulier.
Créer un client	Crée un client pour une entreprise.
Créer un extraction de terminal	Crée une demande de paiement terminal et l’envoie à l’appareil spécifié pour prendre un paiement pour le montant demandé.
Créer un groupe de clients	Crée un groupe de clients pour une entreprise.
Créer un paiement	Crée un paiement à l’aide de la source fournie. Vous pouvez utiliser ce point de terminaison pour facturer une carte (carte de crédit/débit ou carte cadeau Square) ou enregistrer un paiement que le vendeur a reçu en dehors de Square (paiement en espèces d’un acheteur ou d’un paiement qu’une entité externe a traitée pour le compte du vendeur).
Créer un remboursement de terminal	Crée une demande de remboursement d’un paiement Effectué sur un terminal Square.
Créer un texte de preuve de litige	Charge le texte à utiliser comme preuve pour un litige.
Créer une carte	Ajoute une carte sur un fichier à un marchand existant.
Créer une commande	Crée une commande qui peut inclure des informations sur les produits pour l’achat et les paramètres à appliquer à l’achat.
Créer une facture	Crée une facture brouillon pour une commande créée à l’aide de l’API Commandes. Un brouillon de facture reste dans votre compte et aucune action n’est prise. Vous devez publier la facture avant que Square puisse le traiter (l’envoyer à l’adresse e-mail du client ou facturer la carte du client sur le fichier).
Désactiver la carte	Désactive la carte, empêchant toute mise à jour ou frais supplémentaires. La désactivation d’une carte déjà désactivée est autorisée, mais n’a aucun effet.
Extractions de terminal de recherche	Récupère une liste filtrée des demandes d’extraction de terminal créées par le compte qui effectue la requête.
Informations de catalogue	Récupère des informations sur l’API du catalogue carré, telles que les limites de taille de lot qui peuvent être utilisées par le point de terminaison BatchUpsertCatalogObjects.
Inscrire un domaine pour Apple Pay	Active un domaine à utiliser avec Apple Pay sur le web et square. Une validation est effectuée sur ce domaine par Apple pour s’assurer qu’elle est correctement configurée en tant que domaine Compatible Apple Pay.
Inventaire des modifications par lots	Applique des ajustements et des nombres aux quantités d’articles fournies. En cas de réussite : retourne le nombre calculé actuel pour tous les objets référencés dans la requête.
Lister les preuves de litige	Retourne une liste de preuves associées à un litige.
Mettre à jour la facture	Met à jour une facture en modifiant les champs, en désactivant les champs ou les deux.
Mettre à jour le groupe de clients	Met à jour un groupe de clients.
Mettre à jour le paiement	Met à jour un paiement avec l’état APPROUVÉ. Vous pouvez mettre à jour les amount_money et les tip_money à l’aide de ce point de terminaison.
Mettre à jour les listes de modificateurs d’élément	Met à jour les objets CatalogModifierList qui s’appliquent à l’objet CatalogItem ciblé sans avoir à effectuer un upsert sur l’élément entier.
Mettre à jour les taxes sur les éléments	Met à jour les objets CatalogTax qui s’appliquent à l’objet CatalogItem ciblé sans avoir à effectuer un upsert sur l’ensemble de l’élément.
Mettre à jour un abonnement	Met à jour un abonnement. Vous pouvez définir, modifier et effacer les valeurs de champ d’abonnement.
Mettre à jour un client	Met à jour un profil client. Pour modifier un attribut, spécifiez la nouvelle valeur. Pour supprimer un attribut, spécifiez la valeur sous la forme d’une chaîne vide ou d’un objet vide.
Nombres d’inventaire de récupération par lots	Retourne les nombres actuels pour les CatalogObjects fournis aux emplacements demandés.
Objet catalogue Upsert	Crée ou met à jour le CatalogObject cible.
Objets catalogue Batch upsert	Crée ou met à jour jusqu’à 10 000 objets cibles en fonction de la liste fournie d’objets. Les objets cibles sont regroupés en lots et chaque lot est inséré/mis à jour de manière tout ou rien. Si un objet au sein d’un lot est mal formé d’une certaine manière ou enfreint une contrainte de base de données, le lot entier contenant cet élément sera ignoré. Toutefois, d’autres lots de la même requête peuvent toujours réussir. Chaque lot peut contenir jusqu’à 1 000 objets et les lots seront traités dans l’ordre tant que le nombre total d’objets pour la demande (éléments, variantes, listes de modificateurs, remises et taxes) n’est pas supérieur à 10 000.
Objets catalogue de suppression par lots	Supprime un ensemble de CatalogItems en fonction de la liste fournie des ID cibles et retourne un ensemble d’ID supprimés correctement dans la réponse.
Obtenir la facture	Récupère une facture par ID de facture.
Obtenir le paiement	Récupère les détails d’un paiement spécifique.
Obtenir le remboursement du paiement	Récupère un remboursement spécifique à l’aide du refund_id.
Obtenir le remboursement du terminal	Récupère un objet de remboursement de terminal De Débogage par ID.
Obtenir l’extraction du terminal	Récupère une demande d’extraction de terminal par checkout_id.
Ordre de clonage (bêta)	Crée un ordre, dans l’état DRAFT, en dupliquant un ordre existant. La commande nouvellement créée contient uniquement les champs principaux (tels que les articles de ligne, les taxes et les remises) copiés à partir de la commande d’origine.
Ordre de mise à jour (bêta)	Met à jour un ordre ouvert en ajoutant, en remplaçant ou en supprimant des champs. Les commandes avec un état COMPLETED ou CANCELED ne peuvent pas être mises à jour.
Ordre de paiement (bêta)	Payez pour une commande à l’aide d’un ou plusieurs paiements approuvés ou réglez une commande avec un total de 0. Le total des payment_ids répertoriés dans la demande doit être égal au total de la commande. Les commandes avec un montant total de 0 peuvent être marquées comme payantes en spécifiant un tableau vide de payment_ids dans la demande.
Paiement complet	Termine (capture) un paiement. Par défaut, les paiements sont définis pour être terminés immédiatement après leur création.
Publier une facture	Publie la facture brouillon spécifiée. Une fois qu’une facture est publiée, Square suit la configuration de la facture. Par exemple, Square envoie la facture à l’adresse e-mail du client, facture la carte du client sur le fichier ou ne fait rien. Square rend également la facture disponible sur une page de facture hébergée sur place.
Rechercher des clients	Recherche les profils clients associés à un compte Square à l’aide d’un filtre de requête pris en charge. L’appel de SearchCustomers sans filtre de requête explicite retourne tous les profils clients classés par ordre alphabétique en fonction de given_name et de family_name.
Rechercher des factures	Recherche les factures à partir d’un emplacement spécifié dans le filtre.
Rechercher des objets de catalogue	Recherche CatalogObject de n’importe quel type en correspondant aux valeurs d’attributs de recherche prises en charge, à l’exclusion des valeurs d’attribut personnalisées sur les éléments ou les variantes d’élément, par rapport à un ou plusieurs des filtres de requête spécifiés.
Remboursement du paiement	Remboursement d’un paiement. Vous pouvez rembourser l’intégralité du montant du paiement ou une partie de celui-ci. Vous pouvez utiliser ce point de terminaison pour rembourser un paiement par carte ou enregistrer un remboursement d’un paiement en espèces ou externe.
Remboursements des terminaux de recherche	Récupère une liste filtrée des demandes de remboursement de Terminal De Runtime créées par le vendeur effectuant la demande.
Reprendre l’abonnement	Reprend un abonnement désactivé.
Récupération par lots des modifications d’inventaire	Retourne les nombres physiques historiques et les ajustements en fonction des critères de filtre fournis.
Récupération par lots d’objets catalogue	Retourne un ensemble d’objets en fonction de l’ID fourni. Chaque CatalogItem retourné dans l’ensemble inclut toutes ses informations enfants, notamment : tous ses objets CatalogItemVariation, références à ses objets CatalogModifierList et ids des objets CatalogTax qui s’y appliquent.
Récupérer la preuve des différends	Retourne les métadonnées de preuve spécifiées par l’ID de preuve dans le chemin d’URL de la demande. Vous devez conserver une copie de la preuve que vous chargez si vous souhaitez la référencer ultérieurement. Vous ne pouvez pas télécharger la preuve une fois que vous l’avez téléchargée.
Récupérer le client	Retourne les détails d’un seul client.
Récupérer le différend	Retourne des détails sur un litige spécifique.
Récupérer le groupe de clients	Récupère un groupe de clients spécifique.
Récupérer le nombre d’inventaires	Récupère le nombre d’actions calculés actuel pour un CatalogObject donné à un ensemble donné d’emplacements.
Récupérer le nombre physique d’inventaire	Retourne l’objet InventoryPhysicalCount avec la physical_count_id fournie.
Récupérer le segment client	Récupère un segment de client spécifique.
Récupérer le transfert d’inventaire (bêta)	Retourne l’objet InventoryTransfer avec la transfer_id fournie.
Récupérer l’abonnement	Récupère un abonnement.
Récupérer l’ajustement de l’inventaire	Retourne l’objet InventoryAdjustment avec le adjustment_id fourni.
Récupérer l’objet catalogue	Retourne un objet CatalogItem unique en tant que CatalogObject basé sur l’ID fourni. L’objet retourné inclut toutes les informations CatalogItem pertinentes, notamment les enfants CatalogItemVariation, les références à ses objets CatalogModifierList et les ID des objets CatalogTax qui s’y appliquent.
Récupérer l’ordre	Récupère une commande par ID.
Récupérer une carte	Récupère les détails d’une carte spécifique.
Répertorier le catalogue	Renvoie une liste de CatalogObjects qui inclut tous les objets d’un ensemble de types souhaités (par exemple, tous les objets CatalogItem et CatalogTax) dans le catalogue. ListCatalog ne retourne pas d’éléments de catalogue supprimés.
Répertorier les clients	Répertorie les profils clients associés à un compte Square. Dans des conditions d’exploitation normales, les profils clients nouvellement créés ou mis à jour deviennent disponibles pour l’opération de référencement en moins de 30 secondes. Parfois, la propagation des profils nouveaux ou mis à jour peut prendre plus d’une minute ou plus, en particulier pendant les incidents réseau et les pannes.
Répertorier les différends	Retourne une liste de litiges associés à un compte particulier.
Répertorier les factures	Retourne une liste de factures pour un emplacement donné.
Répertorier les groupes de clients	Récupère la liste des groupes de clients d’une entreprise.
Répertorier les paiements	Récupère la liste des paiements pris par le compte qui effectue la demande. Les résultats sont finalement cohérents et les nouveaux paiements ou modifications apportées aux paiements peuvent prendre plusieurs secondes.
Répertorier les remboursements de paiement	Récupère une liste de remboursements pour le compte effectuant la demande. Les résultats sont finalement cohérents et les nouveaux remboursements ou modifications apportées aux remboursements peuvent prendre plusieurs secondes.
Répertorier les segments de client	Récupère la liste des segments de clients d’une entreprise.
Répertorier les événements d’abonnement	Répertorie tous les événements d’un abonnement spécifique.
Soumettre des preuves	Soumet des preuves à la banque du titulaire de carte. Avant de soumettre une preuve, Square compile toutes les preuves disponibles. Cela inclut la preuve chargée à l’aide des points de terminaison CreateDisputeEvidenceFile et CreateDisputeEvidenceText et des preuves automatiquement fournies par Square, le cas échéant.
Supprimer la facture	Supprime la facture spécifiée. Lorsqu’une facture est supprimée, l’état de commande associé passe à CANCELED. Vous ne pouvez supprimer qu’une facture brouillon (vous ne pouvez pas supprimer une facture publiée, y compris une facture planifiée pour le traitement).
Supprimer la preuve de litige	Supprime la preuve spécifiée d’un litige.
Supprimer le groupe du client	Supprime une appartenance à un groupe d’un client. Le client est identifié par la valeur customer_id et le groupe de clients est identifié par la valeur group_id.
Supprimer l’objet catalogue	Supprime un seul CatalogObject en fonction de l’ID fourni et retourne l’ensemble d’ID supprimés correctement dans la réponse. La suppression est un événement en cascade, de sorte que tous les enfants de l’objet ciblé sont également supprimés. Par exemple, la suppression d’un CatalogItem supprime également tous ses enfants CatalogItemVariation.
Supprimer un client	Supprime un profil client d’une entreprise. Cette opération dissocie également toutes les cartes associées sur le fichier.
Supprimer un groupe de clients	Supprime un groupe de clients identifié par la valeur group_id.

Abonnements de recherche

ID d’opération :: SubscriptionSearch

Recherche des abonnements. Les résultats sont classés chronologiquement par date de création d’abonnement. Si la demande spécifie plusieurs ID d’emplacement, le point de terminaison trie le résultat par ID d’emplacement, puis par date de création dans chaque emplacement. Si aucun emplacement n’est fourni dans la requête, tous les emplacements sont recherchés.

Paramètres

Nom	Clé	Type
ID d’emplacement	location_ids	array of string
ID client	customer_ids	array of string
Noms sources	source_names	array of string

Retours

Nom	Chemin d’accès	Type	Description
Abonnements	subscriptions	array of object
ID	subscriptions.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscriptions.location_id	string	Identificateur de l’emplacement.
ID plan	subscriptions.plan_id	string	ID du plan d’abonnement associé
ID de client	subscriptions.customer_id	string	ID attribué au carré du client associé au compte.
Date de début	subscriptions.start_date	string	Date de début de l’abonnement, au format aaaa-MM-DD.
Date annulée	subscriptions.canceled_date	string	Date d’annulation de l’abonnement, au format aaaa-MM-DD.
Facturé à la date	subscriptions.charged_through_date	string	Date à laquelle le client est facturé pour l’abonnement, au format aaaa-MM-DD.
Statut	subscriptions.status	string	État de vérification actuel de cet objet.
Créé à	subscriptions.created_at	string	Heure de l’événement au format ISO 8601.
ID de carte	subscriptions.card_id	string	ID de la carte client facturée pour l’abonnement.
Payé jusqu’à la date	subscriptions.paid_until_date	string	Date payée jusqu’à ce que.
Timezone	subscriptions.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier sur la facture, telles que due_date. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscriptions.source.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage fiscal	subscriptions.tax_percentage	string	Montant fiscal appliqué lors de la facturation de l’abonnement.
Montant	subscriptions.price_override_money.amount	integer	Montant.
Monnaie	subscriptions.price_override_money.currency	string	La devise.
Version	subscriptions.version	integer	Version actuelle de l’objet.
ID de facture	subscriptions.invoice_ids	array of string

Accepter le différend

ID d’opération :: DisputeAccept

Accepte la perte d’un litige. Square retourne le montant contesté au titulaire de carte et met à jour l’état du différend accepté. Square débite le montant contesté du compte Square du vendeur. Si le compte Square n’a pas suffisamment de fonds, Square débite le compte bancaire associé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.

Retours

Nom	Chemin d’accès	Type	Description
ID	dispute.id	string	Identificateur unique émis par carré.
Montant	dispute.amount_money.amount	integer	Montant.
Monnaie	dispute.amount_money.currency	string	La devise.
Reason	dispute.reason	string	Raison de cet objet.
État	dispute.state	string	État actuel.
Due At	dispute.due_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.
Paiements contestés	dispute.disputed_payments	array of object
ID de paiement	dispute.disputed_payments.payment_id	string	ID unique généré par carré du paiement.
Marque de carte	dispute.card_brand	string	La marque de la carte.
Créé à	dispute.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	dispute.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de litige de marque	dispute.brand_dispute_id	string	ID du litige dans le système de marque de carte, généré par la marque de carte.

Ajouter un groupe au client

ID d’opération :: CustomerAddGroup

Ajoute une appartenance à un groupe à un client. Le client est identifié par la valeur customer_id et le groupe de clients est identifié par la valeur group_id.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de client	customer_id	True	string	Identificateur du client.
ID de groupe	group_id	True	string	Identificateur du groupe.

Retours

response: object

Annuler la facture

ID d’opération :: InvoiceCancel

Annule une facture. Le vendeur ne peut pas collecter les paiements pour la facture annulée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID facture	invoice_id	True	string	Identificateur de la facture.
Version	version		integer	Version.

Retours

Nom	Chemin d’accès	Type	Description
ID	invoice.id	string	Identificateur unique émis par carré.
Version	invoice.version	integer	Version actuelle de cet objet.
ID d’emplacement	invoice.location_id	string	Identificateur de l’emplacement.
ID de commande	invoice.order_id	string	ID de l’ordre.
Demandes de paiement	invoice.payment_requests	array of object
Identificateur d’utilisateur	invoice.payment_requests.uid	string	ID généré par carré.
Type de requête	invoice.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoice.payment_requests.due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	invoice.payment_requests.tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Rappels	invoice.payment_requests.reminders	array of object
Identificateur d’utilisateur	invoice.payment_requests.reminders.uid	string	ID affecté par carré.
Jours planifiés relatifs	invoice.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoice.payment_requests.reminders.message	string	Message.
Statut	invoice.payment_requests.reminders.status	string	État actuel.
Montant	invoice.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoice.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoice.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Numéro de facture	invoice.invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	invoice.title	string	Titre.
Descriptif	invoice.description	string	Description.
Planifié à	invoice.scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
Statut	invoice.status	string	État de vérification actuel de cet objet.
Timezone	invoice.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoice.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	invoice.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de client	invoice.primary_recipient.customer_id	string	ID du client associé à la commande.
Prénom	invoice.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoice.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoice.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoice.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Card	invoice.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoice.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoice.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoice.custom_fields	array of object
Étiquette	invoice.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoice.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoice.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture.
Méthode de remise	invoice.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Date de vente ou de service	invoice.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Annuler le paiement

ID d’opération :: PaymentCancel

Annule (voids) un paiement. Vous pouvez utiliser ce point de terminaison pour annuler un paiement avec l’état APPROUVÉ.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de paiement	payment_id	True	string	Identificateur du paiement.

Retours

Nom	Chemin d’accès	Type	Description
ID	payment.id	string	Identificateur unique émis par carré.
Créé à	payment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	payment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	payment.amount_money.amount	integer	Montant.
Monnaie	payment.amount_money.currency	string	La devise.
Montant	payment.tip_money.amount	integer	Montant.
Monnaie	payment.tip_money.currency	string	La devise.
Statut	payment.status	string	État de vérification actuel de cet objet.
Durée du délai	payment.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement. Cette delay_action automatique s’applique uniquement aux paiements qui n’atteignent pas un état terminal (TERMINÉ, ANNULÉ ou FAILED) avant la période de delay_duration. Ce champ est spécifié sous forme de durée, au format RFC 3339.
Type de Source	payment.source_type	string	Type de source pour ce paiement. Les valeurs actuelles incluent CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Statut	payment.card_details.status	string	État actuel.
Marque de carte	payment.card_details.card.card_brand	string	La marque de la carte.
Dernier 4	payment.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payment.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payment.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payment.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payment.card_details.card.card_type	string	Type de la carte.
Type prépayé	payment.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payment.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Entry, méthode	payment.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État du CVV	payment.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État AVS	payment.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payment.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payment.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payment.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
Voided At	payment.card_details.card_payment_timeline.voided_at	string	Horodatage lorsque le paiement a été annulé, au format RFC 3339.
ID d’emplacement	payment.location_id	string	Identificateur de l’emplacement.
ID de commande	payment.order_id	string	ID de l’ordre.
Créé à	payment.risk_evaluation.created_at	string	Horodatage lors de la création, au format RFC 3339.
Niveau de risque	payment.risk_evaluation.risk_level	string	Niveau de risque associé au paiement.
Note	payment.note	string	Note personnalisée associée au profil client.
ID de client	payment.customer_id	string	ID de cet objet représentant le client.
Montant	payment.total_money.amount	integer	Montant.
Monnaie	payment.total_money.currency	string	La devise.
Montant	payment.approved_money.amount	integer	Montant.
Monnaie	payment.approved_money.currency	string	La devise.
Action de retard	payment.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payment.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
Produit carré	payment.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payment.application_details.application_id	string	ID carré en lecture seule affecté à l’application.
Jeton de version	payment.version_token	string	Ce jeton opaque identifie une version spécifique de l’objet.

Annuler le paiement par clé d’idempotency

ID d’opération :: PaymentCancelIdempotency

Annule (voids) un paiement identifié par la clé d’idempotency spécifiée dans la demande. Utilisez cette méthode lorsque l’état d’une demande CreatePayment est inconnu (par exemple, après avoir envoyé une demande CreatePayment, une erreur réseau se produit et que vous n’obtenez pas de réponse). Dans ce cas, vous pouvez diriger Square pour annuler le paiement à l’aide de ce point de terminaison. Dans la demande, vous fournissez la même clé d’idempotency que celle que vous avez fournie dans votre demande CreatePayment que vous souhaitez annuler. Après avoir annulé le paiement, vous pouvez à nouveau soumettre votre demande CreatePayment. Notez que si aucun paiement avec la clé d’idempotency spécifiée est trouvé, aucune action n’est effectuée et le point de terminaison retourne correctement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

response: object

Annuler le remboursement du terminal

ID d’opération :: TerminalCancelRefund

Annule une demande de remboursement d’un terminal De Débogage par ID de demande de remboursement si l’état de la demande l’autorise.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de remboursement du terminal	terminal_refund_id	True	string	Identificateur du remboursement du terminal.

Retours

Nom	Chemin d’accès	Type	Description
ID	refund.id	string	Identificateur unique émis par carré.
ID de paiement	refund.payment_id	string	ID unique du paiement.
Montant	refund.amount_money.amount	integer	Montant.
Monnaie	refund.amount_money.currency	string	La devise.
Reason	refund.reason	string	Raison de cet objet.
ID d’appareil	refund.device_id	string	ID unique de l’appareil destiné à ce TerminalRefund.
Durée de l’échéance	refund.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Statut	refund.status	string	État de vérification actuel de cet objet.
Annuler la raison	refund.cancel_reason	string	Raison de la transaction annulée.
Créé à	refund.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	refund.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	refund.app_id	string	ID de l’application qui a créé l’extraction.
Marque de carte	refund.card.card_brand	string	Marque de la carte.
last_4	refund.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	refund.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	refund.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	refund.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	refund.card.card_type	string	Type de la carte.
POUBELLE	refund.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
ID de commande	refund.order_id	string	ID de l’ordre.
ID d’emplacement	refund.location_id	string	Identificateur de l’emplacement.

Annuler l’abonnement

ID d’opération :: SubscriptionCancel

Définit le champ canceled_date à la fin de la période de facturation active. Après cette date, l’état passe d’ACTIVE à CANCELED.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Identifiant d’abonnement	subscription_id	True	string	Identificateur de l’abonnement.

Retours

Nom	Chemin d’accès	Type	Description
ID	subscription.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscription.location_id	string	Identificateur de l’emplacement.
ID plan	subscription.plan_id	string	ID du plan d’abonnement associé.
ID de client	subscription.customer_id	string	ID de cet objet représentant le client.
ID de carte	subscription.card_id	string	ID de la carte client facturée pour l’abonnement.
Date de début	subscription.start_date	string	Date de début de l’abonnement, au format aaaa-MM-DD.
Date annulée	subscription.canceled_date	string	Date d’annulation de l’abonnement, au format aaaa-MM-DD.
Payé jusqu’à la date	subscription.paid_until_date	string	Date payée jusqu’à ce que.
Statut	subscription.status	string	État de vérification actuel de cet objet.
Créé à	subscription.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Version	subscription.version	integer	Version actuelle de cet objet.
Timezone	subscription.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscription.source.name	string	Nom.

Annuler l’extraction du terminal

ID d’opération :: TerminalCancelCheckout

Annule une demande d’extraction de terminal si l’état de la demande l’autorise.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’extraction	checkout_id	True	string	Identificateur de l’extraction.

Retours

Nom	Chemin d’accès	Type	Description
ID	checkout.id	string	Identificateur unique émis par carré.
Montant	checkout.amount_money.amount	integer	Montant.
Monnaie	checkout.amount_money.currency	string	La devise.
ID de référence	checkout.reference_id	string	ID de référence facultatif défini par l’utilisateur.
ID d’appareil	checkout.device_options.device_id	string	ID unique de l’appareil destiné à ce TerminalCheckout.
Autoriser le basculement	checkout.device_options.tip_settings.allow_tipping	boolean	Indique si le basculement est activé pour cette caisse. La valeur par défaut est false.
Ignorer l’écran de réception	checkout.device_options.skip_receipt_screen	boolean	Indique à l’appareil d’ignorer l’écran de réception. La valeur par défaut est false.
Statut	checkout.status	string	État de vérification actuel de cet objet.
Annuler la raison	checkout.cancel_reason	string	Raison de la transaction annulée.
Créé à	checkout.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	checkout.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	checkout.app_id	string	ID de l’application qui a créé l’extraction.
Durée de l’échéance	checkout.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création

Calculer l’ordre (bêta)

ID d’opération :: OrderCalculate

Permet aux applications d’afficher un aperçu des tarifs des commandes sans créer de commande.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID d’emplacement	location_id	string	Identificateur de l’emplacement.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage	percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Scope	scope	string	Indique le niveau actuel.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Quantité	quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.

Retours

Nom	Chemin d’accès	Type	Description
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Éléments de ligne	order.line_items	array of object
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Montant	order.line_items.variation_total_price_money.amount	integer	Montant.
Monnaie	order.line_items.variation_total_price_money.currency	string	La devise.
Remises appliquées	order.line_items.applied_discounts	array of object
Identificateur d’utilisateur	order.line_items.applied_discounts.uid	string	ID affecté par carré.
UID de remise	order.line_items.applied_discounts.discount_uid	string	Uid de la remise que représente la remise appliquée.
Montant	order.line_items.applied_discounts.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_discounts.applied_money.currency	string	La devise.
Remises	order.discounts	array of object
Identificateur d’utilisateur	order.discounts.uid	string	ID généré par carré.
Nom	order.discounts.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage	order.discounts.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.discounts.applied_money.amount	integer	Montant.
Monnaie	order.discounts.applied_money.currency	string	La devise.
Type	order.discounts.type	string	Indique le type.
Scope	order.discounts.scope	string	Indique le niveau actuel.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
État	order.state	string	État actuel.
Version	order.version	integer	Version actuelle de cet objet.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Montant	order.total_tip_money.amount	integer	Montant.
Monnaie	order.total_tip_money.currency	string	La devise.
Montant	order.total_money.amount	integer	Montant.
Monnaie	order.total_money.currency	string	La devise.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.tip_money.amount	integer	Montant.
Monnaie	order.net_amounts.tip_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.

Cartes de liste

ID d’opération :: CardList

Récupère une liste de cartes détenues par le compte qui effectue la demande.

Paramètres

Nom	Clé	Type	Description
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
ID de client	customer_id	string	Limitez les résultats aux cartes associées au client fourni. Par défaut, toutes les cartes détenues par le marchand sont retournées.
Inclure désactivé	include_disabled	boolean	Inclut les cartes désactivées. Par défaut, toutes les cartes activées appartenant au marchand sont retournées.
ID de référence	reference_id	string	Limitez les résultats aux cartes associées au reference_id fourni.
Ordre de tri	sort_order	string	Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.

Retours

Nom	Chemin d’accès	Type	Description
Cards	cards	array of object
ID	cards.card.id	string	Identificateur de l’objet
Ligne d’adresse 1	cards.card.billing_address.address_line_1	string	Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	cards.card.billing_address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	cards.card.billing_address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	cards.card.billing_address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	cards.card.billing_address.postal_code	string	Code postal de l’adresse.
Pays	cards.card.billing_address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Empreinte digitale	cards.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
POUBELLE	cards.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Marque de carte	cards.card.card_brand	string	La marque de la carte.
Type de carte	cards.card.card_type	string	Type de la carte.
Nom du titulaire de carte	cards.card.cardholder_name	string	Nom du titulaire de carte.
ID de client	cards.card.customer_id	string	ID d’un client à associer à la carte.
Enabled	cards.card.enabled	boolean	Indique si un objet peut être utilisé ou non.
Mois d’expiration	cards.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’expiration	cards.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Dernier 4	cards.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Type prépayé	cards.card.prepaid_type	string	Indique si la carte est prépayée ou non.
ID de référence	cards.card.reference_id	string	ID de référence facultatif défini par l’utilisateur qui associe cette carte à une autre entité dans un système externe.
Version	cards.card.version	integer	Numéro de version actuel de la carte. Incrémente avec chaque mise à jour de carte. Les demandes de mise à jour d’un objet Card existant sont rejetées, sauf si la version de la demande correspond à la version actuelle de la carte.

Commandes de recherche

ID d’opération :: OrderSearch

Recherchez toutes les commandes pour un ou plusieurs emplacements. Les commandes incluent toutes les ventes, les retours et les échanges, indépendamment de la façon ou du moment où ils sont entrés dans l’écosystème Square (par exemple, point de vente, factures et API Connect).

Paramètres

Nom	Clé	Type	Description
Retour d’entrées	return_entries	boolean	Valeur booléenne qui contrôle le format des résultats de la recherche. Si la valeur est true, SearchOrders retourne des objets OrderEntry. Si la valeur est false, SearchOrders retourne des objets de commande complets.
Limit	limit	integer	Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.
ID d’emplacement	location_ids	array of string
Démarrer à	start_at	string	Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps démarre.
Fin à	end_at	string	Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps se termine.
States	states	array of string
Trier le champ	sort_field	string	Champ à trier.
Ordre de tri	sort_order	string	Ordre chronologique dans lequel les résultats sont retournés.

Retours

Nom	Chemin d’accès	Type	Description
Entrées de commande	order_entries	array of object
ID de commande	order_entries.order_id	string	ID de l’ordre.
ID d’emplacement	order_entries.location_id	string	Identificateur de l’emplacement.
Version	order_entries.version	integer	Version actuelle de l’objet.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Commandes de récupération par lots

ID d’opération :: OrderBatchRetrieve

Récupère un ensemble de commandes par leurs ID. S’il n’existe pas d’ID d’ordre donné, l’ID est ignoré au lieu de générer une erreur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’emplacement	location_id		string	Identificateur d’emplacement.
ID de commande	order_ids		array of string

Retours

Nom	Chemin d’accès	Type	Description
Ordres	orders	array of object
ID	orders.id	string	Identificateur unique émis par carré.
ID d’emplacement	orders.location_id	string	Identificateur de l’emplacement.
ID de référence	orders.reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
Éléments de ligne	orders.line_items	array of object
Identificateur d’utilisateur	orders.line_items.uid	string	ID généré par carré de la demande de paiement dans une facture.
Nom	orders.line_items.name	string	Nom lisible par l’homme.
Quantité	orders.line_items.quantity	string	Quantité achetée, mise en forme sous forme de nombre décimal.
Montant	orders.line_items.base_price_money.amount	integer	Montant.
Monnaie	orders.line_items.base_price_money.currency	string	La devise.
Montant	orders.line_items.total_money.amount	integer	Montant.
Monnaie	orders.line_items.total_money.currency	string	La devise.
Montant	orders.total_money.amount	integer	Montant.
Monnaie	orders.total_money.currency	string	La devise.

Créer un abonnement

ID d’opération :: SubscriptionCreate

Crée un abonnement pour un client à un plan d’abonnement. Si vous fournissez une carte dans la demande, Square facture la carte de l’abonnement. Sinon, Square facture une facture à l’adresse e-mail du client. L’abonnement démarre immédiatement, sauf si la demande inclut la start_date facultative. Chaque abonnement individuel est associé à un emplacement particulier.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID d’emplacement	location_id	string	Identificateur d’emplacement.
ID plan	plan_id	string	ID du plan d’abonnement créé à l’aide de l’API catalogue.
ID de client	customer_id	string	ID du client à lier.
ID de carte	card_id	string	ID de la carte client à facturer.
Date de début	start_date	string	Date de début de l’abonnement, au format aaaa-MM-DD.
Pourcentage fiscal	tax_percentage	string	Taxe à ajouter lors de la facturation de l’abonnement.
Montant	amount	integer	Montant de l’argent à accepter pour ce paiement, sans inclure tip_money.
Monnaie	currency	string	Code monétaire ISO 4217 à 3 caractères.
Timezone	timezone	string	Fuseau horaire utilisé dans les calculs de date pour l’abonnement.
Nom	name	string	Nom de l’objet.

Retours

Nom	Chemin d’accès	Type	Description
ID	subscription.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscription.location_id	string	Identificateur de l’emplacement.
ID plan	subscription.plan_id	string	ID du plan d’abonnement associé.
ID de client	subscription.customer_id	string	ID de cet objet représentant le client.
Date de début	subscription.start_date	string	Date de début de l’abonnement, au format aaaa-MM-DD.
Statut	subscription.status	string	État de vérification actuel de cet objet.
Pourcentage fiscal	subscription.tax_percentage	string	Montant fiscal appliqué lors de la facturation de l’abonnement.
Montant	subscription.price_override_money.amount	integer	Montant.
Monnaie	subscription.price_override_money.currency	string	La devise.
Version	subscription.version	integer	Version actuelle de cet objet.
Créé à	subscription.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
ID de carte	subscription.card_id	string	ID de la carte client facturée pour l’abonnement.
Timezone	subscription.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscription.source.name	string	Nom.

Créer un client

ID d’opération :: CustomerCreate

Crée un client pour une entreprise.

Paramètres

Nom	Clé	Type	Description
Prénom	given_name	string	Nom donné (c’est-à-dire le prénom) associé au profil client.
Nom de famille	family_name	string	Nom de famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	email_address	string	Adresse e-mail associée au profil client.
Nom de l’entreprise	company_name	string	Nom d’entreprise associé au profil client.
Nickname	nickname	string	Surnom du profil client.
Ligne d’adresse 1	address_line_1	string	Première ligne de l’adresse.
Ligne d’adresse 2	address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	postal_code	string	Code postal de l’adresse.
Pays	country	string	Code pays ISO 3166 Alpha-2.
Numéro de téléphone	phone_number	string	Numéro de téléphone à 11 chiffres associé au profil client.
ID de référence	reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
Note	note	string	Note personnalisée associée au profil client.
Anniversaire	birthday	string	Anniversaire associé au profil client, au format RFC 3339. L’année est facultative. Le fuseau horaire et l’heure ne sont pas autorisés. Par exemple, 0000-09-21T00:00:00-00:00 représente un anniversaire le 21 septembre 1998-09-21T00:00:00-00:00 représente un anniversaire le 21 septembre 1998. Vous pouvez également spécifier cette valeur au format aaaa-MM-DD.

Retours

Nom	Chemin d’accès	Type	Description
ID	customer.id	string	Identificateur unique émis par carré.
Créé à	customer.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	customer.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Prénom	customer.given_name	string	Nom donné (c.-à-d. prénom) associé au profil client.
Nom de famille	customer.family_name	string	Nom de la famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	customer.email_address	string	Adresse e-mail associée au profil client.
Nom de l’entreprise	customer.company_name	string	Nom d’entreprise associé au profil client.
Nickname	customer.nickname	string	Surnom du profil client.
Ligne d’adresse 1	customer.address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	customer.address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	customer.address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	customer.address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	customer.address.postal_code	string	Code postal de l’adresse.
Pays	customer.address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Numéro de téléphone	customer.phone_number	string	Numéro de téléphone à 11 chiffres associé au profil client.
ID de référence	customer.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Note	customer.note	string	Note personnalisée associée au profil client.
Anniversaire	customer.birthday	string	Anniversaire associé au profil client, au format RFC 3339. L’année est facultative. Le fuseau horaire et l’heure ne sont pas autorisés. Par exemple, 0000-09-21T00:00:00-00:00 représente un anniversaire le 21 septembre 1998-09-21T00:00:00-00:00 représente un anniversaire le 21 septembre 1998.
E-mail désinscription	customer.preferences.email_unsubscribed	boolean	Indique si le client s’est désinscrit des e-mails de campagne marketing. La valeur true signifie que le client a choisi de refuser le marketing par e-mail du vendeur square actuel ou de tous les vendeurs Square.
Source de création	customer.creation_source	string	Une source de création représente la méthode utilisée pour créer le profil client.
Version	customer.version	integer	Version actuelle de cet objet.

Créer un extraction de terminal

ID d’opération :: TerminalCreateCheckout

Crée une demande de paiement terminal et l’envoie à l’appareil spécifié pour prendre un paiement pour le montant demandé.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.
ID de référence	reference_id	string	ID de référence facultatif défini par l’utilisateur.
ID d’appareil	device_id	string	ID unique de l’appareil destiné à ce TerminalCheckout.
Note	note	string	Note personnalisée associée au profil client.

Retours

Nom	Chemin d’accès	Type	Description
ID	checkout.id	string	Identificateur unique émis par carré.
Montant	checkout.amount_money.amount	integer	Montant.
Monnaie	checkout.amount_money.currency	string	La devise.
ID de référence	checkout.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Note	checkout.note	string	Note personnalisée associée au profil client.
ID d’appareil	checkout.device_options.device_id	string	ID unique de l’appareil destiné à ce TerminalCheckout.
Autoriser le basculement	checkout.device_options.tip_settings.allow_tipping	boolean	Indique si le basculement est activé pour cette caisse. La valeur par défaut est false.
Ignorer l’écran de réception	checkout.device_options.skip_receipt_screen	boolean	Indique à l’appareil d’ignorer l’écran de réception. La valeur par défaut est false.
Statut	checkout.status	string	État de vérification actuel de cet objet.
Créé à	checkout.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	checkout.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	checkout.app_id	string	ID de l’application qui a créé l’extraction.
Durée de l’échéance	checkout.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Type de paiement	checkout.payment_type	string	Le type de paiement à partir duquel le terminal doit tenter de capturer. La valeur par défaut est CARD_PRESENT.

Créer un groupe de clients

ID d’opération :: CustomGroupCreate

Crée un groupe de clients pour une entreprise.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom	name		string	Nom de l’objet.

Retours

Nom	Chemin d’accès	Type	Description
ID	group.id	string	Identificateur unique émis par carré.
Nom	group.name	string	Nom de l’objet.
Créé à	group.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	group.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Créer un paiement

ID d’opération :: PaymentCreate

Crée un paiement à l’aide de la source fournie. Vous pouvez utiliser ce point de terminaison pour facturer une carte (carte de crédit/débit ou carte cadeau Square) ou enregistrer un paiement que le vendeur a reçu en dehors de Square (paiement en espèces d’un acheteur ou d’un paiement qu’une entité externe a traitée pour le compte du vendeur).

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Montant	amount	integer	Montant de l’argent à accepter pour ce paiement, sans inclure tip_money.
Monnaie	currency	string	Code monétaire ISO 4217 à 3 caractères.
Source ID	source_id	string	ID de la source de fonds pour ce paiement. Il peut s’agir d’un jeton de paiement (carte nonce) généré par le formulaire de paiement Square ou une carte sur un fichier effectué avec l’API Clients. Si vous enregistrez un paiement que le vendeur a reçu en dehors de Square, spécifiez CASH ou EXTERNAL.
Autocomplétion	autocomplete	boolean	Si la valeur est true, ce paiement est effectué lorsque cela est possible. Si la valeur est false, ce paiement est conservé dans un état approuvé jusqu’à ce qu’il soit explicitement terminé (capturé) ou annulé (annulé).
ID de client	customer_id	string	ID du client à lier.
ID d’emplacement	location_id	string	Identificateur d’emplacement.
ID de référence	reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
Note	note	string	Note personnalisée associée au profil client.
Montant	amount	integer	Montant de l’argent à accepter pour ce paiement, sans inclure tip_money.
Monnaie	currency	string	Code monétaire ISO 4217 à 3 caractères.

Retours

Nom	Chemin d’accès	Type	Description
ID	payment.id	string	Identificateur unique émis par carré.
Créé à	payment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	payment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	payment.amount_money.amount	integer	Montant.
Monnaie	payment.amount_money.currency	string	La devise.
Montant	payment.app_fee_money.amount	integer	Montant.
Monnaie	payment.app_fee_money.currency	string	La devise.
Statut	payment.status	string	État de vérification actuel de cet objet.
Durée du délai	payment.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement. Cette delay_action automatique s’applique uniquement aux paiements qui n’atteignent pas un état terminal (TERMINÉ, ANNULÉ ou FAILED) avant la période de delay_duration. Ce champ est spécifié sous forme de durée, au format RFC 3339.
Type de Source	payment.source_type	string	Type de source pour ce paiement. Les valeurs actuelles incluent CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Statut	payment.card_details.status	string	État actuel.
Marque de carte	payment.card_details.card.card_brand	string	La marque de la carte.
Dernier 4	payment.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payment.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payment.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payment.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payment.card_details.card.card_type	string	Type de la carte.
Type prépayé	payment.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payment.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Entry, méthode	payment.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État du CVV	payment.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État AVS	payment.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payment.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payment.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payment.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
Capturé à	payment.card_details.card_payment_timeline.captured_at	string	Horodatage lorsque le paiement a été capturé, au format RFC 3339.
ID d’emplacement	payment.location_id	string	Identificateur de l’emplacement.
ID de commande	payment.order_id	string	ID de l’ordre.
ID de référence	payment.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Créé à	payment.risk_evaluation.created_at	string	Horodatage lors de la création, au format RFC 3339.
Niveau de risque	payment.risk_evaluation.risk_level	string	Niveau de risque associé au paiement.
Note	payment.note	string	Note personnalisée associée au profil client.
ID de client	payment.customer_id	string	ID de cet objet représentant le client.
Montant	payment.total_money.amount	integer	Montant.
Monnaie	payment.total_money.currency	string	La devise.
Montant	payment.approved_money.amount	integer	Montant.
Monnaie	payment.approved_money.currency	string	La devise.
Numéro de reçu	payment.receipt_number	string	Numéro de reçu du paiement. Le champ est manquant si un paiement est annulé.
URL de réception	payment.receipt_url	string	URL du reçu du paiement. Le champ est renseigné uniquement pour les paiements TERMINÉs.
Action de retard	payment.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payment.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
Produit carré	payment.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payment.application_details.application_id	string	ID carré en lecture seule affecté à l’application.
Jeton de version	payment.version_token	string	Ce jeton opaque identifie une version spécifique de l’objet.

Créer un remboursement de terminal

ID d’opération :: TerminalCreateRefund

Crée une demande de remboursement d’un paiement Effectué sur un terminal Square.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.
ID d’appareil	device_id	string	ID unique de l’appareil destiné à ce TerminalRefund.
Reason	reason	string	Raison de cet objet.
ID de paiement	payment_id	string	ID unique du paiement.

Retours

Nom	Chemin d’accès	Type	Description
ID	refund.id	string	Identificateur unique émis par carré.
ID de paiement	refund.payment_id	string	ID unique du paiement.
Montant	refund.amount_money.amount	integer	Montant.
Monnaie	refund.amount_money.currency	string	La devise.
Reason	refund.reason	string	Raison de cet objet.
ID d’appareil	refund.device_id	string	ID unique de l’appareil destiné à ce TerminalRefund.
Durée de l’échéance	refund.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Statut	refund.status	string	État de vérification actuel de cet objet.
Créé à	refund.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	refund.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	refund.app_id	string	ID de l’application qui a créé l’extraction.
Marque de carte	refund.card.card_brand	string	Marque de la carte.
last_4	refund.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	refund.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	refund.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	refund.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	refund.card.card_type	string	Type de la carte.
POUBELLE	refund.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
ID de commande	refund.order_id	string	ID de l’ordre.
ID d’emplacement	refund.location_id	string	Identificateur de l’emplacement.

Créer un texte de preuve de litige

ID d’opération :: DisputeCreateEvidenceText

Charge le texte à utiliser comme preuve pour un litige.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.
Type de preuve	evidence_type		string	Type de preuve que vous chargez.
Texte de preuve	evidence_text		string	Chaîne de preuve.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom	Chemin d’accès	Type	Description
ID	evidence.id	string	Identificateur unique émis par carré.
ID de litige	evidence.dispute_id	string	L’ID du différend dont la preuve est associée.
Texte de preuve	evidence.evidence_text	string	Texte brut.
Type de preuve	evidence.evidence_type	string	Type pf evidence.
Chargé à l’adresse	evidence.uploaded_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.

Créer une carte

ID d’opération :: CardCreate

Ajoute une carte sur un fichier à un marchand existant.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Clé d’idempotency.
Source ID	source_id	string	Identificateur de la source.
Ligne d’adresse 1	address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	postal_code	string	Code postal de l’adresse.
Pays	country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Nom du titulaire de carte	cardholder_name	string	Nom du titulaire de carte.
ID de client	customer_id	string	ID de cet objet représentant le client.
ID de référence	reference_id	string	ID de référence facultatif défini par l’utilisateur.

Retours

Nom	Chemin d’accès	Type	Description
ID	card.id	string	Identificateur unique émis par carré.
Ligne d’adresse 1	card.billing_address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	card.billing_address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	card.billing_address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	card.billing_address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	card.billing_address.postal_code	string	Code postal de l’adresse.
Pays	card.billing_address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Empreinte digitale	card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
POUBELLE	card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Marque de carte	card.card_brand	string	La marque de la carte.
Type de carte	card.card_type	string	Type de la carte.
Nom du titulaire de carte	card.cardholder_name	string	Nom du titulaire de carte.
ID de client	card.customer_id	string	ID de cet objet représentant le client.
Enabled	card.enabled	boolean	Indique si cette option est activée.
Mois d’exp	card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Dernier 4	card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Type prépayé	card.prepaid_type	string	Indique si la carte est prépayée ou non.
ID de référence	card.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Version	card.version	integer	Version actuelle de cet objet.

Créer une commande

ID d’opération :: OrderCreate

Crée une commande qui peut inclure des informations sur les produits pour l’achat et les paramètres à appliquer à l’achat.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID de référence	reference_id	string	ID de référence facultatif défini par l’utilisateur.
ID d’emplacement	location_id	string	Identificateur de l’emplacement.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Quantité	quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.
ID d’objet catalogue	catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
ID d’objet catalogue	catalog_object_id	string	ID d’objet catalogue.
UID de remise	discount_uid	string	Uid de la remise que représente la remise appliquée.
Identificateur d’utilisateur	uid	string	ID généré par carré.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage	percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Scope	scope	string	Indique le niveau actuel.
Identificateur d’utilisateur	uid	string	ID généré par carré.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage	percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Scope	scope	string	Indique le niveau actuel.
ID d’objet catalogue	catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.

Retours

Nom	Chemin d’accès	Type	Description
ID	order.id	string	Identificateur unique émis par carré.
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Éléments de ligne	order.line_items	array of object
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Taxes appliquées	order.line_items.applied_taxes	array of object
Identificateur d’utilisateur	order.line_items.applied_taxes.uid	string	ID affecté par carré.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	UID de la taxe pour laquelle cette taxe appliquée représente.
Montant	order.line_items.applied_taxes.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_taxes.applied_money.currency	string	La devise.
Remises appliquées	order.line_items.applied_discounts	array of object
Identificateur d’utilisateur	order.line_items.applied_discounts.uid	string	ID affecté par carré.
UID de remise	order.line_items.applied_discounts.discount_uid	string	Uid de la remise que représente la remise appliquée.
Montant	order.line_items.applied_discounts.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_discounts.applied_money.currency	string	La devise.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Montant	order.line_items.variation_total_price_money.amount	integer	Montant.
Monnaie	order.line_items.variation_total_price_money.currency	string	La devise.
ID d’objet catalogue	order.line_items.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Nom de variante	order.line_items.variation_name	string	Nom de la variante appliquée à cet élément de ligne.
Modificateurs	order.line_items.modifiers	array of object
Identificateur d’utilisateur	order.line_items.modifiers.uid	string	ID affecté par carré.
ID d’objet catalogue	order.line_items.modifiers.catalog_object_id	string	ID d’objet catalogue.
Nom	order.line_items.modifiers.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	order.line_items.modifiers.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.modifiers.base_price_money.currency	string	La devise.
Montant	order.line_items.modifiers.total_price_money.amount	integer	Montant.
Monnaie	order.line_items.modifiers.total_price_money.currency	string	La devise.
Impôts	order.taxes	array of object
Identificateur d’utilisateur	order.taxes.uid	string	ID généré par carré.
Nom	order.taxes.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Type	order.taxes.type	string	Indique le type.
Pourcentage	order.taxes.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.taxes.applied_money.amount	integer	Montant.
Monnaie	order.taxes.applied_money.currency	string	La devise.
Scope	order.taxes.scope	string	Indique le niveau actuel.
Remises	order.discounts	array of object
Identificateur d’utilisateur	order.discounts.uid	string	ID généré par carré.
ID d’objet catalogue	order.discounts.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Nom	order.discounts.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Type	order.discounts.type	string	Indique le type.
Pourcentage	order.discounts.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.discounts.applied_money.amount	integer	Montant.
Monnaie	order.discounts.applied_money.currency	string	La devise.
Scope	order.discounts.scope	string	Indique le niveau actuel.
Montant	order.discounts.amount_money.amount	integer	Montant.
Monnaie	order.discounts.amount_money.currency	string	La devise.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
État	order.state	string	État actuel.
Version	order.version	integer	Version actuelle de cet objet.
ID de référence	order.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Montant	order.total_money.amount	integer	Montant.
Monnaie	order.total_money.currency	string	La devise.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Montant	order.total_tip_money.amount	integer	Montant.
Monnaie	order.total_tip_money.currency	string	La devise.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.tip_money.amount	integer	Montant.
Monnaie	order.net_amounts.tip_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.
Nom	order.source.name	string	Nom.

Créer une facture

ID d’opération :: InvoiceCreate

Crée une facture brouillon pour une commande créée à l’aide de l’API Commandes. Un brouillon de facture reste dans votre compte et aucune action n’est prise. Vous devez publier la facture avant que Square puisse le traiter (l’envoyer à l’adresse e-mail du client ou facturer la carte du client sur le fichier).

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID d’emplacement	location_id	string	Identificateur de l’emplacement.
ID de commande	order_id	string	ID de l’ordre.
Planifié à	scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
ID de client	customer_id	string	ID du client associé à la commande.
Méthode de remise	delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Type de requête	request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Source de paiement automatique	automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Message	message	string	Message.
Jours planifiés relatifs	relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Numéro de facture	invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	title	string	Titre.
Descriptif	description	string	Description.
Card	card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Étiquette	label	string	Étiquette ou titre du champ personnalisé.
Valeur	value	string	Texte du champ personnalisé.
Sélection élective	placement	string	Emplacement du champ personnalisé sur la facture.
Date de vente ou de service	sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Retours

Nom	Chemin d’accès	Type	Description
ID	invoice.id	string	Identificateur unique émis par carré.
Version	invoice.version	integer	Version actuelle de cet objet.
ID d’emplacement	invoice.location_id	string	Identificateur de l’emplacement.
ID de commande	invoice.order_id	string	ID de l’ordre.
Demandes de paiement	invoice.payment_requests	array of object
Identificateur d’utilisateur	invoice.payment_requests.uid	string	ID généré par carré.
Type de requête	invoice.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoice.payment_requests.due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	invoice.payment_requests.tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Rappels	invoice.payment_requests.reminders	array of object
Identificateur d’utilisateur	invoice.payment_requests.reminders.uid	string	ID affecté par carré.
Jours planifiés relatifs	invoice.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoice.payment_requests.reminders.message	string	Message.
Statut	invoice.payment_requests.reminders.status	string	État actuel.
Montant	invoice.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoice.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoice.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Numéro de facture	invoice.invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	invoice.title	string	Titre.
Descriptif	invoice.description	string	Description.
Planifié à	invoice.scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
Statut	invoice.status	string	État de vérification actuel de cet objet.
Timezone	invoice.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoice.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	invoice.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de client	invoice.primary_recipient.customer_id	string	ID du client associé à la commande.
Prénom	invoice.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoice.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoice.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoice.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Card	invoice.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoice.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoice.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoice.custom_fields	array of object
Étiquette	invoice.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoice.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoice.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture.
Méthode de remise	invoice.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Date de vente ou de service	invoice.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Désactiver la carte

ID d’opération :: CardDisable

Désactive la carte, empêchant toute mise à jour ou frais supplémentaires. La désactivation d’une carte déjà désactivée est autorisée, mais n’a aucun effet.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de carte	card_id	True	string	Identificateur de la carte.

Retours

Nom	Chemin d’accès	Type	Description
ID	card.id	string	Identificateur unique émis par carré.
Ligne d’adresse 1	card.billing_address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	card.billing_address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	card.billing_address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	card.billing_address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	card.billing_address.postal_code	string	Code postal de l’adresse.
Pays	card.billing_address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Empreinte digitale	card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
POUBELLE	card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Marque de carte	card.card_brand	string	La marque de la carte.
Type de carte	card.card_type	string	Type de la carte.
Nom du titulaire de carte	card.cardholder_name	string	Nom du titulaire de carte.
ID de client	card.customer_id	string	ID de cet objet représentant le client.
Enabled	card.enabled	boolean	Indique si cette option est activée.
Mois d’exp	card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Dernier 4	card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Type prépayé	card.prepaid_type	string	Indique si la carte est prépayée ou non.
ID de référence	card.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Version	card.version	integer	Version actuelle de cet objet.

Extractions de terminal de recherche

ID d’opération :: TerminalSearchCheckouts

Récupère une liste filtrée des demandes d’extraction de terminal créées par le compte qui effectue la requête.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Limit	limit		integer	Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.
Statut	status		string	État actuel.

Retours

Nom	Chemin d’accès	Type	Description
Caisses	checkouts	array of object
ID	checkouts.id	string	Identificateur unique émis par carré.
Montant	checkouts.amount_money.amount	integer	Montant.
Monnaie	checkouts.amount_money.currency	string	La devise.
ID de référence	checkouts.reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
Note	checkouts.note	string	Note personnalisée associée au profil client.
ID d’appareil	checkouts.device_options.device_id	string	ID unique de l’appareil destiné à ce TerminalCheckout.
Autoriser le basculement	checkouts.device_options.tip_settings.allow_tipping	boolean	Indique si le basculement est activé pour cette caisse. La valeur par défaut est false.
Ignorer l’écran de réception	checkouts.device_options.skip_receipt_screen	boolean	Indique à l’appareil d’ignorer l’écran de réception. La valeur par défaut est false.
Statut	checkouts.status	string	État de vérification actuel de cet objet.
ID de paiement	checkouts.payment_ids	array of string
Créé à	checkouts.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	checkouts.updated_at	string	Horodatage de dernière modification au format RFC 3339
ID d’application	checkouts.app_id	string	ID de l’application qui a créé l’extraction.
Durée de l’échéance	checkouts.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Informations de catalogue

ID d’opération :: CatalogInfo

Récupère des informations sur l’API du catalogue carré, telles que les limites de taille de lot qui peuvent être utilisées par le point de terminaison BatchUpsertCatalogObjects.

Retours

Nom	Chemin d’accès	Type	Description
Objets Max Batch Upsert par lot	limits.batch_upsert_max_objects_per_batch	integer	Nombre maximal d’objets pouvant apparaître dans un lot unique dans une requête /v2/catalog/batch-upsert.
Batch Upsert Max Total Objects	limits.batch_upsert_max_total_objects	integer	Nombre maximal d’objets pouvant apparaître sur tous les lots d’une requête /v2/catalog/batch-upsert.
ID d’objet max de récupération par lots	limits.batch_retrieve_max_object_ids	integer	Nombre maximal d’ID d’objet pouvant apparaître dans une requête /v2/catalog/batch-retrieve.
Nombre maximal de pages de recherche	limits.search_max_page_limit	integer	Nombre maximal de résultats pouvant être retournés dans une page d’une réponse /v2/catalog/search.
ID d’objet Max Delete Batch	limits.batch_delete_max_object_ids	integer	Nombre maximal d’ID d’objet qui peuvent être inclus dans une requête /v2/catalog/batch-delete unique.
Mettre à jour les ID d’élément max.	limits.update_item_taxes_max_item_ids	integer	Nombre maximal d’ID d’élément pouvant être inclus dans une demande /v2/catalog/update-item-taxes unique.
Mettre à jour les taxes maximales sur les éléments pour activer	limits.update_item_taxes_max_taxes_to_enable	integer	Nombre maximal d’ID fiscaux à activer qui peuvent être inclus dans une demande /v2/catalog/update-item-taxes.
Mettre à jour les taxes maximales sur les éléments pour désactiver	limits.update_item_taxes_max_taxes_to_disable	integer	Nombre maximal d’ID fiscaux à désactiver qui peuvent être inclus dans une demande /v2/catalog/update-item-taxes.
Mettre à jour le modificateur d’élément répertorie les ID d’élément max.	limits.update_item_modifier_lists_max_item_ids	integer	Nombre maximal d’ID fiscaux à désactiver qui peuvent être inclus dans une demande /v2/catalog/update-item-taxes.
Mettre à jour les listes de modificateurs d’éléments max pour activer	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Nombre maximal d’ID de liste de modificateurs à activer qui peuvent être inclus dans une requête /v2/catalog/update-item-modificateur-lists.
Mettre à jour le modificateur d’élément répertorie les listes de modificateurs max pour désactiver	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Nombre maximal d’ID de liste de modificateurs à désactiver qui peuvent être inclus dans une requête /v2/catalog/update-item-modificateur-lists.

Inscrire un domaine pour Apple Pay

ID d’opération :: ApplePayRegister

Active un domaine à utiliser avec Apple Pay sur le web et square. Une validation est effectuée sur ce domaine par Apple pour s’assurer qu’elle est correctement configurée en tant que domaine Compatible Apple Pay.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom de domaine	domain_name	True	string	Nom de domaine tel que décrit dans RFC-1034 qui sera inscrit auprès d’Apple Pay.

Retours

Nom	Chemin d’accès	Type	Description
Statut	status	string	État de l’inscription de domaine.

Inventaire des modifications par lots

ID d’opération :: InventoryBatchChange

Applique des ajustements et des nombres aux quantités d’articles fournies. En cas de réussite : retourne le nombre calculé actuel pour tous les objets référencés dans la requête.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Type	type	string	Type de cet objet.
ID de référence	reference_id	string	ID de référence facultatif défini par l’utilisateur qui associe cette carte à une autre entité dans un système externe.
ID d’objet catalogue	catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
État	state	string	État actuel de l’inventaire pour la quantité associée d’éléments.
ID d’emplacement	location_id	string	ID d’emplacement d’un destinataire (autre que le marchand) recevant une partie de cet appel d’offres.
Quantité	quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
ID d’employé	employee_id	string	ID généré par carré de l’employé responsable du nombre physique.
S’est produit à	occurred_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand le nombre physique a été examiné. Pour les mises à jour du nombre physique, l’horodatage occurred_at ne peut pas dépasser 24 heures ou ultérieurement par rapport à l’heure de la requête.
Ignorer les nombres inchangés	ignore_unchanged_counts	boolean	Indique si le nombre physique actuel doit être ignoré si la quantité est inchangée depuis le dernier nombre physique.

Retours

Nom	Chemin d’accès	Type	Description
Compte	counts	array of object
ID d’objet catalogue	counts.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	counts.catalog_object_type	string	Type du CatalogObject en cours de suivi.
État	counts.state	string	État actuel.
ID d’emplacement	counts.location_id	string	Identificateur de l’emplacement.
Quantité	counts.quantity	string	Nombre d’éléments affectés par le nombre estimé sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Calculé à	counts.calculated_at	string	Horodatage au format RFC 3339 qui indique quand le nombre physique ou l’ajustement le plus récent affectant le nombre estimé est reçu.

Lister les preuves de litige

ID d’opération :: DisputeListEvidence

Retourne une liste de preuves associées à un litige.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.

Retours

Nom	Chemin d’accès	Type	Description
Evidence	evidence	array of object
ID	evidence.id	string	Identificateur unique émis par carré.
ID de litige	evidence.dispute_id	string	L’ID du différend dont la preuve est associée.
Texte de preuve	evidence.evidence_text	string	Texte brut.
Type de preuve	evidence.evidence_type	string	Type de la preuve.
Chargé à l’adresse	evidence.uploaded_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.
ID de preuve	evidence.evidence_id	string	ID généré par carré de la preuve.
Filename	evidence.evidence_file.filename	string	Nom de fichier incluant l’extension de fichier
Type de fichier	evidence.evidence_file.filetype	string	Les fichiers de preuve de litige doivent être des formats application/pdf, image/heic, image/heif, image/jpeg, image/png ou image/tiff.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Mettre à jour la facture

ID d’opération :: InvoiceUpdate

Met à jour une facture en modifiant les champs, en désactivant les champs ou les deux.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID facture	invoice_id	True	string	Identificateur de la facture.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Identificateur d’utilisateur	uid		string	ID généré par carré.
Basculement activé	tipping_enabled		boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Champs à effacer	fields_to_clear		array of string

Retours

Nom	Chemin d’accès	Type	Description
ID	invoice.id	string	Identificateur unique émis par carré.
Version	invoice.version	integer	Version actuelle de cet objet.
ID d’emplacement	invoice.location_id	string	Identificateur de l’emplacement.
ID de commande	invoice.order_id	string	ID de l’ordre.
Demandes de paiement	invoice.payment_requests	array of object
Identificateur d’utilisateur	invoice.payment_requests.uid	string	ID généré par carré.
Type de requête	invoice.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoice.payment_requests.due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	invoice.payment_requests.tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Montant	invoice.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoice.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoice.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Numéro de facture	invoice.invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	invoice.title	string	Titre.
Descriptif	invoice.description	string	Description.
Planifié à	invoice.scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
Statut	invoice.status	string	État de vérification actuel de cet objet.
Timezone	invoice.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoice.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	invoice.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de client	invoice.primary_recipient.customer_id	string	ID du client associé à la commande.
Prénom	invoice.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoice.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoice.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoice.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Montant	invoice.next_payment_amount_money.amount	integer	Montant.
Monnaie	invoice.next_payment_amount_money.currency	string	La devise.
Card	invoice.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoice.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoice.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoice.custom_fields	array of object
Étiquette	invoice.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoice.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoice.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture.
Méthode de remise	invoice.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Date de vente ou de service	invoice.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Mettre à jour le groupe de clients

ID d’opération :: CustomerGroupUpdate

Met à jour un groupe de clients.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	group_id	True	string	Identificateur du groupe.
Nom	name		string	Nom de l’objet.

Retours

Nom	Chemin d’accès	Type	Description
ID	group.id	string	Identificateur unique émis par carré.
Nom	group.name	string	Nom de l’objet.
Créé à	group.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	group.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Mettre à jour le paiement

ID d’opération :: PaymentUpdate

Met à jour un paiement avec l’état APPROUVÉ. Vous pouvez mettre à jour les amount_money et les tip_money à l’aide de ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de paiement	payment_id	True	string	Identificateur du paiement.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Montant	amount		integer	Montant.
Monnaie	currency		string	La devise.
Montant	amount		integer	Montant.
Monnaie	currency		string	La devise.
Jeton de version	version_token		string	Ce jeton opaque identifie une version spécifique de l’objet.

Retours

Nom	Chemin d’accès	Type	Description
ID	payment.id	string	Identificateur unique émis par carré.
Créé à	payment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	payment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	payment.amount_money.amount	integer	Montant.
Monnaie	payment.amount_money.currency	string	La devise.
Montant	payment.tip_money.amount	integer	Montant.
Monnaie	payment.tip_money.currency	string	La devise.
Statut	payment.status	string	État de vérification actuel de cet objet.
Durée du délai	payment.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement. Cette delay_action automatique s’applique uniquement aux paiements qui n’atteignent pas un état terminal (TERMINÉ, ANNULÉ ou FAILED) avant la période de delay_duration. Ce champ est spécifié sous forme de durée, au format RFC 3339.
Type de Source	payment.source_type	string	Type de source pour ce paiement. Les valeurs actuelles incluent CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Statut	payment.card_details.status	string	État actuel.
Marque de carte	payment.card_details.card.card_brand	string	La marque de la carte.
Dernier 4	payment.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payment.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payment.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payment.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payment.card_details.card.card_type	string	Type de la carte.
Type prépayé	payment.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payment.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Entry, méthode	payment.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État du CVV	payment.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État AVS	payment.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payment.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payment.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payment.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
ID d’emplacement	payment.location_id	string	Identificateur de l’emplacement.
ID de commande	payment.order_id	string	ID de l’ordre.
Créé à	payment.risk_evaluation.created_at	string	Horodatage lors de la création, au format RFC 3339.
Niveau de risque	payment.risk_evaluation.risk_level	string	Niveau de risque associé au paiement.
Note	payment.note	string	Note personnalisée associée au profil client.
ID de client	payment.customer_id	string	ID de cet objet représentant le client.
Montant	payment.total_money.amount	integer	Montant.
Monnaie	payment.total_money.currency	string	La devise.
Montant	payment.approved_money.amount	integer	Montant.
Monnaie	payment.approved_money.currency	string	La devise.
Capacités	payment.capabilities	array of string
Numéro de reçu	payment.receipt_number	string	Numéro de reçu du paiement. Le champ est manquant si un paiement est annulé.
Action de retard	payment.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payment.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
Produit carré	payment.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payment.application_details.application_id	string	ID carré en lecture seule affecté à l’application.
Jeton de version	payment.version_token	string	Ce jeton opaque identifie une version spécifique de l’objet.

Mettre à jour les listes de modificateurs d’élément

ID d’opération :: CatalogUpdateModifier

Met à jour les objets CatalogModifierList qui s’appliquent à l’objet CatalogItem ciblé sans avoir à effectuer un upsert sur l’élément entier.

Paramètres

Nom	Clé	Type
ID d’élément	item_ids	array of string
Listes de modificateurs à activer	modifier_lists_to_enable	array of string
Listes de modificateurs à désactiver	modifier_lists_to_disable	array of string

Retours

Nom	Chemin d’accès	Type	Description
Mise à jour à	updated_at	string	Horodatage de la base de données de cette mise à jour au format RFC 3339.

Mettre à jour les taxes sur les éléments

ID d’opération :: CatalogUpdateTaxes

Met à jour les objets CatalogTax qui s’appliquent à l’objet CatalogItem ciblé sans avoir à effectuer un upsert sur l’ensemble de l’élément.

Paramètres

Nom	Clé	Type
ID d’élément	item_ids	array of string
Taxes à activer	taxes_to_enable	array of string
Taxes à désactiver	taxes_to_disable	array of string

Retours

Nom	Chemin d’accès	Type	Description
Mise à jour à	updated_at	string	Horodatage de la base de données de cette mise à jour au format RFC 3339.

Mettre à jour un abonnement

ID d’opération :: SubscriptionUpdate

Met à jour un abonnement. Vous pouvez définir, modifier et effacer les valeurs de champ d’abonnement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Identifiant d’abonnement	subscription_id	True	string	Identificateur de l’abonnement.
Version	version		integer	Version actuelle de cet objet.
Pourcentage fiscal	tax_percentage		string	Montant fiscal appliqué lors de la facturation de l’abonnement.
Montant	amount		integer	Montant.
Monnaie	currency		string	La devise.

Retours

Nom	Chemin d’accès	Type	Description
ID	subscription.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscription.location_id	string	Identificateur de l’emplacement.
ID plan	subscription.plan_id	string	ID du plan d’abonnement associé.
ID de client	subscription.customer_id	string	ID de cet objet représentant le client.
Statut	subscription.status	string	État de vérification actuel de cet objet.
Montant	subscription.price_override_money.amount	integer	Montant.
Monnaie	subscription.price_override_money.currency	string	La devise.
Version	subscription.version	integer	Version actuelle de cet objet.
Créé à	subscription.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Timezone	subscription.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscription.source.name	string	Nom.

Mettre à jour un client

ID d’opération :: CustomerUpdate

Met à jour un profil client. Pour modifier un attribut, spécifiez la nouvelle valeur. Pour supprimer un attribut, spécifiez la valeur sous la forme d’une chaîne vide ou d’un objet vide.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de client	customer_id	True	string	Identificateur du client.

Retours

Nom	Chemin d’accès	Type	Description
ID	customer.id	string	Identificateur unique émis par carré.
Créé à	customer.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	customer.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Prénom	customer.given_name	string	Nom donné (c.-à-d. prénom) associé au profil client.
Nom de famille	customer.family_name	string	Nom de la famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	customer.email_address	string	Adresse e-mail associée au profil client.
Ligne d’adresse 1	customer.address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	customer.address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	customer.address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	customer.address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	customer.address.postal_code	string	Code postal de l’adresse.
Pays	customer.address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
ID de référence	customer.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Note	customer.note	string	Note personnalisée associée au profil client.
E-mail désinscription	customer.preferences.email_unsubscribed	boolean	Indique si le client s’est désinscrit des e-mails de campagne marketing. La valeur true signifie que le client a choisi de refuser le marketing par e-mail du vendeur square actuel ou de tous les vendeurs Square.
Source de création	customer.creation_source	string	Une source de création représente la méthode utilisée pour créer le profil client.
Version	customer.version	integer	Version actuelle de cet objet.

Nombres d’inventaire de récupération par lots

ID d’opération :: InventoryBatchRetrieveCounts

Retourne les nombres actuels pour les CatalogObjects fournis aux emplacements demandés.

Paramètres

Nom	Clé	Type	Description
ID d’objet catalog	catalog_object_ids	array of string
ID d’emplacement	location_ids	array of string
Mise à jour après	updated_after	string	Filtre pour retourner les résultats avec leur valeur calculated_at après l’heure donnée spécifiée dans un horodatage RFC 3339.

Retours

Nom	Chemin d’accès	Type	Description
Compte	counts	array of object
ID d’objet catalogue	counts.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	counts.catalog_object_type	string	Type du CatalogObject en cours de suivi.
État	counts.state	string	État actuel.
ID d’emplacement	counts.location_id	string	Identificateur de l’emplacement.
Quantité	counts.quantity	string	Nombre d’éléments affectés par le nombre estimé sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Calculé à	counts.calculated_at	string	Horodatage au format RFC 3339 qui indique quand le nombre physique ou l’ajustement le plus récent affectant le nombre estimé est reçu.

Objet catalogue Upsert

ID d’opération :: CatalogUpsert

Crée ou met à jour le CatalogObject cible.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID	id	string	Identificateur unique émis par carré.
Type	type	string	Type de cet objet.
Abbreviation	abbreviation	string	Texte de l’étiquette d’affichage de l’élément dans l’application Square Point of Sale. Seuls les cinq premiers caractères de la chaîne sont utilisés. Cet attribut peut faire l’objet d’une recherche et sa longueur de valeur est de points de code Unicode.
Descriptif	title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Nom	name	string	Nom.
ID	id	string	Identificateur pour référencer cet objet dans le catalogue.
Type	type	string	Type de cet objet.
ID d’élément	item_id	string	ID du CatalogItem associé à cette variante d’élément.
Nom	name	string	Nom de la variante d’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Type de tarification	pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.

Retours

Nom	Chemin d’accès	Type	Description
Type	catalog_object.type	string	Type de cet objet.
ID	catalog_object.id	string	Identificateur unique émis par carré.
Mise à jour à	catalog_object.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Version	catalog_object.version	integer	Version actuelle de cet objet.
Est supprimé	catalog_object.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	catalog_object.item_data.name	string	Nom.
Descriptif	catalog_object.item_data.title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Abbreviation	catalog_object.item_data.abbreviation	string	Texte de l’étiquette d’affichage de l’élément dans l’application Square Point of Sale. Seuls les cinq premiers caractères de la chaîne sont utilisés. Cet attribut peut faire l’objet d’une recherche et sa longueur de valeur est de points de code Unicode.
Variantes	catalog_object.item_data.variations	array of object
Type	catalog_object.item_data.variations.type	string	Type de cet objet.
ID	catalog_object.item_data.variations.id	string	Identificateur pour référencer cet objet dans le catalogue.
Mise à jour à	catalog_object.item_data.variations.updated_at	string	Horodatage de dernière modification au format RFC 3339.
Version	catalog_object.item_data.variations.version	integer	Version de l’objet. Lors de la mise à jour d’un objet, la version fournie doit correspondre à la version de la base de données, sinon l’écriture est rejetée comme étant en conflit.
Est supprimé	catalog_object.item_data.variations.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	catalog_object.item_data.variations.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
ID d’élément	catalog_object.item_data.variations.item_variation_data.item_id	string	ID du CatalogItem associé à cette variante d’élément.
Nom	catalog_object.item_data.variations.item_variation_data.name	string	Nom de la variante d’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Ordinal	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Ordre dans lequel cette variante d’élément doit être affichée. Cette valeur est en lecture seule. Lors des écritures, l’ordinal pour chaque variante d’élément dans un CatalogItem parent est défini en fonction de la position des variantes d’élément. Lors des lectures, la valeur n’est pas garantie comme séquentielle ou unique.
Type de tarification	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Stockable	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Si le stock est compté directement sur cette variation (TRUE) ou uniquement sur ses composants (FALSE). Pour la compatibilité descendante, les valeurs manquantes sont interprétées comme TRUE.
Montant	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Montant.
Monnaie	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	La devise.
Type de produit	catalog_object.item_data.product_type	string	Type de produit de l’élément. Peut ne pas être modifié une fois qu’un élément a été créé.
Mappages d’ID	id_mappings	array of object
ID d’objet client	id_mappings.client_object_id	string	ID temporaire #-préfixe fourni par le client pour un nouvel objet CatalogObject.
ID d’objet	id_mappings.object_id	string	ID permanent créé par le serveur.

Objets catalogue Batch upsert

ID d’opération :: CatalogBatchUpsert

Crée ou met à jour jusqu’à 10 000 objets cibles en fonction de la liste fournie d’objets. Les objets cibles sont regroupés en lots et chaque lot est inséré/mis à jour de manière tout ou rien. Si un objet au sein d’un lot est mal formé d’une certaine manière ou enfreint une contrainte de base de données, le lot entier contenant cet élément sera ignoré. Toutefois, d’autres lots de la même requête peuvent toujours réussir. Chaque lot peut contenir jusqu’à 1 000 objets et les lots seront traités dans l’ordre tant que le nombre total d’objets pour la demande (éléments, variantes, listes de modificateurs, remises et taxes) n’est pas supérieur à 10 000.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Type	type	string	Type de cet objet.
ID	id	string	Identificateur pour référencer cet objet.
Présent à tous les emplacements	present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Descriptif	title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
ID de catégorie	category_id	string	ID de la catégorie de l’élément, le cas échéant.
Numéros d’identification fiscale	tax_ids	array of string
Type	type	string	Type de cet objet. Chaque type d’objet a des propriétés attendues exprimées dans un format structuré dans son champ *_data correspondant ci-dessous.
ID	id	string	Identificateur pour référencer cet objet.
Présent à tous les emplacements	present_at_all_locations	boolean	Indique si elles sont présentes à tous les emplacements.
ID d’élément	item_id	string	Identificateur de l’élément.
Nom	name	string	Nom de l'élément.
Type de tarification	pricing_type	string	Type de tarification.
Montant	amount	integer	Montant.
Monnaie	currency	string	La devise.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Nom	name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Phase de calcul	calculation_phase	string	Indique si la taxe est calculée en fonction du sous-total ou du total d’un paiement.
Type d’inclusion	inclusion_type	string	Que la taxe soit ADDITIVE ou INCLUSIVE.
Pourcentage	percentage	string	Pourcentage de la taxe sous forme décimale, en utilisant un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
S’applique aux montants personnalisés	applies_to_custom_amounts	boolean	Si la valeur est true, les frais s’appliquent aux montants personnalisés entrés dans l’application Square Point of Sale qui ne sont pas associées à un CatalogItem particulier.
Enabled	enabled	boolean	Indicateur booléen pour indiquer si la taxe est activée (true) dans l’application Square Point of Sale ou non (false).

Retours

Nom	Chemin d’accès	Type	Description
Objets	objects	array of object
Type	objects.type	string	Type de cet objet.
ID	objects.id	string	Identificateur unique émis par carré.
Mise à jour à	objects.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.version	integer	Version actuelle de l’objet.
Est supprimé	objects.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	objects.item_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Descriptif	objects.item_data.title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
ID de catégorie	objects.item_data.category_id	string	ID de la catégorie de l’élément, le cas échéant.
Numéros d’identification fiscale	objects.item_data.tax_ids	array of string
Variantes	objects.item_data.variations	array of object
Type	objects.item_data.variations.type	string	Type de cet objet. Chaque type d’objet a des propriétés attendues exprimées dans un format structuré dans son champ *_data correspondant ci-dessous.
ID	objects.item_data.variations.id	string	Identificateur pour référencer cet objet.
Mise à jour à	objects.item_data.variations.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.item_data.variations.version	integer	Version de l’objet. Lors de la mise à jour d’un objet, la version fournie doit correspondre à la version de la base de données, sinon l’écriture est rejetée comme étant en conflit.
Est supprimé	objects.item_data.variations.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.item_data.variations.present_at_all_locations	boolean	Liste des emplacements où l’objet est présent, même si present_at_all_locations est false. Cela peut inclure des emplacements désactivés.
ID d’élément	objects.item_data.variations.item_variation_data.item_id	string	ID de l’objet avec cette variante d’élément.
Nom	objects.item_data.variations.item_variation_data.name	string	Nom de cet élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Ordre dans lequel cette variante d’élément doit être affichée. Cette valeur est en lecture seule.
Type de tarification	objects.item_data.variations.item_variation_data.pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Montant	objects.item_data.variations.item_variation_data.price_money.amount	integer	Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise. Par exemple, lorsque la devise est USD, le montant est en cents. Les montants monétaires peuvent être positifs ou négatifs. Consultez la description de champ spécifique pour déterminer la signification de la connexion dans un cas particulier.
Monnaie	objects.item_data.variations.item_variation_data.price_money.currency	string	Type de devise, au format ISO 4217. Par exemple, le code monétaire pour les dollars américains est USD.
Nom	objects.category_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Nom	objects.tax_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Phase de calcul	objects.tax_data.calculation_phase	string	Indique si la taxe est calculée en fonction du sous-total ou du total d’un paiement.
Type d’inclusion	objects.tax_data.inclusion_type	string	Que la taxe soit ADDITIVE ou INCLUSIVE.
Pourcentage	objects.tax_data.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
S’applique aux montants personnalisés	objects.tax_data.applies_to_custom_amounts	boolean	Si la valeur est true, les frais s’appliquent aux montants personnalisés entrés dans l’application Square Point of Sale qui ne sont pas associées à un CatalogItem particulier.
Enabled	objects.tax_data.enabled	boolean	Indique si un objet peut être utilisé ou non.
Mappages d’ID	id_mappings	array of object
ID d’objet client	id_mappings.client_object_id	string	ID temporaire #-préfixe fourni par le client pour un nouvel objet CatalogObject.
ID d’objet	id_mappings.object_id	string	ID permanent créé par le serveur.

Objets catalogue de suppression par lots

ID d’opération :: CatalogBatchDelete

Supprime un ensemble de CatalogItems en fonction de la liste fournie des ID cibles et retourne un ensemble d’ID supprimés correctement dans la réponse.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d'objet ;	object_ids		array of string

Retours

Nom	Chemin d’accès	Type	Description
ID d’objet supprimés	deleted_object_ids	array of string
Supprimé à	deleted_at	string	Horodatage de la base de données de cette suppression au format RFC 3339

Obtenir la facture

ID d’opération :: InvoiceGet

Récupère une facture par ID de facture.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID facture	invoice_id	True	string	Identificateur de la facture.

Retours

Nom	Chemin d’accès	Type	Description
ID	invoice.id	string	Identificateur unique émis par carré.
Version	invoice.version	integer	Version actuelle de cet objet.
ID d’emplacement	invoice.location_id	string	Identificateur de l’emplacement.
ID de commande	invoice.order_id	string	ID de l’ordre.
Demandes de paiement	invoice.payment_requests	array of object
Identificateur d’utilisateur	invoice.payment_requests.uid	string	ID généré par carré.
Type de requête	invoice.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoice.payment_requests.due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	invoice.payment_requests.tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Rappels	invoice.payment_requests.reminders	array of object
Identificateur d’utilisateur	invoice.payment_requests.reminders.uid	string	ID affecté par carré.
Jours planifiés relatifs	invoice.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoice.payment_requests.reminders.message	string	Message.
Statut	invoice.payment_requests.reminders.status	string	État actuel.
Montant	invoice.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoice.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoice.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Numéro de facture	invoice.invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	invoice.title	string	Titre.
Descriptif	invoice.description	string	Description.
Planifié à	invoice.scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
Statut	invoice.status	string	État de vérification actuel de cet objet.
Timezone	invoice.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoice.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	invoice.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de client	invoice.primary_recipient.customer_id	string	ID du client associé à la commande.
Prénom	invoice.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoice.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoice.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoice.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Card	invoice.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoice.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoice.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoice.custom_fields	array of object
Étiquette	invoice.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoice.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoice.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture.
Méthode de remise	invoice.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Date de vente ou de service	invoice.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Obtenir le paiement

ID d’opération :: PaymentGet

Récupère les détails d’un paiement spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de paiement	payment_id	True	string	Identificateur du paiement.

Retours

Nom	Chemin d’accès	Type	Description
ID	payment.id	string	Identificateur unique émis par carré.
Créé à	payment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	payment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	payment.amount_money.amount	integer	Montant.
Monnaie	payment.amount_money.currency	string	La devise.
Statut	payment.status	string	État de vérification actuel de cet objet.
Durée du délai	payment.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement. Cette delay_action automatique s’applique uniquement aux paiements qui n’atteignent pas un état terminal (TERMINÉ, ANNULÉ ou FAILED) avant la période de delay_duration. Ce champ est spécifié sous forme de durée, au format RFC 3339.
Type de Source	payment.source_type	string	Type de source pour ce paiement. Les valeurs actuelles incluent CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Statut	payment.card_details.status	string	État actuel.
Marque de carte	payment.card_details.card.card_brand	string	La marque de la carte.
Dernier 4	payment.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payment.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payment.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payment.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payment.card_details.card.card_type	string	Type de la carte.
Type prépayé	payment.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payment.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Entry, méthode	payment.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État du CVV	payment.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État AVS	payment.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payment.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payment.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payment.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
Capturé à	payment.card_details.card_payment_timeline.captured_at	string	Horodatage lorsque le paiement a été capturé, au format RFC 3339.
ID d’emplacement	payment.location_id	string	Identificateur de l’emplacement.
ID de commande	payment.order_id	string	ID de l’ordre.
Frais de traitement	payment.processing_fee	array of object
Effectif à	payment.processing_fee.effective_at	string	Horodatage du moment où les frais prennent effet, au format RFC 3339.
Type	payment.processing_fee.type	string	Indique le type.
Montant	payment.processing_fee.amount_money.amount	integer	Montant.
Monnaie	payment.processing_fee.amount_money.currency	string	La devise.
Note	payment.note	string	Note personnalisée associée au profil client.
Montant	payment.total_money.amount	integer	Montant.
Monnaie	payment.total_money.currency	string	La devise.
Montant	payment.approved_money.amount	integer	Montant.
Monnaie	payment.approved_money.currency	string	La devise.
ID d’employé	payment.employee_id	string	ID généré par carré de l’employé.
Numéro de reçu	payment.receipt_number	string	Numéro de reçu du paiement. Le champ est manquant si un paiement est annulé.
URL de réception	payment.receipt_url	string	URL du reçu du paiement. Le champ est renseigné uniquement pour les paiements TERMINÉs.
Action de retard	payment.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payment.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
ID de membre de l’équipe	payment.team_member_id	string	ID du membre de l’équipe.
Produit carré	payment.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payment.application_details.application_id	string	ID carré en lecture seule affecté à l’application.
Jeton de version	payment.version_token	string	Ce jeton opaque identifie une version spécifique de l’objet.

Obtenir le remboursement du paiement

ID d’opération :: RefundGet

Récupère un remboursement spécifique à l’aide du refund_id.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de remboursement	refund_id	True	string	Identificateur du remboursement.

Retours

Nom	Chemin d’accès	Type	Description
ID	refund.id	string	Identificateur unique émis par carré.
Statut	refund.status	string	État de vérification actuel de cet objet.
Montant	refund.amount_money.amount	integer	Montant.
Monnaie	refund.amount_money.currency	string	La devise.
ID de paiement	refund.payment_id	string	ID unique du paiement.
ID de commande	refund.order_id	string	ID de l’ordre.
Créé à	refund.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	refund.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Frais de traitement	refund.processing_fee	array of object
Effectif à	refund.processing_fee.effective_at	string	Horodatage du moment où les frais prennent effet, au format RFC 3339.
Type	refund.processing_fee.type	string	Indique le type.
Montant	refund.processing_fee.amount_money.amount	integer	Montant.
Monnaie	refund.processing_fee.amount_money.currency	string	La devise.
ID d’emplacement	refund.location_id	string	Identificateur de l’emplacement.
Reason	refund.reason	string	Raison de cet objet.

Obtenir le remboursement du terminal

ID d’opération :: TerminalGetRefund

Récupère un objet de remboursement de terminal De Débogage par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de remboursement du terminal	terminal_refund_id	True	string	Identificateur du remboursement du terminal.

Retours

Nom	Chemin d’accès	Type	Description
ID	refund.id	string	Identificateur unique émis par carré.
ID de remboursement	refund.refund_id	string	ID unique de ce remboursement, généré par Square.
ID de paiement	refund.payment_id	string	ID unique du paiement.
Montant	refund.amount_money.amount	integer	Montant.
Monnaie	refund.amount_money.currency	string	La devise.
Reason	refund.reason	string	Raison de cet objet.
ID d’appareil	refund.device_id	string	ID unique de l’appareil destiné à ce TerminalRefund.
Durée de l’échéance	refund.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Statut	refund.status	string	État de vérification actuel de cet objet.
Créé à	refund.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	refund.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	refund.app_id	string	ID de l’application qui a créé l’extraction.
Marque de carte	refund.card.card_brand	string	Marque de la carte.
last_4	refund.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	refund.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	refund.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	refund.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	refund.card.card_type	string	Type de la carte.
POUBELLE	refund.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
ID de commande	refund.order_id	string	ID de l’ordre.
ID d’emplacement	refund.location_id	string	Identificateur de l’emplacement.

Obtenir l’extraction du terminal

ID d’opération :: TerminalGetCheckout

Récupère une demande d’extraction de terminal par checkout_id.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’extraction	checkout_id	True	string	Identificateur de l’extraction.

Retours

Nom	Chemin d’accès	Type	Description
ID	checkout.id	string	Identificateur unique émis par carré.
Montant	checkout.amount_money.amount	integer	Montant.
Monnaie	checkout.amount_money.currency	string	La devise.
ID de référence	checkout.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Note	checkout.note	string	Note personnalisée associée au profil client.
ID d’appareil	checkout.device_options.device_id	string	ID unique de l’appareil destiné à ce TerminalCheckout.
Autoriser le basculement	checkout.device_options.tip_settings.allow_tipping	boolean	Indique si le basculement est activé pour cette caisse. La valeur par défaut est false.
Ignorer l’écran de réception	checkout.device_options.skip_receipt_screen	boolean	Indique à l’appareil d’ignorer l’écran de réception. La valeur par défaut est false.
Statut	checkout.status	string	État de vérification actuel de cet objet.
Créé à	checkout.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	checkout.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID d’application	checkout.app_id	string	ID de l’application qui a créé l’extraction.
Durée de l’échéance	checkout.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création

Ordre de clonage (bêta)

ID d’opération :: OrderClone

Crée un ordre, dans l’état DRAFT, en dupliquant un ordre existant. La commande nouvellement créée contient uniquement les champs principaux (tels que les articles de ligne, les taxes et les remises) copiés à partir de la commande d’origine.

Paramètres

Nom	Clé	Type	Description
ID de commande	order_id	string	Identificateur de l’ordre.
Version	version	integer	Version.
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom	Chemin d’accès	Type	Description
ID	order.id	string	Identificateur unique émis par carré.
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Éléments de ligne	order.line_items	array of object
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Taxes appliquées	order.line_items.applied_taxes	array of object
Identificateur d’utilisateur	order.line_items.applied_taxes.uid	string	ID affecté par carré.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	UID de la taxe pour laquelle cette taxe appliquée représente.
Montant	order.line_items.applied_taxes.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_taxes.applied_money.currency	string	La devise.
Remises appliquées	order.line_items.applied_discounts	array of object
Identificateur d’utilisateur	order.line_items.applied_discounts.uid	string	ID affecté par carré.
UID de remise	order.line_items.applied_discounts.discount_uid	string	Uid de la remise que représente la remise appliquée.
Montant	order.line_items.applied_discounts.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_discounts.applied_money.currency	string	La devise.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Montant	order.line_items.variation_total_price_money.amount	integer	Montant.
Monnaie	order.line_items.variation_total_price_money.currency	string	La devise.
ID d’objet catalogue	order.line_items.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Nom de variante	order.line_items.variation_name	string	Nom de la variante appliquée à cet élément de ligne.
Modificateurs	order.line_items.modifiers	array of object
Identificateur d’utilisateur	order.line_items.modifiers.uid	string	ID affecté par carré.
ID d’objet catalogue	order.line_items.modifiers.catalog_object_id	string	ID d’objet catalogue.
Nom	order.line_items.modifiers.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	order.line_items.modifiers.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.modifiers.base_price_money.currency	string	La devise.
Montant	order.line_items.modifiers.total_price_money.amount	integer	Montant.
Monnaie	order.line_items.modifiers.total_price_money.currency	string	La devise.
Impôts	order.taxes	array of object
Identificateur d’utilisateur	order.taxes.uid	string	ID généré par carré.
Nom	order.taxes.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Type	order.taxes.type	string	Indique le type.
Pourcentage	order.taxes.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.taxes.applied_money.amount	integer	Montant.
Monnaie	order.taxes.applied_money.currency	string	La devise.
Scope	order.taxes.scope	string	Indique le niveau actuel.
Remises	order.discounts	array of object
Identificateur d’utilisateur	order.discounts.uid	string	ID généré par carré.
ID d’objet catalogue	order.discounts.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Nom	order.discounts.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Type	order.discounts.type	string	Indique le type.
Pourcentage	order.discounts.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.discounts.applied_money.amount	integer	Montant.
Monnaie	order.discounts.applied_money.currency	string	La devise.
Scope	order.discounts.scope	string	Indique le niveau actuel.
Montant	order.discounts.amount_money.amount	integer	Montant.
Monnaie	order.discounts.amount_money.currency	string	La devise.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
État	order.state	string	État actuel.
Version	order.version	integer	Version actuelle de cet objet.
ID de référence	order.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Montant	order.total_money.amount	integer	Montant.
Monnaie	order.total_money.currency	string	La devise.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Montant	order.total_tip_money.amount	integer	Montant.
Monnaie	order.total_tip_money.currency	string	La devise.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.tip_money.amount	integer	Montant.
Monnaie	order.net_amounts.tip_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.
Nom	order.source.name	string	Nom.

Ordre de mise à jour (bêta)

ID d’opération :: OrderUpdate

Met à jour un ordre ouvert en ajoutant, en remplaçant ou en supprimant des champs. Les commandes avec un état COMPLETED ou CANCELED ne peuvent pas être mises à jour.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de commande	order_id	True	string	Identificateur de l’ordre.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
Version	version		integer	Version actuelle de cet objet.
Identificateur d’utilisateur	uid		string	ID généré par carré.
Quantité	quantity		string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Nom	name		string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	amount		integer	Montant.
Monnaie	currency		string	La devise.
Champs à effacer	fields_to_clear		array of string

Retours

Nom	Chemin d’accès	Type	Description
Version	order.version	integer	Version actuelle de cet objet.
Monnaie	order.total_money.currency	string	La devise.
Montant	order.total_money.amount	integer	Montant.
Nom	order.source.name	string	Nom.
Éléments de ligne	order.line_items	array of object
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Montant	order.line_items.variation_total_price_money.amount	integer	Montant.
Monnaie	order.line_items.variation_total_price_money.currency	string	La devise.
État	order.state	string	État actuel.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
ID	order.id	string	Identificateur unique émis par carré.
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Ordre de paiement (bêta)

ID d’opération :: OrderPay

Payez pour une commande à l’aide d’un ou plusieurs paiements approuvés ou réglez une commande avec un total de 0. Le total des payment_ids répertoriés dans la demande doit être égal au total de la commande. Les commandes avec un montant total de 0 peuvent être marquées comme payantes en spécifiant un tableau vide de payment_ids dans la demande.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de commande	order_id	True	string	Identificateur de l’ordre.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID de paiement	payment_ids		array of string

Retours

Nom	Chemin d’accès	Type	Description
ID	order.id	string	Identificateur unique émis par carré.
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Éléments de ligne	order.line_items	array of object
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Version	order.version	integer	Version actuelle de cet objet.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Montant	order.total_money.amount	integer	Montant.
Monnaie	order.total_money.currency	string	La devise.
Fermé à	order.closed_at	string	Heure de fermeture, au format ISO 8601.
Offres	order.tenders	array of object
ID	order.tenders.id	string	Identificateur de l’objet
ID d’emplacement	order.tenders.location_id	string	ID d’emplacement d’un destinataire (autre que le marchand) recevant une partie de cet appel d’offres.
Transaction ID	order.tenders.transaction_id	string	ID de la transaction associée à l’appel d’offres.
Créé à	order.tenders.created_at	string	Horodatage lors de la création, au format RFC 3339.
Montant	order.tenders.amount_money.amount	integer	Montant.
Monnaie	order.tenders.amount_money.currency	string	La devise.
Type	order.tenders.type	string	Indique le type.
Statut	order.tenders.card_details.status	string	État actuel du paiement par carte de crédit (tel que AUTORISÉ ou CAPTURÉ)
Marque de carte	order.tenders.card_details.card.card_brand	string	La marque de la carte.
last_4	order.tenders.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	order.tenders.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	order.tenders.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	order.tenders.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Entry, méthode	order.tenders.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour la transaction.
ID de paiement	order.tenders.payment_id	string	ID unique généré par carré du paiement.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.tip_money.amount	integer	Montant.
Monnaie	order.net_amounts.tip_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.
Nom	order.source.name	string	Nom.
État	order.state	string	État actuel.

Paiement complet

ID d’opération :: PaymentComplete

Termine (capture) un paiement. Par défaut, les paiements sont définis pour être terminés immédiatement après leur création.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de paiement	payment_id	True	string	Identificateur du paiement.

Retours

Nom	Chemin d’accès	Type	Description
ID	payment.id	string	Identificateur unique émis par carré.
Créé à	payment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	payment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	payment.amount_money.amount	integer	Montant.
Monnaie	payment.amount_money.currency	string	La devise.
Statut	payment.status	string	État de vérification actuel de cet objet.
Durée du délai	payment.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement. Cette delay_action automatique s’applique uniquement aux paiements qui n’atteignent pas un état terminal (TERMINÉ, ANNULÉ ou FAILED) avant la période de delay_duration. Ce champ est spécifié sous forme de durée, au format RFC 3339.
Type de Source	payment.source_type	string	Type de source pour ce paiement. Les valeurs actuelles incluent CARD, BANK_ACCOUNT, WALLET, CASH ou EXTERNAL.
Statut	payment.card_details.status	string	État actuel.
Marque de carte	payment.card_details.card.card_brand	string	La marque de la carte.
Dernier 4	payment.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payment.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payment.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payment.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payment.card_details.card.card_type	string	Type de la carte.
Type prépayé	payment.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payment.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Entry, méthode	payment.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État du CVV	payment.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État AVS	payment.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payment.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payment.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payment.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
Capturé à	payment.card_details.card_payment_timeline.captured_at	string	Horodatage lorsque le paiement a été capturé, au format RFC 3339.
ID d’emplacement	payment.location_id	string	Identificateur de l’emplacement.
ID de commande	payment.order_id	string	ID de l’ordre.
Frais de traitement	payment.processing_fee	array of object
Effectif à	payment.processing_fee.effective_at	string	Horodatage du moment où les frais prennent effet, au format RFC 3339.
Type	payment.processing_fee.type	string	Indique le type.
Montant	payment.processing_fee.amount_money.amount	integer	Montant.
Monnaie	payment.processing_fee.amount_money.currency	string	La devise.
Note	payment.note	string	Note personnalisée associée au profil client.
Montant	payment.total_money.amount	integer	Montant.
Monnaie	payment.total_money.currency	string	La devise.
Montant	payment.approved_money.amount	integer	Montant.
Monnaie	payment.approved_money.currency	string	La devise.
ID d’employé	payment.employee_id	string	ID généré par carré de l’employé.
Numéro de reçu	payment.receipt_number	string	Numéro de reçu du paiement. Le champ est manquant si un paiement est annulé.
URL de réception	payment.receipt_url	string	URL du reçu du paiement. Le champ est renseigné uniquement pour les paiements TERMINÉs.
Action de retard	payment.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payment.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
ID de membre de l’équipe	payment.team_member_id	string	ID du membre de l’équipe.
Produit carré	payment.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payment.application_details.application_id	string	ID carré en lecture seule affecté à l’application.
Jeton de version	payment.version_token	string	Ce jeton opaque identifie une version spécifique de l’objet.

Publier une facture

ID d’opération :: InvoicePublish

Publie la facture brouillon spécifiée. Une fois qu’une facture est publiée, Square suit la configuration de la facture. Par exemple, Square envoie la facture à l’adresse e-mail du client, facture la carte du client sur le fichier ou ne fait rien. Square rend également la facture disponible sur une page de facture hébergée sur place.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID facture	invoice_id	True	string	Identificateur de la facture.
Version	version		integer	Version.
Clé d’Idempotency	idempotency_key		string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom	Chemin d’accès	Type	Description
ID	invoice.id	string	Identificateur unique émis par carré.
Version	invoice.version	integer	Version actuelle de cet objet.
ID d’emplacement	invoice.location_id	string	Identificateur de l’emplacement.
ID de commande	invoice.order_id	string	ID de l’ordre.
Demandes de paiement	invoice.payment_requests	array of object
Identificateur d’utilisateur	invoice.payment_requests.uid	string	ID généré par carré.
Type de requête	invoice.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoice.payment_requests.due_date	string	Date d’échéance de la demande de paiement, au format aaaa-MM-DD.
Basculement activé	invoice.payment_requests.tipping_enabled	boolean	Si la valeur est true, fournit un emplacement pour que le client paie un pourboire.
Rappels	invoice.payment_requests.reminders	array of object
Identificateur d’utilisateur	invoice.payment_requests.reminders.uid	string	ID affecté par carré.
Jours planifiés relatifs	invoice.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoice.payment_requests.reminders.message	string	Message.
Statut	invoice.payment_requests.reminders.status	string	État actuel.
Montant	invoice.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoice.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoice.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoice.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Numéro de facture	invoice.invoice_number	string	Numéro de facture convivial. La valeur est unique dans un emplacement. S’il n’est pas fourni lors de la création d’une facture, Square affecte une valeur.
Titre	invoice.title	string	Titre.
Descriptif	invoice.description	string	Description.
Planifié à	invoice.scheduled_at	string	Horodatage lorsque le traitement est planifié, au format RFC 3339.
Statut	invoice.status	string	État de vérification actuel de cet objet.
Timezone	invoice.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoice.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	invoice.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de client	invoice.primary_recipient.customer_id	string	ID du client associé à la commande.
Prénom	invoice.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoice.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoice.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoice.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
URL publique	invoice.public_url	string	URL de la page de facture hébergée sur place. Après avoir publié la facture à l’aide du point de terminaison PublishInvoice, Square héberge la page de facture et retourne l’URL de la page dans la réponse.
Card	invoice.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoice.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoice.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoice.custom_fields	array of object
Étiquette	invoice.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoice.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoice.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture.
Méthode de remise	invoice.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client. Une fois la facture publiée, Square traite la facture en fonction du mode de livraison et des paramètres de demande de paiement, soit immédiatement, soit à la date de scheduled_at, si elle est spécifiée.
Date de vente ou de service	invoice.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.

Rechercher des clients

ID d’opération :: CustomerSearch

Recherche les profils clients associés à un compte Square à l’aide d’un filtre de requête pris en charge. L’appel de SearchCustomers sans filtre de requête explicite retourne tous les profils clients classés par ordre alphabétique en fonction de given_name et de family_name.

Paramètres

Nom	Clé	Type	Description
Flou	fuzzy	string	Utilisez le filtre flou pour sélectionner les clients dont les attributs correspondent à la requête spécifiée de manière approximative. Lorsque l’option floue est utilisée, les requêtes de recherche sont tokenisées, puis chaque jeton de requête doit être mis en correspondance quelque part dans l’attribut recherché. Pour les requêtes à jeton unique, il s’agit effectivement du même comportement qu’une opération de correspondance partielle.
Valeurs	values	array of string
Règle	rule	string	Indique si un profil client correspondant aux critères de filtre doit être inclus dans le résultat ou exclu du résultat.
Démarrer à	start_at	string	Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps démarre.
Fin à	end_at	string	Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps se termine.
Tous	all	array of string
Terrain	field	string	Utilisez un ou plusieurs attributs client comme clé de tri pour trier les profils clients recherchés.
JSON	order	string	Indique l’ordre dans lequel les résultats doivent être triés en fonction de la valeur du champ de tri. Les chaînes utilisent une comparaison alphabétique standard pour déterminer l’ordre.
Limit	limit	integer	Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom	Chemin d’accès	Type	Description
Clientèle	customers	array of object
ID	customers.id	string	Identificateur unique émis par carré.
Créé à	customers.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	customers.updated_at	string	Horodatage de dernière modification au format RFC 3339
Prénom	customers.given_name	string	Nom donné (c.-à-d. prénom) associé au profil client.
Nom de famille	customers.family_name	string	Nom de la famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	customers.email_address	string	Adresse e-mail associée au profil client.
Ligne d’adresse 1	customers.address.address_line_1	string	Première ligne de l’adresse.
Ligne d’adresse 2	customers.address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	customers.address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	customers.address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	customers.address.postal_code	string	Code postal de l’adresse.
Pays	customers.address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Numéro de téléphone	customers.phone_number	string	Numéro de téléphone à 11 chiffres associé au profil client.
ID de référence	customers.reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
E-mail désinscription	customers.preferences.email_unsubscribed	boolean	Indique si le client s’est désinscrit des e-mails de campagne marketing. La valeur true signifie que le client a choisi de refuser le marketing par e-mail du vendeur square actuel ou de tous les vendeurs Square. Cette valeur est en lecture seule à partir de l’API Customers.
Source de création	customers.creation_source	string	Une source de création représente la méthode utilisée pour créer le profil client.
ID de groupe	customers.group_ids	array of string
ID de segment	customers.segment_ids	array of string
Version	customers.version	integer	Version actuelle de l’objet.
Note	customers.note	string	Note personnalisée associée au profil client.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Rechercher des factures

ID d’opération :: InvoiceSearch

Recherche les factures à partir d’un emplacement spécifié dans le filtre.

Paramètres

Nom	Clé	Type	Description
ID d’emplacement	location_ids	array of string
ID client	customer_ids	array of string
Terrain	field	string	Utilisez un ou plusieurs attributs client comme clé de tri pour trier les profils clients recherchés.
JSON	order	string	Indique l’ordre dans lequel les résultats doivent être triés en fonction de la valeur du champ de tri. Les chaînes utilisent une comparaison alphabétique standard pour déterminer l’ordre.
Limit	limit	integer	Nombre maximal de factures à retourner (200 est la limite maximale). S’il n’est pas fourni, le serveur utilise une limite par défaut de 100 factures.

Retours

Nom	Chemin d’accès	Type	Description
Invoices	invoices	array of object
ID	invoices.id	string	Identificateur unique émis par carré.
Version	invoices.version	integer	Version actuelle de l’objet.
ID d’emplacement	invoices.location_id	string	Identificateur de l’emplacement.
ID de commande	invoices.order_id	string	ID de l’ordre.
Demandes de paiement	invoices.payment_requests	array of object
Identificateur d’utilisateur	invoices.payment_requests.uid	string	ID généré par carré de la demande de paiement dans une facture.
Type de requête	invoices.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoices.payment_requests.due_date	string	Date d’échéance (dans le fuseau horaire de la facture) pour la demande de paiement, au format AAAA-MM-DD.
Basculement activé	invoices.payment_requests.tipping_enabled	boolean	Si la valeur est true, la page de facture hébergée sur place (champ public_url de la facture) permet au client de payer un pourboire.
Rappels	invoices.payment_requests.reminders	array of object	Rappels
Identificateur d’utilisateur	invoices.payment_requests.reminders.uid	string	ID affecté par carré qui identifie de manière unique le rappel dans InvoicePaymentRequest.
Jours planifiés relatifs	invoices.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoices.payment_requests.reminders.message	string	Message de rappel.
Statut	invoices.payment_requests.reminders.status	string	État du rappel.
Montant	invoices.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoices.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoices.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoices.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoices.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Pourcentage demandé	invoices.payment_requests.percentage_requested	string	Spécifie le montant de la demande de paiement en pourcentage.
ID de carte	invoices.payment_requests.card_id	string	ID de la carte de crédit ou de débit au dossier à facturer pour la demande de paiement.
Numéro de facture	invoices.invoice_number	string	Numéro de facture convivial.
Titre	invoices.title	string	Titre de la facture.
Descriptif	invoices.description	string	Description.
Planifié à	invoices.scheduled_at	string	Horodatage lorsque la facture est planifiée pour le traitement, au format RFC 3339. Une fois la facture publiée, Square traite la facture à la date spécifiée, en fonction du mode de livraison et des paramètres de demande de paiement.
Statut	invoices.status	string	État de vérification actuel de cet objet.
Timezone	invoices.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier sur la facture, telles que due_date. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoices.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	invoices.updated_at	string	Horodatage de dernière modification au format RFC 3339
ID de client	invoices.primary_recipient.customer_id	string	ID d’un client à associer à la carte.
Prénom	invoices.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoices.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoices.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoices.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Card	invoices.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoices.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoices.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoices.custom_fields	array of object
Étiquette	invoices.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoices.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoices.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture
Méthode de remise	invoices.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client.
Date de vente ou de service	invoices.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.
URL publique	invoices.public_url	string	URL de la page de facture hébergée sur place. Après avoir publié la facture à l’aide du point de terminaison PublishInvoice, Square héberge la page de facture et retourne l’URL de la page dans la réponse.
Montant	invoices.next_payment_amount_money.amount	integer	Montant.
Monnaie	invoices.next_payment_amount_money.currency	string	La devise.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Rechercher des objets de catalogue

ID d’opération :: CatalogSearch

Recherche CatalogObject de n’importe quel type en correspondant aux valeurs d’attributs de recherche prises en charge, à l’exclusion des valeurs d’attribut personnalisées sur les éléments ou les variantes d’élément, par rapport à un ou plusieurs des filtres de requête spécifiés.

Paramètres

Nom	Clé	Type	Description
Types d’objets	object_types	array of string
Nom de l’attribut	attribute_name	string	Nom de l’attribut à rechercher.
Préfixe d’attribut	attribute_prefix	string	Préfixe souhaité de la valeur d’attribut de recherche.
Limit	limit	integer	Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom	Chemin d’accès	Type	Description
Objets	objects	array of object
Type	objects.type	string	Type de cet objet.
ID	objects.id	string	Identificateur unique émis par carré.
Mise à jour à	objects.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.version	integer	Version actuelle de l’objet.
Est supprimé	objects.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	objects.item_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Descriptif	objects.item_data.title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
ID de catégorie	objects.item_data.category_id	string	ID de la catégorie de l’élément, le cas échéant.
Type de produit	objects.item_data.product_type	string	Expression de requête des types de produits pour retourner des éléments ou des variantes d’éléments ayant les types de produits spécifiés.
Numéros d’identification fiscale	objects.item_data.tax_ids	array of string
Variantes	objects.item_data.variations	array of object
Type	objects.item_data.variations.type	string	Type de cet objet. Chaque type d’objet a des propriétés attendues exprimées dans un format structuré dans son champ *_data correspondant ci-dessous.
ID	objects.item_data.variations.id	string	Identificateur pour référencer cet objet.
Mise à jour à	objects.item_data.variations.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.item_data.variations.version	integer	Version de l’objet. Lors de la mise à jour d’un objet, la version fournie doit correspondre à la version de la base de données, sinon l’écriture est rejetée comme étant en conflit.
Est supprimé	objects.item_data.variations.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.item_data.variations.present_at_all_locations	boolean	Liste des emplacements où l’objet est présent, même si present_at_all_locations est false. Cela peut inclure des emplacements désactivés.
ID d’élément	objects.item_data.variations.item_variation_data.item_id	string	ID de l’objet avec cette variante d’élément.
Nom	objects.item_data.variations.item_variation_data.name	string	Nom de cet élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Ordre dans lequel cette variante d’élément doit être affichée. Cette valeur est en lecture seule.
Montant	objects.item_data.variations.item_variation_data.price_money.amount	integer	Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise. Par exemple, lorsque la devise est USD, le montant est en cents. Les montants monétaires peuvent être positifs ou négatifs. Consultez la description de champ spécifique pour déterminer la signification de la connexion dans un cas particulier.
Monnaie	objects.item_data.variations.item_variation_data.price_money.currency	string	Type de devise, au format ISO 4217. Par exemple, le code monétaire pour les dollars américains est USD.
Type de tarification	objects.item_data.variations.item_variation_data.pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Visibilité	objects.item_data.visibility	string	Visibilité.

Remboursement du paiement

ID d’opération :: RefundPayment

Remboursement d’un paiement. Vous pouvez rembourser l’intégralité du montant du paiement ou une partie de celui-ci. Vous pouvez utiliser ce point de terminaison pour rembourser un paiement par carte ou enregistrer un remboursement d’un paiement en espèces ou externe.

Paramètres

Nom	Clé	Type	Description
Clé d’Idempotency	idempotency_key	string	Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).
ID de paiement	payment_id	string	ID unique du paiement en cours de remboursement.
Montant	amount	integer	Montant de l’argent à accepter pour ce paiement, sans inclure tip_money.
Monnaie	currency	string	Code monétaire ISO 4217 à 3 caractères.
Montant	amount	integer	Montant de l’argent à accepter pour ce paiement, sans inclure tip_money.
Monnaie	currency	string	Code monétaire ISO 4217 à 3 caractères.
Reason	reason	string	Description de la raison du remboursement.

Retours

Nom	Chemin d’accès	Type	Description
ID	refund.id	string	Identificateur unique émis par carré.
Statut	refund.status	string	État de vérification actuel de cet objet.
Montant	refund.amount_money.amount	integer	Montant.
Monnaie	refund.amount_money.currency	string	La devise.
ID de paiement	refund.payment_id	string	ID unique du paiement.
ID de commande	refund.order_id	string	ID de l’ordre.
Créé à	refund.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	refund.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Montant	refund.app_fee_money.amount	integer	Montant.
Monnaie	refund.app_fee_money.currency	string	La devise.
ID d’emplacement	refund.location_id	string	Identificateur de l’emplacement.
Reason	refund.reason	string	Raison de cet objet.

Remboursements des terminaux de recherche

ID d’opération :: TerminalSearchRefunds

Récupère une liste filtrée des demandes de remboursement de Terminal De Runtime créées par le vendeur effectuant la demande.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Limit	limit		integer	Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.
Statut	status		string	État actuel.

Retours

Nom	Chemin d’accès	Type	Description
Restitutions	refunds	array of object
ID	refunds.id	string	Identificateur unique émis par carré.
ID de remboursement	refunds.refund_id	string	ID unique de ce remboursement, généré par Square.
ID de paiement	refunds.payment_id	string	ID du paiement.
Montant	refunds.amount_money.amount	integer	Montant.
Monnaie	refunds.amount_money.currency	string	La devise.
Reason	refunds.reason	string	La raison pour laquelle le titulaire de carte a lancé le différend avec sa banque.
ID d’appareil	refunds.device_id	string	ID unique de l’appareil qui a utilisé ce code. Renseigné lorsque l’appareil est associé.
Durée de l’échéance	refunds.deadline_duration	string	Durée de la RFC 3339, après laquelle l’extraction est automatiquement annulée. Un TerminalCheckout en attente est automatiquement ANNULÉ et a une raison d’annulation de TIMED_OUT. Valeur par défaut : 5 minutes à partir de la création
Statut	refunds.status	string	État de vérification actuel de cet objet.
Créé à	refunds.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	refunds.updated_at	string	Horodatage de dernière modification au format RFC 3339
ID d’application	refunds.app_id	string	ID de l’application qui a créé l’extraction.
Marque de carte	refunds.card.card_brand	string	La marque de la carte.
Dernier 4	refunds.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’expiration	refunds.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’expiration	refunds.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	refunds.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	refunds.card.card_type	string	Type de la carte.
POUBELLE	refunds.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
ID de commande	refunds.order_id	string	ID de l’ordre.
ID d’emplacement	refunds.location_id	string	Identificateur de l’emplacement.

Reprendre l’abonnement

ID d’opération :: SubscriptionResume

Reprend un abonnement désactivé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Identifiant d’abonnement	subscription_id	True	string	Identificateur de l’abonnement.

Retours

Nom	Chemin d’accès	Type	Description
ID	subscription.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscription.location_id	string	Identificateur de l’emplacement.
ID plan	subscription.plan_id	string	ID du plan d’abonnement associé.
ID de client	subscription.customer_id	string	ID de cet objet représentant le client.
Statut	subscription.status	string	État de vérification actuel de cet objet.
Montant	subscription.price_override_money.amount	integer	Montant.
Monnaie	subscription.price_override_money.currency	string	La devise.
Version	subscription.version	integer	Version actuelle de cet objet.
Créé à	subscription.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Timezone	subscription.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscription.source.name	string	Nom.

Récupération par lots des modifications d’inventaire

ID d’opération :: InventoryBatchRetrieveChanges

Retourne les nombres physiques historiques et les ajustements en fonction des critères de filtre fournis.

Paramètres

Nom	Clé	Type	Description
ID d’objet catalog	catalog_object_ids	array of string
ID d’emplacement	location_ids	array of string
Les types	types	array of string
States	states	array of string
Mise à jour après	updated_after	string	Filtre pour retourner les résultats avec leur valeur calculated_at après l’heure donnée spécifiée dans un horodatage RFC 3339.
Mise à jour avant	updated_before	string	Filtre pour retourner les résultats avec leur created_at ou leur valeur calculated_at strictement avant l’heure donnée spécifiée dans un horodatage RFC 3339.

Retours

Nom	Chemin d’accès	Type	Description
Modifications	changes	array of object
Type	changes.type	string	Type de cet objet.
ID	changes.physical_count.id	string	Identificateur de l’objet
ID de référence	changes.physical_count.reference_id	string	ID de référence facultatif défini par l’utilisateur qui associe cette carte à une autre entité dans un système externe.
ID d’objet catalogue	changes.physical_count.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	changes.physical_count.catalog_object_type	string	Type du CatalogObject en cours de suivi.
État	changes.physical_count.state	string	État actuel de l’inventaire pour la quantité associée d’éléments.
ID d’emplacement	changes.physical_count.location_id	string	ID d’emplacement d’un destinataire (autre que le marchand) recevant une partie de cet appel d’offres.
Quantité	changes.physical_count.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Produit	changes.physical_count.source.product	string	Type de produit pour l’application.
ID de l'application	changes.physical_count.source.application_id	string	ID carré affecté à l’application.
Nom	changes.physical_count.source.name	string	Nom de l'élément.
ID d’employé	changes.physical_count.employee_id	string	ID généré par carré de l’employé responsable du nombre physique.
S’est produit à	changes.physical_count.occurred_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand le nombre physique a été examiné. Pour les mises à jour du nombre physique, l’horodatage occurred_at ne peut pas dépasser 24 heures ou ultérieurement par rapport à l’heure de la requête.
Créé à	changes.physical_count.created_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand le nombre physique a été créé.

Récupération par lots d’objets catalogue

ID d’opération :: CatalogBatchRetrieve

Retourne un ensemble d’objets en fonction de l’ID fourni. Chaque CatalogItem retourné dans l’ensemble inclut toutes ses informations enfants, notamment : tous ses objets CatalogItemVariation, références à ses objets CatalogModifierList et ids des objets CatalogTax qui s’y appliquent.

Paramètres

Nom	Clé	Type	Description
ID d'objet ;	object_ids	array of string
Version du catalogue	catalog_version	integer	Version spécifique des objets catalogue à inclure dans la réponse. Cela vous permet de récupérer des versions historiques d’objets. La valeur de version spécifiée est comparée à l’attribut de version de CatalogObjects.
Inclure des objets connexes	include_related_objects	boolean	Si la valeur est true, la réponse inclut des objets supplémentaires liés aux objets demandés, comme suit : Si le champ d’objets de la réponse contient un Objet CatalogItem, ses objets CatalogCategory associés, ses objets CatalogTax, les objets CatalogImage et CatalogModifierLists sont retournés dans le champ related_objects de la réponse. Si le champ d’objets de la réponse contient un CatalogItemVariation, son objet CatalogItem parent est retourné dans le champ related_objects de la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Objets	objects	array of object
Type	objects.type	string	Type de cet objet.
ID	objects.id	string	Identificateur unique émis par carré.
Mise à jour à	objects.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.version	integer	Version actuelle de l’objet.
Est supprimé	objects.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	objects.item_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Descriptif	objects.item_data.title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
ID de catégorie	objects.item_data.category_id	string	ID de la catégorie de l’élément, le cas échéant.
Numéros d’identification fiscale	objects.item_data.tax_ids	array of string
Variantes	objects.item_data.variations	array of object
Type	objects.item_data.variations.type	string	Type de cet objet. Chaque type d’objet a des propriétés attendues exprimées dans un format structuré dans son champ *_data correspondant ci-dessous.
ID	objects.item_data.variations.id	string	Identificateur pour référencer cet objet.
Mise à jour à	objects.item_data.variations.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.item_data.variations.version	integer	Version de l’objet. Lors de la mise à jour d’un objet, la version fournie doit correspondre à la version de la base de données, sinon l’écriture est rejetée comme étant en conflit.
Est supprimé	objects.item_data.variations.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.item_data.variations.present_at_all_locations	boolean	Liste des emplacements où l’objet est présent, même si present_at_all_locations est false. Cela peut inclure des emplacements désactivés.
ID d’élément	objects.item_data.variations.item_variation_data.item_id	string	ID de l’objet avec cette variante d’élément.
Nom	objects.item_data.variations.item_variation_data.name	string	Nom de cet élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Ordre dans lequel cette variante d’élément doit être affichée. Cette valeur est en lecture seule.
Type de tarification	objects.item_data.variations.item_variation_data.pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Montant	objects.item_data.variations.item_variation_data.price_money.amount	integer	Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise. Par exemple, lorsque la devise est USD, le montant est en cents. Les montants monétaires peuvent être positifs ou négatifs. Consultez la description de champ spécifique pour déterminer la signification de la connexion dans un cas particulier.
Monnaie	objects.item_data.variations.item_variation_data.price_money.currency	string	Type de devise, au format ISO 4217. Par exemple, le code monétaire pour les dollars américains est USD.
Objets connexes	related_objects	array of object
Type	related_objects.type	string	Type de cet objet.
ID	related_objects.id	string	Identificateur unique émis par carré.
Mise à jour à	related_objects.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	related_objects.version	integer	Version actuelle de l’objet.
Est supprimé	related_objects.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	related_objects.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	related_objects.category_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Nom	related_objects.tax_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Phase de calcul	related_objects.tax_data.calculation_phase	string	Indique si la taxe est calculée en fonction du sous-total ou du total d’un paiement.
Type d’inclusion	related_objects.tax_data.inclusion_type	string	Que la taxe soit ADDITIVE ou INCLUSIVE.
Pourcentage	related_objects.tax_data.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Enabled	related_objects.tax_data.enabled	boolean	Indique si un objet peut être utilisé ou non.

Récupérer la preuve des différends

ID d’opération :: DisputeRetrieveEvidence

Retourne les métadonnées de preuve spécifiées par l’ID de preuve dans le chemin d’URL de la demande. Vous devez conserver une copie de la preuve que vous chargez si vous souhaitez la référencer ultérieurement. Vous ne pouvez pas télécharger la preuve une fois que vous l’avez téléchargée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.
ID de preuve	evidence_id	True	string	Identificateur de la preuve.

Retours

Nom	Chemin d’accès	Type	Description
ID	evidence.id	string	Identificateur unique émis par carré.
ID de litige	evidence.dispute_id	string	L’ID du différend dont la preuve est associée.
Filename	evidence.evidence_file.filename	string	Les fichiers de preuve de litige doivent être des formats application/pdf, image/heic, image/heif, image/jpeg, image/png ou image/tiff.
Type de fichier	evidence.evidence_file.filetype	string	Nom de fichier incluant l’extension de fichier.
Type de preuve	evidence.evidence_type	string	Type pf evidence.
Chargé à l’adresse	evidence.uploaded_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.

Récupérer le client

ID d’opération :: CustomerRetrieve

Retourne les détails d’un seul client.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de client	customer_id	True	string	Identificateur du client.

Retours

Nom	Chemin d’accès	Type	Description
ID	customer.id	string	Identificateur unique émis par carré.
Créé à	customer.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	customer.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Prénom	customer.given_name	string	Nom donné (c.-à-d. prénom) associé au profil client.
Nom de famille	customer.family_name	string	Nom de la famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	customer.email_address	string	Adresse e-mail associée au profil client.
Ligne d’adresse 1	customer.address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	customer.address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	customer.address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	customer.address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	customer.address.postal_code	string	Code postal de l’adresse.
Pays	customer.address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Numéro de téléphone	customer.phone_number	string	Numéro de téléphone à 11 chiffres associé au profil client.
ID de référence	customer.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Note	customer.note	string	Note personnalisée associée au profil client.
E-mail désinscription	customer.preferences.email_unsubscribed	boolean	Indique si le client s’est désinscrit des e-mails de campagne marketing. La valeur true signifie que le client a choisi de refuser le marketing par e-mail du vendeur square actuel ou de tous les vendeurs Square.
Source de création	customer.creation_source	string	Une source de création représente la méthode utilisée pour créer le profil client.
ID de groupe	customer.group_ids	array of string
ID de segment	customer.segment_ids	array of string
Version	customer.version	integer	Version actuelle de cet objet.

Récupérer le différend

ID d’opération :: DisputeRetrieve

Retourne des détails sur un litige spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.

Retours

Nom	Chemin d’accès	Type	Description
ID	dispute.id	string	Identificateur unique émis par carré.
Montant	dispute.amount_money.amount	integer	Montant.
Monnaie	dispute.amount_money.currency	string	La devise.
Reason	dispute.reason	string	Raison de cet objet.
État	dispute.state	string	État actuel.
Due At	dispute.due_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.
Paiements contestés	dispute.disputed_payments	array of object
ID de paiement	dispute.disputed_payments.payment_id	string	ID unique généré par carré du paiement.
Marque de carte	dispute.card_brand	string	La marque de la carte.
Créé à	dispute.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	dispute.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de litige de marque	dispute.brand_dispute_id	string	ID du litige dans le système de marque de carte, généré par la marque de carte.

Récupérer le groupe de clients

ID d’opération :: CustomerGroupRetrieve

Récupère un groupe de clients spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	group_id	True	string	Identificateur du groupe.

Retours

Nom	Chemin d’accès	Type	Description
ID	group.id	string	Identificateur unique émis par carré.
Nom	group.name	string	Nom de l’objet.
Créé à	group.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	group.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Récupérer le nombre d’inventaires

ID d’opération :: InventoryRetrieveCount

Récupère le nombre d’actions calculés actuel pour un CatalogObject donné à un ensemble donné d’emplacements.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’objet catalogue	catalog_object_id	True	string	Identificateur de l’objet catalogue.
ID d’emplacement	location_ids		string	ID d’emplacement à rechercher sous la forme d’une liste séparée par des virgules. Une liste vide interroge tous les emplacements.
Cursor	cursor		string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom	Chemin d’accès	Type	Description
Compte	counts	array of object
ID d’objet catalogue	counts.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	counts.catalog_object_type	string	Type du CatalogObject en cours de suivi.
État	counts.state	string	État actuel.
ID d’emplacement	counts.location_id	string	Identificateur de l’emplacement.
Quantité	counts.quantity	string	Nombre d’éléments affectés par le nombre estimé sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Calculé à	counts.calculated_at	string	Horodatage au format RFC 3339 qui indique quand le nombre physique ou l’ajustement le plus récent affectant le nombre estimé est reçu.

Récupérer le nombre physique d’inventaire

ID d’opération :: InventoryRetrievePhysicalCount

Retourne l’objet InventoryPhysicalCount avec la physical_count_id fournie.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de nombre physique	physical_count_id	True	string	Identificateur du nombre physique.

Retours

Nom	Chemin d’accès	Type	Description
ID	count.id	string	Identificateur unique émis par carré.
ID de référence	count.reference_id	string	ID de référence facultatif défini par l’utilisateur.
ID d’objet catalogue	count.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	count.catalog_object_type	string	Type du CatalogObject en cours de suivi.
État	count.state	string	État actuel.
ID d’emplacement	count.location_id	string	Identificateur de l’emplacement.
Quantité	count.quantity	string	Nombre d’éléments affectés par l’ajustement sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Produit	count.source.product	string	Type de produit pour l’application.
ID de l'application	count.source.application_id	string	ID carré en lecture seule affecté à l’application.
Nom	count.source.name	string	Nom.
ID d’employé	count.employee_id	string	ID généré par carré de l’employé.
S’est produit à	count.occurred_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand l’ajustement de l’inventaire a eu lieu. Pour les mises à jour d’ajustement de l’inventaire, l’horodatage occurred_at ne peut pas dépasser 24 heures ou ultérieurement par rapport à l’heure de la demande.
Créé à	count.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Récupérer le segment client

ID d’opération :: CustomerSegmentRetrieve

Récupère un segment de client spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de segment	segment_id	True	string	Identificateur du segment.

Retours

Nom	Chemin d’accès	Type	Description
ID	segment.id	string	Identificateur unique émis par carré.
Nom	segment.name	string	Nom de l’objet.
Créé à	segment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	segment.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Récupérer le transfert d’inventaire (bêta)

ID d’opération :: InventoryRetrieveTransfer

Retourne l’objet InventoryTransfer avec la transfer_id fournie.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de transfert	transfer_id	True	string	Identificateur du transfert.

Retours

Nom	Chemin d’accès	Type	Description
ID	transfer.id	string	Identificateur unique émis par carré.
ID d’objet catalogue	transfer.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	transfer.catalog_object_type	string	Type du CatalogObject en cours de suivi.
Créé à	transfer.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
ID d’employé	transfer.employee_id	string	ID généré par carré de l’employé.
À partir de l’ID d’emplacement	transfer.from_location_id	string	ID généré par carré de l’emplacement où la quantité d’éléments associée a été suivie avant le transfert.
À l’ID d’emplacement	transfer.to_location_id	string	ID généré par carré de l’emplacement où la quantité d’éléments associée a été suivie après le transfert.
S’est produit à	transfer.occurred_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand l’ajustement de l’inventaire a eu lieu. Pour les mises à jour d’ajustement de l’inventaire, l’horodatage occurred_at ne peut pas dépasser 24 heures ou ultérieurement par rapport à l’heure de la demande.
Quantité	transfer.quantity	string	Nombre d’éléments affectés par l’ajustement sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
ID de référence	transfer.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Produit	transfer.source.product	string	Type de produit pour l’application.
ID de l'application	transfer.source.application_id	string	ID carré en lecture seule affecté à l’application.
Nom	transfer.source.name	string	Nom.
État	transfer.state	string	État actuel.

Récupérer l’abonnement

ID d’opération :: SubscriptionRetrieve

Récupère un abonnement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Identifiant d’abonnement	subscription_id	True	string	Identificateur de l’abonnement.

Retours

Nom	Chemin d’accès	Type	Description
ID	subscription.id	string	Identificateur unique émis par carré.
ID d’emplacement	subscription.location_id	string	Identificateur de l’emplacement.
ID plan	subscription.plan_id	string	ID du plan d’abonnement associé.
ID de client	subscription.customer_id	string	ID de cet objet représentant le client.
Date de début	subscription.start_date	string	Date de début de l’abonnement, au format aaaa-MM-DD.
Facturé à la date	subscription.charged_through_date	string	Date à laquelle le client est facturé pour l’abonnement, au format aaaa-MM-DD.
Statut	subscription.status	string	État de vérification actuel de cet objet.
ID de facture	subscription.invoice_ids	array of string
Montant	subscription.price_override_money.amount	integer	Montant.
Monnaie	subscription.price_override_money.currency	string	La devise.
Créé à	subscription.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Payé jusqu’à la date	subscription.paid_until_date	string	Date payée jusqu’à ce que.
Timezone	subscription.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Nom	subscription.source.name	string	Nom.

Récupérer l’ajustement de l’inventaire

ID d’opération :: InventoryRetrieveAdjustment

Retourne l’objet InventoryAdjustment avec le adjustment_id fourni.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’ajustement	adjustment_id	True	string	Identificateur de l’ajustement.

Retours

Nom	Chemin d’accès	Type	Description
ID	adjustment.id	string	Identificateur unique émis par carré.
ID de référence	adjustment.reference_id	string	ID de référence facultatif défini par l’utilisateur.
À partir de l’état	adjustment.from_state	string	État d’inventaire de la quantité associée d’éléments avant l’ajustement.
À état	adjustment.to_state	string	État d’inventaire de la quantité associée d’éléments après l’ajustement.
ID d’emplacement	adjustment.location_id	string	Identificateur de l’emplacement.
ID d’objet catalogue	adjustment.catalog_object_id	string	ID généré par carré du CatalogObject en cours de suivi.
Type d’objet Catalog	adjustment.catalog_object_type	string	Type du CatalogObject en cours de suivi.
Quantité	adjustment.quantity	string	Nombre d’éléments affectés par l’ajustement sous forme de chaîne décimale. Peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Montant	adjustment.total_price_money.amount	integer	Montant.
Monnaie	adjustment.total_price_money.currency	string	La devise.
S’est produit à	adjustment.occurred_at	string	Horodatage au format RFC 3339 généré par le client qui indique quand l’ajustement de l’inventaire a eu lieu. Pour les mises à jour d’ajustement de l’inventaire, l’horodatage occurred_at ne peut pas dépasser 24 heures ou ultérieurement par rapport à l’heure de la demande.
Créé à	adjustment.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Produit	adjustment.source.product	string	Type de produit pour l’application.
ID de l'application	adjustment.source.application_id	string	ID carré en lecture seule affecté à l’application.
Nom	adjustment.source.name	string	Nom.
ID d’employé	adjustment.employee_id	string	ID généré par carré de l’employé.

Récupérer l’objet catalogue

ID d’opération :: CatalogRetrieve

Retourne un objet CatalogItem unique en tant que CatalogObject basé sur l’ID fourni. L’objet retourné inclut toutes les informations CatalogItem pertinentes, notamment les enfants CatalogItemVariation, les références à ses objets CatalogModifierList et les ID des objets CatalogTax qui s’y appliquent.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’objet	object_id	True	string	Identificateur de l’objet.
Inclure des objets connexes	include_related_objects		boolean	Si la valeur est true, la réponse inclut des objets supplémentaires liés à l’objet demandé, comme suit : si le champ d’objet de la réponse contient un CatalogItem, ses objets CatalogCategory, CatalogTax, CatalogTax, CatalogImage et CatalogModifierList sont retournés dans le champ related_objects de la réponse. Si le champ objet de la réponse contient un CatalogItemVariation, son catalogItem parent est retourné dans le champ related_objects de la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Type	object.type	string	Type de cet objet.
ID	object.id	string	Identificateur unique émis par carré.
Mise à jour à	object.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
Version	object.version	integer	Version actuelle de cet objet.
Est supprimé	object.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
present_at_all_locations	object.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	object.item_data.name	string	Nom.
Descriptif	object.item_data.title	string	Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
ID de catégorie	object.item_data.category_id	string	ID de la catégorie de l’élément, le cas échéant.
Numéros d’identification fiscale	object.item_data.tax_ids	array of string
Variantes	object.item_data.variations	array of object
Type	object.item_data.variations.type	string	Type de cet objet.
ID	object.item_data.variations.id	string	Identificateur pour référencer cet objet dans le catalogue.
Mise à jour à	object.item_data.variations.updated_at	string	Horodatage de dernière modification au format RFC 3339.
Version	object.item_data.variations.version	integer	Version de l’objet. Lors de la mise à jour d’un objet, la version fournie doit correspondre à la version de la base de données, sinon l’écriture est rejetée comme étant en conflit.
Est supprimé	object.item_data.variations.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	object.item_data.variations.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
ID d’élément	object.item_data.variations.item_variation_data.item_id	string	ID du CatalogItem associé à cette variante d’élément.
Nom	object.item_data.variations.item_variation_data.name	string	Nom de la variante d’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.
Ordinal	object.item_data.variations.item_variation_data.ordinal	integer	Ordre dans lequel cette variante d’élément doit être affichée. Cette valeur est en lecture seule. Lors des écritures, l’ordinal pour chaque variante d’élément dans un CatalogItem parent est défini en fonction de la position des variantes d’élément. Lors des lectures, la valeur n’est pas garantie comme séquentielle ou unique.
Type de tarification	object.item_data.variations.item_variation_data.pricing_type	string	Indique si le prix de la variation de l’article est fixe ou déterminé au moment de la vente.
Montant	object.item_data.variations.item_variation_data.price_money.amount	integer	Montant.
Monnaie	object.item_data.variations.item_variation_data.price_money.currency	string	La devise.

Récupérer l’ordre

ID d’opération :: OrderRetrieve

Récupère une commande par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de commande	order_id	True	string	Identificateur de l’ordre.

Retours

Nom	Chemin d’accès	Type	Description
ID	order.id	string	Identificateur unique émis par carré.
ID d’emplacement	order.location_id	string	Identificateur de l’emplacement.
Éléments de ligne	order.line_items	array of object
Identificateur d’utilisateur	order.line_items.uid	string	ID généré par carré.
Quantité	order.line_items.quantity	string	Nombre d’éléments affectés par le nombre physique sous forme de chaîne décimale. Le nombre peut prendre en charge jusqu’à 5 chiffres après la virgule décimale.
Nom	order.line_items.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Montant	order.line_items.base_price_money.amount	integer	Montant.
Monnaie	order.line_items.base_price_money.currency	string	La devise.
Montant	order.line_items.gross_sales_money.amount	integer	Montant.
Monnaie	order.line_items.gross_sales_money.currency	string	La devise.
Montant	order.line_items.total_tax_money.amount	integer	Montant.
Monnaie	order.line_items.total_tax_money.currency	string	La devise.
Montant	order.line_items.total_discount_money.amount	integer	Montant.
Monnaie	order.line_items.total_discount_money.currency	string	La devise.
Montant	order.line_items.total_money.amount	integer	Montant.
Monnaie	order.line_items.total_money.currency	string	La devise.
Montant	order.line_items.variation_total_price_money.amount	integer	Montant.
Monnaie	order.line_items.variation_total_price_money.currency	string	La devise.
Remises appliquées	order.line_items.applied_discounts	array of object
Identificateur d’utilisateur	order.line_items.applied_discounts.uid	string	ID affecté par carré.
UID de remise	order.line_items.applied_discounts.discount_uid	string	Uid de la remise que représente la remise appliquée.
Montant	order.line_items.applied_discounts.applied_money.amount	integer	Montant.
Monnaie	order.line_items.applied_discounts.applied_money.currency	string	La devise.
Remises	order.discounts	array of object
Identificateur d’utilisateur	order.discounts.uid	string	ID généré par carré.
Nom	order.discounts.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Pourcentage	order.discounts.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Montant	order.discounts.applied_money.amount	integer	Montant.
Monnaie	order.discounts.applied_money.currency	string	La devise.
Type	order.discounts.type	string	Indique le type.
Scope	order.discounts.scope	string	Indique le niveau actuel.
Créé à	order.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	order.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
État	order.state	string	État actuel.
Version	order.version	integer	Version actuelle de cet objet.
Montant	order.total_tax_money.amount	integer	Montant.
Monnaie	order.total_tax_money.currency	string	La devise.
Montant	order.total_discount_money.amount	integer	Montant.
Monnaie	order.total_discount_money.currency	string	La devise.
Montant	order.total_tip_money.amount	integer	Montant.
Monnaie	order.total_tip_money.currency	string	La devise.
Montant	order.total_money.amount	integer	Montant.
Monnaie	order.total_money.currency	string	La devise.
Montant	order.total_service_charge_money.amount	integer	Montant.
Monnaie	order.total_service_charge_money.currency	string	La devise.
Montant	order.net_amounts.total_money.amount	integer	Montant.
Monnaie	order.net_amounts.total_money.currency	string	La devise.
Montant	order.net_amounts.tax_money.amount	integer	Montant.
Monnaie	order.net_amounts.tax_money.currency	string	La devise.
Montant	order.net_amounts.discount_money.amount	integer	Montant.
Monnaie	order.net_amounts.discount_money.currency	string	La devise.
Montant	order.net_amounts.tip_money.amount	integer	Montant.
Monnaie	order.net_amounts.tip_money.currency	string	La devise.
Montant	order.net_amounts.service_charge_money.amount	integer	Montant.
Monnaie	order.net_amounts.service_charge_money.currency	string	La devise.

Récupérer une carte

ID d’opération :: CardRetrieve

Récupère les détails d’une carte spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de carte	card_id	True	string	Identificateur de la carte.

Retours

Nom	Chemin d’accès	Type	Description
ID	card.id	string	Identificateur unique émis par carré.
Ligne d’adresse 1	card.billing_address.address_line_1	string	Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.
Ligne d’adresse 2	card.billing_address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	card.billing_address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	card.billing_address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	card.billing_address.postal_code	string	Code postal de l’adresse.
Pays	card.billing_address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Empreinte digitale	card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
POUBELLE	card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN).
Marque de carte	card.card_brand	string	La marque de la carte.
Type de carte	card.card_type	string	Type de la carte.
Nom du titulaire de carte	card.cardholder_name	string	Nom du titulaire de carte.
ID de client	card.customer_id	string	ID de cet objet représentant le client.
Enabled	card.enabled	boolean	Indique si cette option est activée.
Mois d’exp	card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Dernier 4	card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Type prépayé	card.prepaid_type	string	Indique si la carte est prépayée ou non.
ID de référence	card.reference_id	string	ID de référence facultatif défini par l’utilisateur.
Version	card.version	integer	Version actuelle de cet objet.

Répertorier le catalogue

ID d’opération :: CatalogList

Renvoie une liste de CatalogObjects qui inclut tous les objets d’un ensemble de types souhaités (par exemple, tous les objets CatalogItem et CatalogTax) dans le catalogue. ListCatalog ne retourne pas d’éléments de catalogue supprimés.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cursor	cursor		integer	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
Les types	types		string	Liste facultative sans respect de la casse, séparée par des virgules des types d’objets à récupérer. Les valeurs valides sont définies dans l’énumération CatalogObjectType, notamment ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFICATEUR, MODIFIER_LIST ou IMAGE. Si elle n’est pas spécifiée, l’opération retourne des objets de tous les types à la version de l’API Square utilisée pour effectuer la requête.

Retours

Nom	Chemin d’accès	Type	Description
Objets	objects	array of object
Type	objects.type	string	Type de cet objet.
ID	objects.id	string	Identificateur unique émis par carré.
Mise à jour à	objects.updated_at	string	Horodatage de dernière modification au format RFC 3339
Version	objects.version	integer	Version actuelle de l’objet.
Est supprimé	objects.is_deleted	boolean	Si la valeur est true, l’objet a été supprimé de la base de données. Doit être false pour les nouveaux objets insérés. En cas de suppression, le champ updated_at est égal à l’heure de suppression.
Présent à tous les emplacements	objects.present_at_all_locations	boolean	Si la valeur est true, cet objet est présent à tous les emplacements (y compris les emplacements futurs), sauf lorsqu’il est spécifié dans le champ absent_at_location_ids. Si la valeur est false, cet objet n’est présent à aucun emplacement (y compris les emplacements futurs), sauf s’il est spécifié dans le champ present_at_location_ids. S’il n’est pas spécifié, la valeur par défaut est true.
Nom	objects.category_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Nom	objects.tax_data.name	string	Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.
Phase de calcul	objects.tax_data.calculation_phase	string	Indique si la taxe est calculée en fonction du sous-total ou du total d’un paiement.
Type d’inclusion	objects.tax_data.inclusion_type	string	Que la taxe soit ADDITIVE ou INCLUSIVE.
Pourcentage	objects.tax_data.percentage	string	Pourcentage sous forme décimale, à l’aide d’un « . » comme séparateur décimal et sans signe «%». La valeur 7,5 correspond à 7,5%.
Enabled	objects.tax_data.enabled	boolean	Indique si un objet peut être utilisé ou non.

Répertorier les clients

ID d’opération :: CustomerList

Répertorie les profils clients associés à un compte Square. Dans des conditions d’exploitation normales, les profils clients nouvellement créés ou mis à jour deviennent disponibles pour l’opération de référencement en moins de 30 secondes. Parfois, la propagation des profils nouveaux ou mis à jour peut prendre plus d’une minute ou plus, en particulier pendant les incidents réseau et les pannes.

Paramètres

Nom	Clé	Type	Description
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
Limit	limit	integer	Limite supérieure du nombre à retourner dans la réponse.
Trier le champ	sort_field	string	Indique comment les clients doivent être triés. La valeur par défaut est DEFAULT.
Ordre de tri	sort_order	string	Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.

Retours

Nom	Chemin d’accès	Type	Description
Clientèle	customers	array of object
ID	customers.id	string	Identificateur unique émis par carré.
Créé à	customers.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	customers.updated_at	string	Horodatage de dernière modification au format RFC 3339
Prénom	customers.given_name	string	Nom donné (c.-à-d. prénom) associé au profil client.
Nom de famille	customers.family_name	string	Nom de la famille (c’est-à-dire le nom) associé au profil client.
Adresse électronique	customers.email_address	string	Adresse e-mail associée au profil client.
Ligne d’adresse 1	customers.address.address_line_1	string	Première ligne de l’adresse.
Ligne d’adresse 2	customers.address.address_line_2	string	Deuxième ligne de l’adresse, le cas échéant.
Localité	customers.address.locality	string	La ville ou la ville de l’adresse.
Niveau de district administratif 1	customers.address.administrative_district_level_1	string	Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.
Code postal	customers.address.postal_code	string	Code postal de l’adresse.
Pays	customers.address.country	string	Pays de l’adresse, au format ISO 3166-1-alpha-2.
Numéro de téléphone	customers.phone_number	string	Numéro de téléphone à 11 chiffres associé au profil client.
ID de référence	customers.reference_id	string	Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.
Note	customers.note	string	Note personnalisée associée au profil client.
E-mail désinscription	customers.preferences.email_unsubscribed	boolean	Indique si le client s’est désinscrit des e-mails de campagne marketing. La valeur true signifie que le client a choisi de refuser le marketing par e-mail du vendeur square actuel ou de tous les vendeurs Square. Cette valeur est en lecture seule à partir de l’API Customers.
Source de création	customers.creation_source	string	Une source de création représente la méthode utilisée pour créer le profil client.
ID de groupe	customers.group_ids	array of string
ID de segment	customers.segment_ids	array of string
Version	customers.version	integer	Version actuelle de l’objet.

Répertorier les différends

ID d’opération :: DisputeList

Retourne une liste de litiges associés à un compte particulier.

Paramètres

Nom	Clé	Type	Description
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
States	states	string	Le différend indique de filtrer le résultat. S’il n’est pas spécifié, le point de terminaison renvoie tous les différends ouverts (le statut du litige n’est pas INQUIRY_CLOSED, WON ou LOST).
ID d’emplacement	location_id	string	Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Retours

Nom	Chemin d’accès	Type	Description
Des litiges	disputes	array of object
ID	disputes.id	string	Identificateur unique émis par carré.
Montant	disputes.amount_money.amount	integer	Montant.
Monnaie	disputes.amount_money.currency	string	La devise.
Reason	disputes.reason	string	La raison pour laquelle le titulaire de carte a lancé le différend avec sa banque.
État	disputes.state	string	État actuel.
Due At	disputes.due_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.
Paiements contestés	disputes.disputed_payments	array of object
ID de paiement	disputes.disputed_payments.payment_id	string	ID unique généré par carré du paiement en cours de litige.
Marque de carte	disputes.card_brand	string	Marque de carte utilisée dans le paiement contesté.
Créé à	disputes.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	disputes.updated_at	string	Horodatage de dernière modification au format RFC 3339
ID de litige de marque	disputes.brand_dispute_id	string	ID du litige dans le système de marque de carte, généré par la marque de carte.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Répertorier les factures

ID d’opération :: InvoiceList

Retourne une liste de factures pour un emplacement donné.

Paramètres

Nom	Clé	Type	Description
ID d’emplacement	location_id	string	Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
Limit	limit	integer	Limite supérieure du nombre à retourner dans la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Invoices	invoices	array of object
ID	invoices.id	string	Identificateur unique émis par carré.
Version	invoices.version	integer	Version actuelle de l’objet.
ID d’emplacement	invoices.location_id	string	Identificateur de l’emplacement.
ID de commande	invoices.order_id	string	ID de l’ordre.
Demandes de paiement	invoices.payment_requests	array of object
Identificateur d’utilisateur	invoices.payment_requests.uid	string	ID généré par carré de la demande de paiement dans une facture.
Type de requête	invoices.payment_requests.request_type	string	Identifie le type de demande de paiement. Ce type définit la façon dont le montant de la demande de paiement est déterminé.
Date d'échéance	invoices.payment_requests.due_date	string	Date d’échéance (dans le fuseau horaire de la facture) pour la demande de paiement, au format AAAA-MM-DD.
Basculement activé	invoices.payment_requests.tipping_enabled	boolean	Si la valeur est true, la page de facture hébergée sur place (champ public_url de la facture) permet au client de payer un pourboire.
Rappels	invoices.payment_requests.reminders	array of object	Rappels
Identificateur d’utilisateur	invoices.payment_requests.reminders.uid	string	ID affecté par carré qui identifie de manière unique le rappel dans InvoicePaymentRequest.
Jours planifiés relatifs	invoices.payment_requests.reminders.relative_scheduled_days	integer	Nombre de jours avant (nombre négatif) ou après (nombre positif) la demande de paiement due_date lorsque le rappel est envoyé.
Message	invoices.payment_requests.reminders.message	string	Message de rappel.
Statut	invoices.payment_requests.reminders.status	string	État du rappel.
Montant	invoices.payment_requests.computed_amount_money.amount	integer	Montant.
Monnaie	invoices.payment_requests.computed_amount_money.currency	string	La devise.
Montant	invoices.payment_requests.total_completed_amount_money.amount	integer	Montant.
Monnaie	invoices.payment_requests.total_completed_amount_money.currency	string	La devise.
Source de paiement automatique	invoices.payment_requests.automatic_payment_source	string	Mode de paiement pour un paiement automatique.
Pourcentage demandé	invoices.payment_requests.percentage_requested	string	Spécifie le montant de la demande de paiement en pourcentage.
ID de carte	invoices.payment_requests.card_id	string	ID de la carte de crédit ou de débit au dossier à facturer pour la demande de paiement.
Numéro de facture	invoices.invoice_number	string	Numéro de facture convivial.
Titre	invoices.title	string	Titre de la facture.
Descriptif	invoices.description	string	Description.
Planifié à	invoices.scheduled_at	string	Horodatage lorsque la facture est planifiée pour le traitement, au format RFC 3339. Une fois la facture publiée, Square traite la facture à la date spécifiée, en fonction du mode de livraison et des paramètres de demande de paiement.
Statut	invoices.status	string	État de vérification actuel de cet objet.
Timezone	invoices.timezone	string	Fuseau horaire utilisé pour interpréter les dates de calendrier sur la facture, telles que due_date. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.
Créé à	invoices.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	invoices.updated_at	string	Horodatage de dernière modification au format RFC 3339
ID de client	invoices.primary_recipient.customer_id	string	ID d’un client à associer à la carte.
Prénom	invoices.primary_recipient.given_name	string	Le nom du destinataire (c’est-à-dire, prénom).
Nom de famille	invoices.primary_recipient.family_name	string	Nom de la famille du destinataire (c’est-à-dire, nom).
Adresse électronique	invoices.primary_recipient.email_address	string	Adresse e-mail du destinataire.
Numéro de téléphone	invoices.primary_recipient.phone_number	string	Numéro de téléphone du destinataire.
Card	invoices.accepted_payment_methods.card	boolean	Indique si les paiements par carte de crédit ou carte de débit sont acceptés.
Carte cadeau carrée	invoices.accepted_payment_methods.square_gift_card	boolean	Indique si les paiements de carte cadeau Square sont acceptés.
Compte en banque	invoices.accepted_payment_methods.bank_account	boolean	Indique si les paiements de transfert bancaire sont acceptés.
Champs personnalisés	invoices.custom_fields	array of object
Étiquette	invoices.custom_fields.label	string	Étiquette ou titre du champ personnalisé.
Valeur	invoices.custom_fields.value	string	Texte du champ personnalisé.
Sélection élective	invoices.custom_fields.placement	string	Emplacement du champ personnalisé sur la facture
Méthode de remise	invoices.delivery_method	string	Méthode de livraison utilisée par Square pour envoyer la facture, les rappels et les reçus au client.
Date de vente ou de service	invoices.sale_or_service_date	string	Date de la vente ou de la date à laquelle le service est rendu, au format aaaa-MM-DD. Ce champ peut être utilisé pour spécifier une date passée ou ultérieure qui s’affiche sur la facture.
URL publique	invoices.public_url	string	URL de la page de facture hébergée sur place. Après avoir publié la facture à l’aide du point de terminaison PublishInvoice, Square héberge la page de facture et retourne l’URL de la page dans la réponse.
Montant	invoices.next_payment_amount_money.amount	integer	Montant.
Monnaie	invoices.next_payment_amount_money.currency	string	La devise.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Répertorier les groupes de clients

ID d’opération :: CustomerGroupList

Récupère la liste des groupes de clients d’une entreprise.

Retours

Nom	Chemin d’accès	Type	Description
Groups	groups	array of object
ID	groups.id	string	Identificateur unique émis par carré.
Nom	groups.name	string	Nom de l’objet.
Créé à	groups.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	groups.updated_at	string	Horodatage de dernière modification au format RFC 3339

Répertorier les paiements

ID d’opération :: PaymentList

Récupère la liste des paiements pris par le compte qui effectue la demande. Les résultats sont finalement cohérents et les nouveaux paiements ou modifications apportées aux paiements peuvent prendre plusieurs secondes.

Paramètres

Nom	Clé	Type	Description
Heure de début	begin_time	string	Heure de début inclusive de la requête sur opened_at, au format ISO 8601.
Heure de fin	end_time	string	Date de fin exclusive de la requête sur opened_at, au format ISO 8601.
Ordre de tri	sort_order	string	Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
ID d’emplacement	location_id	string	Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.
Total	total	integer	Montant exact dans la total_money d’un paiement.
Dernier 4	last_4	string	Les quatre derniers chiffres d’une carte de paiement.
Marque de carte	card_brand	string	Marque de la carte de paiement (par exemple, VISA).
Limit	limit	integer	Limite supérieure du nombre à retourner dans la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Paiements	payments	array of object
ID	payments.id	string	Identificateur unique émis par carré.
Créé à	payments.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	payments.updated_at	string	Horodatage de dernière modification au format RFC 3339
Montant	payments.amount_money.amount	integer	Montant.
Monnaie	payments.amount_money.currency	string	La devise.
Statut	payments.status	string	État de vérification actuel de cet objet.
Durée du délai	payments.delay_duration	string	Durée après la création du paiement lorsque Square applique automatiquement la delay_action au paiement.
Type de Source	payments.source_type	string	Type de source pour ce paiement.
Statut	payments.card_details.status	string	État actuel du paiement par carte. L’état peut être AUTORISÉ, CAPTURÉ, VOIDED ou FAILED.
Marque de carte	payments.card_details.card.card_brand	string	La marque de la carte.
last_4	payments.card_details.card.last_4	string	Les 4 derniers chiffres du numéro de carte.
Mois d’exp	payments.card_details.card.exp_month	integer	Mois d’expiration de la carte associée sous forme d’entier compris entre 1 et 12.
Année d’exp	payments.card_details.card.exp_year	integer	Année à quatre chiffres de la date d’expiration de la carte.
Empreinte digitale	payments.card_details.card.fingerprint	string	Conçu comme identificateur affecté par carré, basé sur le numéro de carte, pour identifier la carte à plusieurs emplacements au sein d’une seule application.
Type de carte	payments.card_details.card.card_type	string	Type de la carte.
Type prépayé	payments.card_details.card.prepaid_type	string	Indique si la carte est prépayée ou non.
POUBELLE	payments.card_details.card.bin	string	Les six premiers chiffres du numéro de carte, appelé numéro d’identification bancaire (BIN)
Entry, méthode	payments.card_details.entry_method	string	Méthode utilisée pour entrer les détails de la carte pour le paiement. La méthode peut être KEYED, SWIPED, EMV, ON_FILE ou CONTACTLESS.
État Cvv	payments.card_details.cvv_status	string	Code d’état retourné à partir de la vérification de la valeur de vérification de carte (CVV). Le code peut être CVV_ACCEPTED, CVV_REJECTED ou CVV_NOT_CHECKED.
État Avs	payments.card_details.avs_status	string	Code d’état retourné à partir de la vérification du système de vérification d’adresse (AVS). Le code peut être AVS_ACCEPTED, AVS_REJECTED ou AVS_NOT_CHECKED.
Code de résultat d’authentification	payments.card_details.auth_result_code	string	Code d’état retourné par l’émetteur de carte qui décrit l’état d’autorisation du paiement.
Description de l’instruction	payments.card_details.statement_description	string	Description de l’instruction envoyée aux réseaux de cartes.
Autorisé à	payments.card_details.card_payment_timeline.authorized_at	string	Horodatage lorsque le paiement a été autorisé, au format RFC 3339.
Capturé à	payments.card_details.card_payment_timeline.captured_at	string	Horodatage lorsque le paiement a été capturé, au format RFC 3339.
ID d’emplacement	payments.location_id	string	Identificateur de l’emplacement.
ID de commande	payments.order_id	string	ID de l’ordre.
Frais de traitement	payments.processing_fee	array of object
Effectif à	payments.processing_fee.effective_at	string	Horodatage du moment où les frais prennent effet, au format RFC 3339.
Type	payments.processing_fee.type	string	Type de cet objet.
Montant	payments.processing_fee.amount_money.amount	integer	Montant.
Monnaie	payments.processing_fee.amount_money.currency	string	La devise.
Note	payments.note	string	Note personnalisée associée au profil client.
Montant	payments.total_money.amount	integer	Montant.
Monnaie	payments.total_money.currency	string	La devise.
Montant	payments.approved_money.amount	integer	Montant.
Monnaie	payments.approved_money.currency	string	La devise.
Numéro de reçu	payments.receipt_number	string	Numéro de reçu du paiement. Le champ est manquant si un paiement est annulé.
URL de réception	payments.receipt_url	string	URL du reçu du paiement. Le champ est renseigné uniquement pour les paiements TERMINÉs.
Action de retard	payments.delay_action	string	Action à appliquer au paiement lorsque le delay_duration s’est écoulé.
Retardé jusqu’à ce que	payments.delayed_until	string	Horodatage en lecture seule du moment où l’delay_action est automatiquement appliqué, au format RFC 3339.
ID de membre de l’équipe	payments.team_member_id	string	ID de l’objet TeamMember pour le membre de l’équipe associé à l’objet.
Produit carré	payments.application_details.square_product	string	Le produit Square, tel que le point de vente carré (POS), les factures carrées ou le terminal virtuel carré.
ID de l'application	payments.application_details.application_id	string	ID carré affecté à l’application utilisée pour prendre le paiement. Les développeurs d’applications peuvent utiliser ces informations pour identifier les paiements traités par leur application. Par exemple, si un développeur utilise une application personnalisée pour traiter les paiements, ce champ contient l’ID d’application du tableau de bord du développeur. Si un vendeur utilise une application Square App Marketplace pour traiter les paiements, le champ contient l’ID d’application correspondant.
Jeton de version	payments.version_token	string	Utilisé pour l’accès concurrentiel optimiste. Ce jeton opaque identifie une version spécifique de l’objet Paiement.

Répertorier les remboursements de paiement

ID d’opération :: RefundList

Récupère une liste de remboursements pour le compte effectuant la demande. Les résultats sont finalement cohérents et les nouveaux remboursements ou modifications apportées aux remboursements peuvent prendre plusieurs secondes.

Paramètres

Nom	Clé	Type	Description
Heure de début	begin_time	string	Heure de début inclusive de la requête sur opened_at, au format ISO 8601.
Heure de fin	end_time	string	Date de fin exclusive de la requête sur opened_at, au format ISO 8601.
Ordre de tri	sort_order	string	Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.
Cursor	cursor	string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
ID d’emplacement	location_id	string	Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.
Statut	status	string	S’il est spécifié, retourne uniquement les objets qui correspondent aux états spécifiés.
Type de Source	source_type	string	S’il est fourni, seuls les remboursements avec le type source donné sont retournés.
Limit	limit	integer	Limite supérieure du nombre à retourner dans la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Restitutions	refunds	array of object
ID	refunds.id	string	Identificateur unique émis par carré.
Statut	refunds.status	string	État de vérification actuel de cet objet.
Montant	refunds.amount_money.amount	integer	Montant.
Monnaie	refunds.amount_money.currency	string	La devise.
ID de paiement	refunds.payment_id	string	ID du paiement.
ID de commande	refunds.order_id	string	ID de l’ordre.
Créé à	refunds.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	refunds.updated_at	string	Horodatage de dernière modification au format RFC 3339
Frais de traitement	refunds.processing_fee	array of object
Effectif à	refunds.processing_fee.effective_at	string	Horodatage du moment où les frais prennent effet, au format RFC 3339.
Type	refunds.processing_fee.type	string	Type de cet objet.
Montant	refunds.processing_fee.amount_money.amount	integer	Montant.
Monnaie	refunds.processing_fee.amount_money.currency	string	La devise.
ID d’emplacement	refunds.location_id	string	Identificateur de l’emplacement.
Reason	refunds.reason	string	La raison pour laquelle le titulaire de carte a lancé le différend avec sa banque.
Cursor	cursor	string	Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Répertorier les segments de client

ID d’opération :: CustomerSegmentList

Récupère la liste des segments de clients d’une entreprise.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cursor	cursor		string	Curseur de pagination retourné par un appel précédent à ce point de terminaison.
Limit	limit		integer	Limite supérieure du nombre à retourner dans la réponse.

Retours

Nom	Chemin d’accès	Type	Description
Segments	segments	array of object
ID	segments.id	string	Identificateur unique émis par carré.
Nom	segments.name	string	Nom de l’objet.
Créé à	segments.created_at	string	Heure de l’événement au format ISO 8601.
Mise à jour à	segments.updated_at	string	Horodatage de dernière modification au format RFC 3339

Répertorier les événements d’abonnement

ID d’opération :: SubscriptionListEvents

Répertorie tous les événements d’un abonnement spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Identifiant d’abonnement	subscription_id	True	string	Identificateur de l’abonnement.

Retours

Nom	Chemin d’accès	Type	Description
Événements d’abonnement	subscription_events	array of object
ID	subscription_events.id	string	Identificateur unique émis par carré.
Type d’événement d’abonnement	subscription_events.subscription_event_type	string	Type de l’événement d’abonnement.
Date d’effet	subscription_events.effective_date	string	Date, au format AAAA-MM-DD, lorsque l’événement d’abonnement est entré en vigueur.
ID plan	subscription_events.plan_id	string	ID du plan d’abonnement associé

Soumettre des preuves

ID d’opération :: EvidenceSubmit

Soumet des preuves à la banque du titulaire de carte. Avant de soumettre une preuve, Square compile toutes les preuves disponibles. Cela inclut la preuve chargée à l’aide des points de terminaison CreateDisputeEvidenceFile et CreateDisputeEvidenceText et des preuves automatiquement fournies par Square, le cas échéant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.

Retours

Nom	Chemin d’accès	Type	Description
ID	dispute.id	string	Identificateur unique émis par carré.
Montant	dispute.amount_money.amount	integer	Montant.
Monnaie	dispute.amount_money.currency	string	La devise.
Reason	dispute.reason	string	Raison de cet objet.
État	dispute.state	string	État actuel.
Due At	dispute.due_at	string	Heure à laquelle l’action suivante est due, au format RFC 3339.
Paiements contestés	dispute.disputed_payments	array of object
ID de paiement	dispute.disputed_payments.payment_id	string	ID unique généré par carré du paiement.
Marque de carte	dispute.card_brand	string	La marque de la carte.
Créé à	dispute.created_at	string	Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.
Mise à jour à	dispute.updated_at	string	Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.
ID de litige de marque	dispute.brand_dispute_id	string	ID du litige dans le système de marque de carte, généré par la marque de carte.

Supprimer la facture

ID d’opération :: InvoiceDelete

Supprime la facture spécifiée. Lorsqu’une facture est supprimée, l’état de commande associé passe à CANCELED. Vous ne pouvez supprimer qu’une facture brouillon (vous ne pouvez pas supprimer une facture publiée, y compris une facture planifiée pour le traitement).

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID facture	invoice_id	True	string	Identificateur de la facture.
Version	version		integer	Version de la facture à supprimer.

Retours

response: object

Supprimer la preuve de litige

ID d’opération :: DisputeDeleteEvidence

Supprime la preuve spécifiée d’un litige.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de litige	dispute_id	True	string	Identificateur du litige.
ID de preuve	evidence_id	True	string	Identificateur de la preuve.

Retours

response: object

Supprimer le groupe du client

ID d’opération :: CustomerRemoveGroup

Supprime une appartenance à un groupe d’un client. Le client est identifié par la valeur customer_id et le groupe de clients est identifié par la valeur group_id.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de client	customer_id	True	string	Identificateur du client.
ID de groupe	group_id	True	string	Identificateur du groupe.

Retours

response: object

Supprimer l’objet catalogue

ID d’opération :: CatalogDelete

Supprime un seul CatalogObject en fonction de l’ID fourni et retourne l’ensemble d’ID supprimés correctement dans la réponse. La suppression est un événement en cascade, de sorte que tous les enfants de l’objet ciblé sont également supprimés. Par exemple, la suppression d’un CatalogItem supprime également tous ses enfants CatalogItemVariation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’objet	object_id	True	string	Identificateur de l’objet.

Retours

Nom	Chemin d’accès	Type	Description
ID d’objet supprimés	deleted_object_ids	array of string
Supprimé à	deleted_at	string	Horodatage de la base de données de cette suppression au format RFC 3339

Supprimer un client

ID d’opération :: CustomerDelete

Supprime un profil client d’une entreprise. Cette opération dissocie également toutes les cartes associées sur le fichier.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de client	customer_id	True	string	Identificateur du client.

Retours

response: object

Supprimer un groupe de clients

ID d’opération :: CustomerGroupDelete

Supprime un groupe de clients identifié par la valeur group_id.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	group_id	True	string	Identificateur du groupe.

Partager via

Paiements carrés (éditeur indépendant) (préversion)

Limitations

Actions

Abonnements de recherche

Paramètres

Retours

Accepter le différend

Paramètres

Retours

Ajouter un groupe au client

Paramètres

Retours

Annuler la facture

Paramètres

Retours

Annuler le paiement

Paramètres

Retours

Annuler le paiement par clé d’idempotency

Paramètres

Retours

Annuler le remboursement du terminal

Paramètres

Retours

Annuler l’abonnement

Paramètres

Retours

Annuler l’extraction du terminal

Paramètres

Retours

Calculer l’ordre (bêta)

Paramètres

Retours

Cartes de liste

Paramètres

Retours

Commandes de recherche

Paramètres

Retours

Commandes de récupération par lots

Paramètres

Retours

Créer un abonnement

Paramètres

Retours

Créer un client

Paramètres

Retours

Créer un extraction de terminal

Paramètres

Retours

Créer un groupe de clients

Paramètres

Retours

Créer un paiement

Paramètres

Retours

Créer un remboursement de terminal

Paramètres

Retours

Créer un texte de preuve de litige

Paramètres

Retours

Créer une carte

Paramètres

Retours

Créer une commande

Paramètres

Retours

Créer une facture

Paramètres

Retours

Désactiver la carte

Paramètres

Retours

Extractions de terminal de recherche

Paramètres

Retours

Informations de catalogue