Pagos cuadrados (publicador independiente) (versión preliminar)

Square ayuda a millones de vendedores a ejecutar su negocio, desde el procesamiento seguro de tarjetas de crédito hasta soluciones de punto de venta. Este conector contiene acciones para los siguientes puntos de conexión: Pagos, Terminal, Pedidos, Suscripciones, Facturas, Catálogo, Inventario y Clientes.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Troy Taylor
URL	https://www.hitachisolutions.com
Correo Electrónico	ttaylor@hitachisolutions.com

Metadatos del conector
Publicador	Troy Taylor
Website	https://squareup.com/
Directiva de privacidad	https://squareup.com/us/en/legal/general/privacy
Categorías	Comercio; Ventas y CRM

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Aceptar disputa	Acepta la pérdida en una disputa. Square devuelve la cantidad disputada al titular de la tarjeta y actualiza el estado de disputa a ACCEPTED. Square carga el importe disputado de la cuenta de Square del vendedor. Si la cuenta de Square no tiene fondos suficientes, Square carga la cuenta bancaria asociada.
Actualización de la factura	Actualiza una factura modificando campos, borrando campos o ambos.
Actualización del pago	Actualiza un pago con el estado APROBADO. Puede actualizar el amount_money y tip_money mediante este punto de conexión.
Actualizar cliente	Actualiza un perfil de cliente. Para cambiar un atributo, especifique el nuevo valor. Para quitar un atributo, especifique el valor como una cadena vacía o un objeto vacío.
Actualizar grupo de clientes	Actualiza un grupo de clientes.
Actualizar impuestos de artículos	Actualiza los objetos CatalogTax que se aplican al objeto CatalogItem de destino sin tener que realizar un upsert en todo el elemento.
Actualizar listas modificadores de elementos	Actualiza los objetos CatalogModifierList que se aplican al objeto CatalogItem de destino sin tener que realizar un upsert en todo el elemento.
Actualizar suscripción	Actualiza una suscripción. Puede establecer, modificar y borrar los valores del campo de suscripción.
Agregar grupo al cliente	Agrega una pertenencia a un grupo a un cliente. El cliente se identifica mediante el valor de customer_id y el grupo de clientes se identifica mediante el valor de group_id.
Buscar clientes	Busca los perfiles de cliente asociados a una cuenta de Square mediante un filtro de consulta compatible. Al llamar a SearchCustomers sin ningún filtro de consulta explícito, se devuelven todos los perfiles de cliente ordenados alfabéticamente en función de given_name y family_name.
Buscar desprotecciones del terminal	Recupera una lista filtrada de solicitudes de finalización de la compra del terminal creadas por la cuenta que realiza la solicitud.
Buscar facturas	Busca facturas desde una ubicación especificada en el filtro.
Buscar objetos de catálogo	Busca CatalogObject de cualquier tipo mediante la coincidencia de valores de atributo de búsqueda admitidos, excepto los valores de atributo personalizados en elementos o variaciones de elementos, en uno o varios de los filtros de consulta especificados.
Búsqueda de suscripciones	Busca suscripciones. Los resultados se ordenan cronológicamente por fecha de creación de la suscripción. Si la solicitud especifica más de un identificador de ubicación, el punto de conexión ordena el resultado por identificador de ubicación y, a continuación, por fecha de creación dentro de cada ubicación. Si no se proporcionan ubicaciones en la consulta, se buscarán todas las ubicaciones.
Calcular el orden (Beta)	Permite a las aplicaciones obtener una vista previa de los precios del pedido sin crear un pedido.
Cancelación de la finalización de la compra del terminal	Cancela una solicitud de desprotección del terminal si el estado de la solicitud lo permite.
Cancelación de la suscripción	Establece el campo canceled_date al final del período de facturación activo. Después de esta fecha, el estado cambia de ACTIVO a CANCELADO.
Cancelación del pago por clave de idempotency	Cancela (anula) un pago identificado por la clave de idempotency que se especifica en la solicitud. Use este método cuando se desconoce el estado de una solicitud CreatePayment (por ejemplo, después de enviar una solicitud CreatePayment, se produce un error de red y no recibe una respuesta). En este caso, puede dirigir a Square para cancelar el pago mediante este punto de conexión. En la solicitud, se proporciona la misma clave de idempoencia que proporcionó en la solicitud CreatePayment que desea cancelar. Después de cancelar el pago, puede volver a enviar la solicitud CreatePayment. Tenga en cuenta que si no se encuentra ningún pago con la clave de idempotency especificada, no se realiza ninguna acción y el punto de conexión se devuelve correctamente.
Cancelación del reembolso del terminal	Cancela una solicitud de reembolso del terminal interac por identificador de solicitud de reembolso si el estado de la solicitud lo permite.
Cancelar factura	Cancela una factura. El vendedor no puede cobrar los pagos de la factura cancelada.
Cancelar pago	Cancela (anula) un pago. Puede usar este punto de conexión para cancelar un pago con el estado APPROVED.
Catálogo de listas	Devuelve una lista de CatalogObjects que incluye todos los objetos de un conjunto de tipos deseados (por ejemplo, todos los objetos CatalogItem y CatalogTax) del catálogo. ListCatalog no devuelve elementos de catálogo eliminados.
Creación de la finalización de la compra del terminal	Crea una solicitud de desprotección de Terminal y la envía al dispositivo especificado para realizar un pago por el importe solicitado.
Creación de texto de evidencia de controversia	Carga el texto que se usará como evidencia para un desafío de disputa.
Creación de un grupo de clientes	Crea un nuevo grupo de clientes para una empresa.
Creación de una suscripción	Crea una suscripción para un cliente a un plan de suscripción. Si proporciona una tarjeta en el archivo en la solicitud, Square carga la tarjeta de la suscripción. De lo contrario, Square factura una factura a la dirección de correo electrónico del cliente. La suscripción se inicia inmediatamente, a menos que la solicitud incluya el start_date opcional. Cada suscripción individual está asociada a una ubicación determinada.
Crear cliente	Crea un nuevo cliente para una empresa.
Crear factura	Crea una factura de borrador para un pedido creado mediante orders API. Una factura de borrador permanece en su cuenta y no se realiza ninguna acción. Debe publicar la factura antes de que Square pueda procesarla (enviarla a la dirección de correo electrónico del cliente o cargar la tarjeta del cliente en el archivo).
Crear pago	Crea un pago mediante el origen proporcionado. Puede usar este punto de conexión para cargar una tarjeta (tarjeta de crédito/débito o tarjeta de regalo cuadrada) o registrar un pago que el vendedor recibió fuera de Square (pago en efectivo de un comprador o un pago que una entidad externa procesó en nombre del vendedor).
Crear pedido	Crea un nuevo pedido que puede incluir información sobre los productos de compra y configuración que se aplicarán a la compra.
Crear reembolso de terminal	Crea una solicitud para reembolsar un pago interac completado en una terminal cuadrada.
Crear tarjeta	Agrega una tarjeta en el archivo a un comerciante existente.
Deshabilitar tarjeta	Deshabilita la tarjeta, evitando actualizaciones o cargos adicionales. Se permite deshabilitar una tarjeta ya deshabilitada, pero no tiene ningún efecto.
Eliminación por lotes de objetos de catálogo	Elimina un conjunto de catalogItems en función de la lista proporcionada de identificadores de destino y devuelve un conjunto de identificadores eliminados correctamente en la respuesta.
Eliminar cliente	Elimina un perfil de cliente de una empresa. Esta operación también desvincula las tarjetas asociadas en el archivo.
Eliminar evidencia de controversia	Quita las pruebas especificadas de una disputa.
Eliminar factura	Elimina la factura especificada. Cuando se elimina una factura, el estado del pedido asociado cambia a CANCELED. Solo puede eliminar una factura de borrador (no se puede eliminar una factura publicada, incluida una programada para su procesamiento).
Eliminar grupo de clientes	Elimina un grupo de clientes identificado por el valor de group_id.
Eliminar objeto de catálogo	Elimina un único CatalogObject basado en el identificador proporcionado y devuelve el conjunto de identificadores eliminados correctamente en la respuesta. La eliminación es un evento en cascada de modo que también se eliminen todos los elementos secundarios del objeto de destino. Por ejemplo, al eliminar un objeto CatalogItem también se eliminarán todos sus elementos secundarios CatalogItemVariation.
Enumerar clientes	Enumera los perfiles de cliente asociados a una cuenta de Square. En condiciones de funcionamiento normales, los perfiles de cliente recién creados o actualizados estarán disponibles para la operación de descripción en menos de 30 segundos. En ocasiones, la propagación de los perfiles nuevos o actualizados puede tardar más de un minuto o más, especialmente durante incidentes y interrupciones de red.
Enumerar controversias	Devuelve una lista de disputas asociadas a una cuenta determinada.
Enumerar eventos de suscripción	Enumera todos los eventos de una suscripción específica.
Enumerar evidencia de controversias	Devuelve una lista de pruebas asociadas a una disputa.
Enumerar facturas	Devuelve una lista de facturas para una ubicación determinada.
Enumerar grupos de clientes	Recupera la lista de grupos de clientes de una empresa.
Enumerar pagos	Recupera una lista de pagos tomados por la cuenta que realiza la solicitud. Los resultados son finalmente coherentes y los nuevos pagos o cambios en los pagos pueden tardar varios segundos en aparecer.
Enumerar reembolsos de pago	Recupera una lista de reembolsos para la cuenta que realiza la solicitud. Los resultados son finalmente coherentes y los nuevos reembolsos o cambios en los reembolsos pueden tardar varios segundos en aparecer.
Enumerar segmentos de clientes	Recupera la lista de segmentos de cliente de una empresa.
Enumerar tarjetas	Recupera una lista de tarjetas propiedad de la cuenta que realiza la solicitud.
Enviar evidencia	Envía pruebas al banco del titular de la tarjeta. Antes de enviar pruebas, Square compila todas las pruebas disponibles. Esto incluye pruebas cargadas mediante los puntos de conexión CreateDisputeEvidenceFile y CreateDisputeEvidenceText y las pruebas proporcionadas automáticamente por Square, cuando están disponibles.
Información del catálogo	Recupera información sobre square Catalog API, como los límites de tamaño de lote que puede usar el punto de conexión batchUpsertCatalogObjects.
Inventario de cambios por lotes	Aplica ajustes y recuentos a las cantidades de artículos proporcionadas. Si se ejecuta correctamente: devuelve los recuentos calculados actuales de todos los objetos a los que se hace referencia en la solicitud.
Obtención de la factura	Recupera una factura por identificador de factura.
Obtención de la finalización de la compra del terminal	Recupera una solicitud de desprotección de Terminal checkout_id.
Obtención del reembolso del pago	Recupera un reembolso específico mediante el refund_id.
Obtención del reembolso del terminal	Recupera un objeto de reembolso de Terminal Interac por identificador.
Obtener pago	Recupera los detalles de un pago específico.
Orden de actualización (beta)	Actualiza un pedido abierto agregando, reemplazando o eliminando campos. Los pedidos con un estado COMPLETED o CANCELED no se pueden actualizar.
Orden de clonación (beta)	Crea un nuevo orden, en el estado DRAFT, duplicando un orden existente. El pedido recién creado solo tiene los campos principales (como los artículos de línea, los impuestos y los descuentos) copiados del pedido original.
Pago completo	Completa (captura) un pago. De forma predeterminada, los pagos se establecen para completarse inmediatamente después de crearse.
Pago de reembolso	Devuelve un pago. Puede reembolsar el importe de pago completo o una parte de él. Puede usar este punto de conexión para reembolsar un pago con tarjeta o registrar un reembolso de un pago en efectivo o externo.
Pedido de pago (beta)	Pague un pedido con uno o más pagos aprobados o liquide un pedido con un total de 0. El total del payment_ids enumerado en la solicitud debe ser igual al total del pedido. Los pedidos con un importe total de 0 se pueden marcar como pagados especificando una matriz vacía de payment_ids en la solicitud.
Pedidos de búsqueda	Busque todos los pedidos de una o varias ubicaciones. Los pedidos incluyen todas las ventas, devoluciones e intercambios independientemente de cómo o cuando entraron en el ecosistema square (como las API punto de venta, facturas y Connect).
Procesamiento por lotes de objetos de catálogo upsert	Crea o actualiza hasta 10 000 objetos de destino en función de la lista de objetos proporcionada. Los objetos de destino se agrupan en lotes y cada lote se inserta o actualiza de forma total o nada. Si un objeto dentro de un lote tiene un formato incorrecto o infringe una restricción de base de datos, se omitirá todo el lote que contiene ese elemento. Sin embargo, es posible que otros lotes de la misma solicitud se realicen correctamente. Cada lote puede contener hasta 1000 objetos y los lotes se procesarán en orden siempre que el número total de objetos para la solicitud (elementos, variaciones, listas modificadoras, descuentos e impuestos) no sea superior a 10 000.
Publicar factura	Publica la factura de borrador especificada. Una vez publicada una factura, Square se rige por la configuración de la factura. Por ejemplo, Square envía la factura a la dirección de correo electrónico del cliente, cobra la tarjeta del cliente en el archivo o no hace nada. Square también hace que la factura esté disponible en una página de factura hospedada en Square.
Quitar grupo del cliente	Quita una pertenencia a un grupo de un cliente. El cliente se identifica mediante el valor de customer_id y el grupo de clientes se identifica mediante el valor de group_id.
Reanudación de la suscripción	Reanuda una suscripción desactivada.
Recuentos de inventario de recuperación por lotes	Devuelve los recuentos actuales de los objetos CatalogObject proporcionados en las ubicaciones solicitadas.
Recuperación de la suscripción	Recupera una suscripción.
Recuperación de la transferencia de inventario (Beta)	Devuelve el objeto InventoryTransfer con el transfer_id proporcionado.
Recuperación de objetos de catálogo por lotes	Devuelve un conjunto de objetos basado en el identificador proporcionado. Cada catalogItem devuelto en el conjunto incluye toda su información secundaria, incluyendo: todos sus objetos CatalogItemVariation, referencias a sus objetos CatalogModifierList y los identificadores de los objetos CatalogTax que se aplican a él.
Recuperación del ajuste de inventario	Devuelve el objeto InventoryAdjustment con el adjustment_id proporcionado.
Recuperación del cliente	Devuelve los detalles de un solo cliente.
Recuperación del grupo de clientes	Recupera un grupo de clientes específico.
Recuperación del recuento de inventario	Recupera el recuento de existencias calculado actual para un catalogObject determinado en un conjunto determinado de ubicaciones.
Recuperación del recuento físico de inventario	Devuelve el objeto InventoryPhysicalCount con el physical_count_id proporcionado.
Recuperación del segmento de cliente	Recupera un segmento de cliente específico.
Recuperación por lotes de cambios de inventario	Devuelve recuentos físicos históricos y ajustes en función de los criterios de filtro proporcionados.
Recuperar disputa	Devuelve detalles sobre una disputa específica.
Recuperar evidencia de controversia	Devuelve los metadatos de evidencia especificados por el identificador de evidencia en la ruta de acceso de la dirección URL de la solicitud. Debe mantener una copia de la evidencia que cargue si desea hacer referencia a ella más adelante. No puede descargar la evidencia después de cargarla.
Recuperar objeto de catálogo	Devuelve un único CatalogItem como catalogObject basado en el identificador proporcionado. El objeto devuelto incluye toda la información catalogItem pertinente, incluidos los elementos secundarios CatalogItemVariation, las referencias a sus objetos CatalogModifierList y los identificadores de los objetos CatalogTax que se aplican a él.
Recuperar pedido	Recupera un pedido por identificador.
Recuperar pedidos por lotes	Recupera un conjunto de pedidos por sus identificadores. Si no existe un identificador de pedido determinado, se omite el identificador en lugar de generar un error.
Recuperar tarjeta	Recupera los detalles de una tarjeta específica.
Reembolsos del terminal de búsqueda	Recupera una lista filtrada de solicitudes de reembolso de Terminal Interac creadas por el vendedor que realiza la solicitud.
Registro de dominio para Apple Pay	Activa un dominio para su uso con Apple Pay en la Web y Square. Apple realiza una validación en este dominio para asegurarse de que está configurado correctamente como un dominio habilitado para Apple Pay.
Upsert catalog (objeto)	Crea o actualiza el CatalogObject de destino.

Aceptar disputa

Id. de la operación:: DisputeAccept

Acepta la pérdida en una disputa. Square devuelve la cantidad disputada al titular de la tarjeta y actualiza el estado de disputa a ACCEPTED. Square carga el importe disputado de la cuenta de Square del vendedor. Si la cuenta de Square no tiene fondos suficientes, Square carga la cuenta bancaria asociada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	dispute.id	string	Identificador único emitido por Square.
Importe	dispute.amount_money.amount	integer	Cantidad.
Moneda	dispute.amount_money.currency	string	Moneda.
Motivo	dispute.reason	string	Motivo de este objeto.
Estado	dispute.state	string	Estado actual.
Vencimiento a	dispute.due_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.
Pagos disputados	dispute.disputed_payments	array of object
Identificador de pago	dispute.disputed_payments.payment_id	string	Identificador único generado por cuadrados del pago.
Marca de tarjeta	dispute.card_brand	string	La marca de la tarjeta.
Creado en	dispute.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	dispute.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de disputa de marca	dispute.brand_dispute_id	string	El identificador de la disputa en el sistema de marca de tarjeta, generado por la marca de tarjeta.

Actualización de la factura

Id. de la operación:: InvoiceUpdate

Actualiza una factura modificando campos, borrando campos o ambos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de factura	invoice_id	True	string	Identificador de la factura.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
UID	uid		string	Identificador generado por square.
Propina habilitada	tipping_enabled		boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Campos que se van a borrar	fields_to_clear		array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	invoice.id	string	Identificador único emitido por Square.
Versión	invoice.version	integer	La versión actual de este objeto.
Id. de ubicación	invoice.location_id	string	Identificador de la ubicación.
Id. de pedido	invoice.order_id	string	Identificador del pedido.
Solicitudes de pago	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identificador generado por square.
Tipo de solicitud	invoice.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoice.payment_requests.due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	invoice.payment_requests.tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Importe	invoice.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoice.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoice.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Número de factura	invoice.invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	invoice.title	string	Título.
Description	invoice.description	string	Descripción.
Programado en	invoice.scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Estado	invoice.status	string	Estado de comprobación actual de este objeto.
Timezone	invoice.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoice.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	invoice.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de cliente	invoice.primary_recipient.customer_id	string	Identificador del cliente asociado al pedido.
Nombre propio	invoice.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoice.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoice.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoice.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Importe	invoice.next_payment_amount_money.amount	integer	Cantidad.
Moneda	invoice.next_payment_amount_money.currency	string	Moneda.
Card	invoice.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoice.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoice.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoice.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoice.custom_fields.placement	string	Ubicación del campo personalizado en la factura.
Delivery (método)	invoice.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Fecha de venta o servicio	invoice.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Actualización del pago

Id. de la operación:: PaymentUpdate

Actualiza un pago con el estado APROBADO. Puede actualizar el amount_money y tip_money mediante este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de pago	payment_id	True	string	Identificador del pago.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Token de versión	version_token		string	Este token opaco identifica una versión específica del objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	payment.id	string	Identificador único emitido por Square.
Creado en	payment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	payment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	payment.amount_money.amount	integer	Cantidad.
Moneda	payment.amount_money.currency	string	Moneda.
Importe	payment.tip_money.amount	integer	Cantidad.
Moneda	payment.tip_money.currency	string	Moneda.
Estado	payment.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payment.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago. Esta delay_action automática solo se aplica a los pagos que no alcanzan un estado terminal (COMPLETADO, CANCELADO o FAILED) antes del período de tiempo de delay_duration. Este campo se especifica como una duración de tiempo, en formato RFC 3339.
Tipo de origen	payment.source_type	string	Tipo de origen para este pago. Los valores actuales incluyen CARD, BANK_ACCOUNT, WALLET, CASH o EXTERNAL.
Estado	payment.card_details.status	string	Estado actual.
Marca de tarjeta	payment.card_details.card.card_brand	string	La marca de la tarjeta.
Últimos 4	payment.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payment.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payment.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payment.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payment.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payment.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payment.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Entry (método)	payment.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de CVV	payment.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de AVS	payment.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payment.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payment.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payment.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Id. de ubicación	payment.location_id	string	Identificador de la ubicación.
Id. de pedido	payment.order_id	string	Identificador del pedido.
Creado en	payment.risk_evaluation.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Nivel de riesgo	payment.risk_evaluation.risk_level	string	Nivel de riesgo asociado al pago.
Nota:	payment.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de cliente	payment.customer_id	string	Identificador de este objeto que representa al cliente.
Importe	payment.total_money.amount	integer	Cantidad.
Moneda	payment.total_money.currency	string	Moneda.
Importe	payment.approved_money.amount	integer	Cantidad.
Moneda	payment.approved_money.currency	string	Moneda.
Capabilities	payment.capabilities	array of string
Número de recibo	payment.receipt_number	string	Número de recibo del pago. Falta el campo si se cancela un pago.
Acción de retraso	payment.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payment.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Square Product	payment.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payment.application_details.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Token de versión	payment.version_token	string	Este token opaco identifica una versión específica del objeto.

Actualizar cliente

Id. de la operación:: CustomerUpdate

Actualiza un perfil de cliente. Para cambiar un atributo, especifique el nuevo valor. Para quitar un atributo, especifique el valor como una cadena vacía o un objeto vacío.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente	customer_id	True	string	Identificador del cliente.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	customer.id	string	Identificador único emitido por Square.
Creado en	customer.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	customer.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Nombre propio	customer.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	customer.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	customer.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Línea de dirección 1	customer.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	customer.address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	customer.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	customer.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	customer.address.postal_code	string	El código postal de la dirección.
País	customer.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Identificador de referencia	customer.reference_id	string	Identificador de referencia definido por el usuario opcional.
Nota:	customer.note	string	Una nota personalizada asociada al perfil de cliente.
Correo electrónico cancelado	customer.preferences.email_unsubscribed	boolean	Indica si el cliente ha cancelado la suscripción a los correos electrónicos de campaña de marketing. Un valor true significa que el cliente eligió no participar en el marketing por correo electrónico del vendedor actual de Square o de todos los vendedores de Square.
Origen de creación	customer.creation_source	string	Un origen de creación representa el método usado para crear el perfil de cliente.
Versión	customer.version	integer	La versión actual de este objeto.

Actualizar grupo de clientes

Id. de la operación:: CustomerGroupUpdate

Actualiza un grupo de clientes.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	group_id	True	string	Identificador del grupo.
Nombre	name		string	Nombre del objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	group.id	string	Identificador único emitido por Square.
Nombre	group.name	string	Nombre del objeto.
Creado en	group.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	group.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Actualizar impuestos de artículos

Id. de la operación:: CatalogUpdateTaxes

Actualiza los objetos CatalogTax que se aplican al objeto CatalogItem de destino sin tener que realizar un upsert en todo el elemento.

Parámetros

Nombre	Clave	Tipo
Identificadores de elemento	item_ids	array of string
Impuestos para habilitar	taxes_to_enable	array of string
Impuestos para deshabilitar	taxes_to_disable	array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Actualizado en	updated_at	string	Marca de tiempo de la base de datos de esta actualización en formato RFC 3339.

Actualizar listas modificadores de elementos

Id. de la operación:: CatalogUpdateModifier

Actualiza los objetos CatalogModifierList que se aplican al objeto CatalogItem de destino sin tener que realizar un upsert en todo el elemento.

Parámetros

Nombre	Clave	Tipo
Identificadores de elemento	item_ids	array of string
Listas modificadores para habilitar	modifier_lists_to_enable	array of string
Listas modificadores para deshabilitar	modifier_lists_to_disable	array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Actualizado en	updated_at	string	Marca de tiempo de la base de datos de esta actualización en formato RFC 3339.

Actualizar suscripción

Id. de la operación:: SubscriptionUpdate

Actualiza una suscripción. Puede establecer, modificar y borrar los valores del campo de suscripción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscription_id	True	string	Identificador de la suscripción.
Versión	version		integer	La versión actual de este objeto.
Porcentaje fiscal	tax_percentage		string	Importe fiscal aplicado al facturar la suscripción.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	subscription.id	string	Identificador único emitido por Square.
Id. de ubicación	subscription.location_id	string	Identificador de la ubicación.
Id. de plan	subscription.plan_id	string	Identificador del plan de suscripción asociado.
Id. de cliente	subscription.customer_id	string	Identificador de este objeto que representa al cliente.
Estado	subscription.status	string	Estado de comprobación actual de este objeto.
Importe	subscription.price_override_money.amount	integer	Cantidad.
Moneda	subscription.price_override_money.currency	string	Moneda.
Versión	subscription.version	integer	La versión actual de este objeto.
Creado en	subscription.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Timezone	subscription.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscription.source.name	string	Nombre.

Agregar grupo al cliente

Id. de la operación:: CustomerAddGroup

Agrega una pertenencia a un grupo a un cliente. El cliente se identifica mediante el valor de customer_id y el grupo de clientes se identifica mediante el valor de group_id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente	customer_id	True	string	Identificador del cliente.
Identificador de grupo	group_id	True	string	Identificador del grupo.

Devoluciones

response: object

Buscar clientes

Id. de la operación:: CustomerSearch

Busca los perfiles de cliente asociados a una cuenta de Square mediante un filtro de consulta compatible. Al llamar a SearchCustomers sin ningún filtro de consulta explícito, se devuelven todos los perfiles de cliente ordenados alfabéticamente en función de given_name y family_name.

Parámetros

Nombre	Clave	Tipo	Description
Borroso	fuzzy	string	Use el filtro aproximado para seleccionar los clientes cuyos atributos coinciden con la consulta especificada de forma aproximada. Cuando se usa la opción aproximada, las consultas de búsqueda se tokenizan y, a continuación, cada token de consulta debe coincidir en algún lugar del atributo buscado. En el caso de las consultas de token único, este es el mismo comportamiento que una operación de coincidencia parcial.
Valores	values	array of string
Rule	rule	string	Indica si un perfil de cliente que coincide con los criterios de filtro debe incluirse en el resultado o excluirse del resultado.
Comenzar a	start_at	string	Valor datetime en formato RFC 3339 que indica cuándo se inicia el intervalo de tiempo.
Finalizar al	end_at	string	Valor datetime en formato RFC 3339 que indica cuándo finaliza el intervalo de tiempo.
Todos	all	array of string
Campo	field	string	Use uno o varios atributos de cliente como clave de ordenación para ordenar los perfiles de cliente buscados.
Pedido	order	string	Indica el orden en el que se deben ordenar los resultados en función del valor del campo de ordenación. Las cadenas usan la comparación alfabética estándar para determinar el orden.
Limit	limit	integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Clientela	customers	array of object
identificación	customers.id	string	Identificador único emitido por Square.
Creado en	customers.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	customers.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Nombre propio	customers.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	customers.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	customers.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Línea de dirección 1	customers.address.address_line_1	string	Primera línea de la dirección.
Línea de dirección 2	customers.address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	customers.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	customers.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	customers.address.postal_code	string	El código postal de la dirección.
País	customers.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Número de teléfono	customers.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificador de referencia	customers.reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Correo electrónico cancelado	customers.preferences.email_unsubscribed	boolean	Indica si el cliente ha cancelado la suscripción a los correos electrónicos de campaña de marketing. Un valor true significa que el cliente eligió no participar en el marketing por correo electrónico del vendedor actual de Square o de todos los vendedores de Square. Este valor es de solo lectura de la API Customers.
Origen de creación	customers.creation_source	string	Un origen de creación representa el método usado para crear el perfil de cliente.
Identificadores de grupo	customers.group_ids	array of string
Identificadores de segmento	customers.segment_ids	array of string
Versión	customers.version	integer	Versión actual del objeto.
Nota:	customers.note	string	Una nota personalizada asociada al perfil de cliente.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Buscar desprotecciones del terminal

Id. de la operación:: TerminalSearchCheckouts

Recupera una lista filtrada de solicitudes de finalización de la compra del terminal creadas por la cuenta que realiza la solicitud.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.
Estado	status		string	Estado actual.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Desprotecciones	checkouts	array of object
identificación	checkouts.id	string	Identificador único emitido por Square.
Importe	checkouts.amount_money.amount	integer	Cantidad.
Moneda	checkouts.amount_money.currency	string	Moneda.
Identificador de referencia	checkouts.reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Nota:	checkouts.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de dispositivo	checkouts.device_options.device_id	string	El identificador único del dispositivo destinado a este TerminalCheckout.
Permitir propina	checkouts.device_options.tip_settings.allow_tipping	boolean	Indica si la propina está habilitada para esta desprotección. El valor predeterminado es False.
Omitir pantalla de recepción	checkouts.device_options.skip_receipt_screen	boolean	Indica al dispositivo que omita la pantalla de recepción. El valor predeterminado es False.
Estado	checkouts.status	string	Estado de comprobación actual de este objeto.
Identificadores de pago	checkouts.payment_ids	array of string
Creado en	checkouts.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	checkouts.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Identificador de aplicación	checkouts.app_id	string	Identificador de la aplicación que creó la desprotección.
Duración de la fecha límite	checkouts.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Buscar facturas

Id. de la operación:: InvoiceSearch

Busca facturas desde una ubicación especificada en el filtro.

Parámetros

Nombre	Clave	Tipo	Description
Identificadores de ubicación	location_ids	array of string
Identificadores de cliente	customer_ids	array of string
Campo	field	string	Use uno o varios atributos de cliente como clave de ordenación para ordenar los perfiles de cliente buscados.
Pedido	order	string	Indica el orden en el que se deben ordenar los resultados en función del valor del campo de ordenación. Las cadenas usan la comparación alfabética estándar para determinar el orden.
Limit	limit	integer	El número máximo de facturas que se van a devolver (200 es el límite máximo). Si no se proporciona, el servidor usa un límite predeterminado de 100 facturas.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Invoices	invoices	array of object
identificación	invoices.id	string	Identificador único emitido por Square.
Versión	invoices.version	integer	Versión actual del objeto.
Id. de ubicación	invoices.location_id	string	Identificador de la ubicación.
Id. de pedido	invoices.order_id	string	Identificador del pedido.
Solicitudes de pago	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Identificador generado por Square de la solicitud de pago en una factura.
Tipo de solicitud	invoices.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoices.payment_requests.due_date	string	Fecha de vencimiento (en la zona horaria de la factura) para la solicitud de pago, en formato AAAA-MM-DD.
Propina habilitada	invoices.payment_requests.tipping_enabled	boolean	Si se establece en true, la página de factura hospedada en Cuadrado (el campo public_url de la factura) proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoices.payment_requests.reminders	array of object	Recordatorios
UID	invoices.payment_requests.reminders.uid	string	Un identificador asignado a Square que identifica de forma única el aviso dentro de InvoicePaymentRequest.
Días programados relativos	invoices.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoices.payment_requests.reminders.message	string	Mensaje de recordatorio.
Estado	invoices.payment_requests.reminders.status	string	Estado del aviso.
Importe	invoices.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoices.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoices.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoices.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoices.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Porcentaje solicitado	invoices.payment_requests.percentage_requested	string	Especifica el importe de la solicitud de pago en porcentaje.
Id. de tarjeta	invoices.payment_requests.card_id	string	El identificador de la tarjeta de crédito o débito en el archivo para cobrar por la solicitud de pago.
Número de factura	invoices.invoice_number	string	Número de factura fácil de usar.
Title	invoices.title	string	Título de la factura.
Description	invoices.description	string	Descripción.
Programado en	invoices.scheduled_at	string	Marca de tiempo cuando la factura está programada para su procesamiento, en formato RFC 3339. Una vez publicada la factura, Square procesa la factura en la fecha especificada, según la configuración de la solicitud de pago y el método de entrega.
Estado	invoices.status	string	Estado de comprobación actual de este objeto.
Timezone	invoices.timezone	string	Zona horaria usada para interpretar las fechas del calendario en la factura, como due_date. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoices.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	invoices.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Id. de cliente	invoices.primary_recipient.customer_id	string	Identificador de un cliente que se va a asociar a la tarjeta.
Nombre propio	invoices.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoices.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoices.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoices.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Card	invoices.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoices.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoices.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoices.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoices.custom_fields.placement	string	Ubicación del campo personalizado en la factura
Delivery (método)	invoices.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente.
Fecha de venta o servicio	invoices.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.
Dirección URL pública	invoices.public_url	string	Dirección URL de la página de factura hospedada en Square. Después de publicar la factura mediante el punto de conexión PublishInvoice, Square hospeda la página de factura y devuelve la dirección URL de la página en la respuesta.
Importe	invoices.next_payment_amount_money.amount	integer	Cantidad.
Moneda	invoices.next_payment_amount_money.currency	string	Moneda.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Buscar objetos de catálogo

Id. de la operación:: CatalogSearch

Busca CatalogObject de cualquier tipo mediante la coincidencia de valores de atributo de búsqueda admitidos, excepto los valores de atributo personalizados en elementos o variaciones de elementos, en uno o varios de los filtros de consulta especificados.

Parámetros

Nombre	Clave	Tipo	Description
Tipos de objeto	object_types	array of string
Nombre del atributo	attribute_name	string	Nombre del atributo que se va a buscar.
Prefijo de atributo	attribute_prefix	string	Prefijo deseado del valor del atributo de búsqueda.
Limit	limit	integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	El tipo de este objeto.
identificación	objects.id	string	Identificador único emitido por Square.
Actualizado en	objects.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.version	integer	Versión actual del objeto.
Está eliminado	objects.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	objects.item_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Description	objects.item_data.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Id. de categoría	objects.item_data.category_id	string	Identificador de la categoría del elemento, si existe.
Tipo de producto	objects.item_data.product_type	string	La expresión de consulta de tipos de producto para devolver elementos o variaciones de elementos que tienen los tipos de producto especificados.
Números de Identificación Fiscal	objects.item_data.tax_ids	array of string
Variaciones	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	El tipo de este objeto. Cada tipo de objeto tiene propiedades esperadas expresadas en un formato estructurado dentro de su campo *_data correspondiente a continuación.
identificación	objects.item_data.variations.id	string	Identificador para hacer referencia a este objeto.
Actualizado en	objects.item_data.variations.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.item_data.variations.version	integer	Versión del objeto . Al actualizar un objeto, la versión proporcionada debe coincidir con la versión de la base de datos; de lo contrario, la escritura se rechazará como en conflicto.
Está eliminado	objects.item_data.variations.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.item_data.variations.present_at_all_locations	boolean	Lista de ubicaciones en las que está presente el objeto, incluso si present_at_all_locations es false. Esto puede incluir ubicaciones desactivadas.
Id. de elemento	objects.item_data.variations.item_variation_data.item_id	string	Identificador del objeto con esta variación de elemento.
Nombre	objects.item_data.variations.item_variation_data.name	string	Nombre de este elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Orden en el que se debe mostrar esta variación de elemento. Este valor es de solo lectura.
Importe	objects.item_data.variations.item_variation_data.price_money.amount	integer	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda. Por ejemplo, cuando la moneda es USD, la cantidad está en centavos. Las cantidades monetarias pueden ser positivas o negativas. Vea la descripción de campo específica para determinar el significado del inicio de sesión en un caso determinado.
Moneda	objects.item_data.variations.item_variation_data.price_money.currency	string	Tipo de moneda, en formato ISO 4217. Por ejemplo, el código de moneda para dólares estadounidenses es USD.
Tipo de precios	objects.item_data.variations.item_variation_data.pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Visibilidad	objects.item_data.visibility	string	Visibilidad.

Búsqueda de suscripciones

Id. de la operación:: SubscriptionSearch

Busca suscripciones. Los resultados se ordenan cronológicamente por fecha de creación de la suscripción. Si la solicitud especifica más de un identificador de ubicación, el punto de conexión ordena el resultado por identificador de ubicación y, a continuación, por fecha de creación dentro de cada ubicación. Si no se proporcionan ubicaciones en la consulta, se buscarán todas las ubicaciones.

Parámetros

Nombre	Clave	Tipo
Identificadores de ubicación	location_ids	array of string
Identificadores de cliente	customer_ids	array of string
Nombres de origen	source_names	array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Suscripciones	subscriptions	array of object
identificación	subscriptions.id	string	Identificador único emitido por Square.
Id. de ubicación	subscriptions.location_id	string	Identificador de la ubicación.
Id. de plan	subscriptions.plan_id	string	Identificador del plan de suscripción asociado
Id. de cliente	subscriptions.customer_id	string	Identificador asignado a Square del cliente asociado a la cuenta.
Fecha de inicio	subscriptions.start_date	string	La fecha de inicio de la suscripción, en formato aaaa-MM-DD.
Fecha cancelada	subscriptions.canceled_date	string	La fecha de cancelación de la suscripción, en formato AAAA-MM-DD.
Fecha de cargo	subscriptions.charged_through_date	string	Fecha hasta la que se factura al cliente para la suscripción, en formato aaaa-MM-DD.
Estado	subscriptions.status	string	Estado de comprobación actual de este objeto.
Creado en	subscriptions.created_at	string	Hora del evento en formato ISO 8601.
Id. de tarjeta	subscriptions.card_id	string	Identificador de la tarjeta de cliente que se cobra por la suscripción.
Fecha de pago hasta la fecha	subscriptions.paid_until_date	string	Fecha de pago hasta.
Timezone	subscriptions.timezone	string	Zona horaria usada para interpretar las fechas del calendario en la factura, como due_date. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscriptions.source.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje fiscal	subscriptions.tax_percentage	string	Importe fiscal aplicado al facturar la suscripción.
Importe	subscriptions.price_override_money.amount	integer	Cantidad.
Moneda	subscriptions.price_override_money.currency	string	Moneda.
Versión	subscriptions.version	integer	Versión actual del objeto.
Identificadores de factura	subscriptions.invoice_ids	array of string

Calcular el orden (Beta)

Id. de la operación:: OrderCalculate

Permite a las aplicaciones obtener una vista previa de los precios del pedido sin crear un pedido.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de ubicación	location_id	string	Identificador de la ubicación.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje	percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Ámbito	scope	string	Indica el nivel actual.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Cantidad	quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Elementos de línea	order.line_items	array of object
UID	order.line_items.uid	string	Identificador generado por square.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Importe	order.line_items.variation_total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.variation_total_price_money.currency	string	Moneda.
Descuentos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Un identificador asignado a Cuadrado.
UID de descuento	order.line_items.applied_discounts.discount_uid	string	Interfaz de usuario del descuento que representa el descuento aplicado.
Importe	order.line_items.applied_discounts.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_discounts.applied_money.currency	string	Moneda.
Descuentos	order.discounts	array of object
UID	order.discounts.uid	string	Identificador generado por square.
Nombre	order.discounts.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje	order.discounts.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.discounts.applied_money.amount	integer	Cantidad.
Moneda	order.discounts.applied_money.currency	string	Moneda.
Tipo	order.discounts.type	string	Indica el tipo.
Ámbito	order.discounts.scope	string	Indica el nivel actual.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Estado	order.state	string	Estado actual.
Versión	order.version	integer	La versión actual de este objeto.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Importe	order.total_tip_money.amount	integer	Cantidad.
Moneda	order.total_tip_money.currency	string	Moneda.
Importe	order.total_money.amount	integer	Cantidad.
Moneda	order.total_money.currency	string	Moneda.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.tip_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tip_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.

Cancelación de la finalización de la compra del terminal

Id. de la operación:: TerminalCancelCheckout

Cancela una solicitud de desprotección del terminal si el estado de la solicitud lo permite.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de desprotección	checkout_id	True	string	Identificador de la desprotección.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	checkout.id	string	Identificador único emitido por Square.
Importe	checkout.amount_money.amount	integer	Cantidad.
Moneda	checkout.amount_money.currency	string	Moneda.
Identificador de referencia	checkout.reference_id	string	Identificador de referencia definido por el usuario opcional.
Id. de dispositivo	checkout.device_options.device_id	string	El identificador único del dispositivo destinado a este TerminalCheckout.
Permitir propina	checkout.device_options.tip_settings.allow_tipping	boolean	Indica si la propina está habilitada para esta desprotección. El valor predeterminado es False.
Omitir pantalla de recepción	checkout.device_options.skip_receipt_screen	boolean	Indica al dispositivo que omita la pantalla de recepción. El valor predeterminado es False.
Estado	checkout.status	string	Estado de comprobación actual de este objeto.
Motivo de cancelación	checkout.cancel_reason	string	Motivo de la transacción cancelada.
Creado en	checkout.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	checkout.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	checkout.app_id	string	Identificador de la aplicación que creó la desprotección.
Duración de la fecha límite	checkout.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación

Cancelación de la suscripción

Id. de la operación:: SubscriptionCancel

Establece el campo canceled_date al final del período de facturación activo. Después de esta fecha, el estado cambia de ACTIVO a CANCELADO.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscription_id	True	string	Identificador de la suscripción.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	subscription.id	string	Identificador único emitido por Square.
Id. de ubicación	subscription.location_id	string	Identificador de la ubicación.
Id. de plan	subscription.plan_id	string	Identificador del plan de suscripción asociado.
Id. de cliente	subscription.customer_id	string	Identificador de este objeto que representa al cliente.
Id. de tarjeta	subscription.card_id	string	Identificador de la tarjeta de cliente que se cobra por la suscripción.
Fecha de inicio	subscription.start_date	string	La fecha de inicio de la suscripción, en formato aaaa-MM-DD.
Fecha cancelada	subscription.canceled_date	string	La fecha de cancelación de la suscripción, en formato AAAA-MM-DD.
Fecha de pago hasta la fecha	subscription.paid_until_date	string	Fecha de pago hasta.
Estado	subscription.status	string	Estado de comprobación actual de este objeto.
Creado en	subscription.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Versión	subscription.version	integer	La versión actual de este objeto.
Timezone	subscription.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscription.source.name	string	Nombre.

Cancelación del pago por clave de idempotency

Id. de la operación:: PaymentCancelIdempotency

Cancela (anula) un pago identificado por la clave de idempotency que se especifica en la solicitud. Use este método cuando se desconoce el estado de una solicitud CreatePayment (por ejemplo, después de enviar una solicitud CreatePayment, se produce un error de red y no recibe una respuesta). En este caso, puede dirigir a Square para cancelar el pago mediante este punto de conexión. En la solicitud, se proporciona la misma clave de idempoencia que proporcionó en la solicitud CreatePayment que desea cancelar. Después de cancelar el pago, puede volver a enviar la solicitud CreatePayment. Tenga en cuenta que si no se encuentra ningún pago con la clave de idempotency especificada, no se realiza ninguna acción y el punto de conexión se devuelve correctamente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

response: object

Cancelación del reembolso del terminal

Id. de la operación:: TerminalCancelRefund

Cancela una solicitud de reembolso del terminal interac por identificador de solicitud de reembolso si el estado de la solicitud lo permite.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de reembolso del terminal	terminal_refund_id	True	string	Identificador del reembolso del terminal.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	refund.id	string	Identificador único emitido por Square.
Identificador de pago	refund.payment_id	string	Identificador único del pago.
Importe	refund.amount_money.amount	integer	Cantidad.
Moneda	refund.amount_money.currency	string	Moneda.
Motivo	refund.reason	string	Motivo de este objeto.
Id. de dispositivo	refund.device_id	string	Identificador único del dispositivo destinado a este TerminalRefund.
Duración de la fecha límite	refund.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Estado	refund.status	string	Estado de comprobación actual de este objeto.
Motivo de cancelación	refund.cancel_reason	string	Motivo de la transacción cancelada.
Creado en	refund.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	refund.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	refund.app_id	string	Identificador de la aplicación que creó la desprotección.
Marca de tarjeta	refund.card.card_brand	string	Marca de la tarjeta.
last_4	refund.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	refund.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	refund.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	refund.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	refund.card.card_type	string	Tipo de la tarjeta.
BOTE	refund.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Id. de pedido	refund.order_id	string	Identificador del pedido.
Id. de ubicación	refund.location_id	string	Identificador de la ubicación.

Cancelar factura

Id. de la operación:: InvoiceCancel

Cancela una factura. El vendedor no puede cobrar los pagos de la factura cancelada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de factura	invoice_id	True	string	Identificador de la factura.
Versión	version		integer	La versión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	invoice.id	string	Identificador único emitido por Square.
Versión	invoice.version	integer	La versión actual de este objeto.
Id. de ubicación	invoice.location_id	string	Identificador de la ubicación.
Id. de pedido	invoice.order_id	string	Identificador del pedido.
Solicitudes de pago	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identificador generado por square.
Tipo de solicitud	invoice.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoice.payment_requests.due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	invoice.payment_requests.tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Un identificador asignado a Cuadrado.
Días programados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoice.payment_requests.reminders.message	string	Mensaje.
Estado	invoice.payment_requests.reminders.status	string	Estado actual.
Importe	invoice.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoice.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoice.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Número de factura	invoice.invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	invoice.title	string	Título.
Description	invoice.description	string	Descripción.
Programado en	invoice.scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Estado	invoice.status	string	Estado de comprobación actual de este objeto.
Timezone	invoice.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoice.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	invoice.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de cliente	invoice.primary_recipient.customer_id	string	Identificador del cliente asociado al pedido.
Nombre propio	invoice.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoice.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoice.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoice.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Card	invoice.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoice.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoice.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoice.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoice.custom_fields.placement	string	Ubicación del campo personalizado en la factura.
Delivery (método)	invoice.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Fecha de venta o servicio	invoice.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Cancelar pago

Id. de la operación:: PaymentCancel

Cancela (anula) un pago. Puede usar este punto de conexión para cancelar un pago con el estado APPROVED.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de pago	payment_id	True	string	Identificador del pago.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	payment.id	string	Identificador único emitido por Square.
Creado en	payment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	payment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	payment.amount_money.amount	integer	Cantidad.
Moneda	payment.amount_money.currency	string	Moneda.
Importe	payment.tip_money.amount	integer	Cantidad.
Moneda	payment.tip_money.currency	string	Moneda.
Estado	payment.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payment.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago. Esta delay_action automática solo se aplica a los pagos que no alcanzan un estado terminal (COMPLETADO, CANCELADO o FAILED) antes del período de tiempo de delay_duration. Este campo se especifica como una duración de tiempo, en formato RFC 3339.
Tipo de origen	payment.source_type	string	Tipo de origen para este pago. Los valores actuales incluyen CARD, BANK_ACCOUNT, WALLET, CASH o EXTERNAL.
Estado	payment.card_details.status	string	Estado actual.
Marca de tarjeta	payment.card_details.card.card_brand	string	La marca de la tarjeta.
Últimos 4	payment.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payment.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payment.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payment.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payment.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payment.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payment.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Entry (método)	payment.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de CVV	payment.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de AVS	payment.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payment.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payment.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payment.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Anulado en	payment.card_details.card_payment_timeline.voided_at	string	Marca de tiempo cuando se anuló el pago, en formato RFC 3339.
Id. de ubicación	payment.location_id	string	Identificador de la ubicación.
Id. de pedido	payment.order_id	string	Identificador del pedido.
Creado en	payment.risk_evaluation.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Nivel de riesgo	payment.risk_evaluation.risk_level	string	Nivel de riesgo asociado al pago.
Nota:	payment.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de cliente	payment.customer_id	string	Identificador de este objeto que representa al cliente.
Importe	payment.total_money.amount	integer	Cantidad.
Moneda	payment.total_money.currency	string	Moneda.
Importe	payment.approved_money.amount	integer	Cantidad.
Moneda	payment.approved_money.currency	string	Moneda.
Acción de retraso	payment.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payment.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Square Product	payment.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payment.application_details.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Token de versión	payment.version_token	string	Este token opaco identifica una versión específica del objeto.

Catálogo de listas

Id. de la operación:: CatalogList

Devuelve una lista de CatalogObjects que incluye todos los objetos de un conjunto de tipos deseados (por ejemplo, todos los objetos CatalogItem y CatalogTax) del catálogo. ListCatalog no devuelve elementos de catálogo eliminados.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cursor	cursor		integer	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Tipos	types		string	Una lista opcional sin distinción entre mayúsculas y minúsculas y separada por comas de tipos de objeto que se van a recuperar. Los valores válidos se definen en la enumeración CatalogObjectType, incluidos ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST o IMAGE. Si no se especifica, la operación devuelve objetos de todos los tipos de la versión de Square API usada para realizar la solicitud.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	El tipo de este objeto.
identificación	objects.id	string	Identificador único emitido por Square.
Actualizado en	objects.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.version	integer	Versión actual del objeto.
Está eliminado	objects.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	objects.category_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Nombre	objects.tax_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Fase de cálculo	objects.tax_data.calculation_phase	string	Si el impuesto se calcula en función del subtotal o total de un pago.
Tipo de inclusión	objects.tax_data.inclusion_type	string	Si el impuesto es ADITIVO o INCLUSIVO.
Porcentaje	objects.tax_data.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Enabled	objects.tax_data.enabled	boolean	Indica si se puede usar un objeto o no.

Creación de la finalización de la compra del terminal

Id. de la operación:: TerminalCreateCheckout

Crea una solicitud de desprotección de Terminal y la envía al dispositivo especificado para realizar un pago por el importe solicitado.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.
Identificador de referencia	reference_id	string	Identificador de referencia definido por el usuario opcional.
Id. de dispositivo	device_id	string	El identificador único del dispositivo destinado a este TerminalCheckout.
Nota:	note	string	Una nota personalizada asociada al perfil de cliente.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	checkout.id	string	Identificador único emitido por Square.
Importe	checkout.amount_money.amount	integer	Cantidad.
Moneda	checkout.amount_money.currency	string	Moneda.
Identificador de referencia	checkout.reference_id	string	Identificador de referencia definido por el usuario opcional.
Nota:	checkout.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de dispositivo	checkout.device_options.device_id	string	El identificador único del dispositivo destinado a este TerminalCheckout.
Permitir propina	checkout.device_options.tip_settings.allow_tipping	boolean	Indica si la propina está habilitada para esta desprotección. El valor predeterminado es False.
Omitir pantalla de recepción	checkout.device_options.skip_receipt_screen	boolean	Indica al dispositivo que omita la pantalla de recepción. El valor predeterminado es False.
Estado	checkout.status	string	Estado de comprobación actual de este objeto.
Creado en	checkout.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	checkout.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	checkout.app_id	string	Identificador de la aplicación que creó la desprotección.
Duración de la fecha límite	checkout.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Tipo de pago	checkout.payment_type	string	El tipo de pago desde el que debe intentar capturar el terminal. El valor predeterminado es CARD_PRESENT.

Creación de texto de evidencia de controversia

Id. de la operación:: DisputeCreateEvidenceText

Carga el texto que se usará como evidencia para un desafío de disputa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.
Tipo de evidencia	evidence_type		string	Tipo de evidencia que está cargando.
Texto de evidencia	evidence_text		string	Cadena de evidencia.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	evidence.id	string	Identificador único emitido por Square.
Id. de disputa	evidence.dispute_id	string	El identificador de la disputa con el que está asociada la evidencia.
Texto de evidencia	evidence.evidence_text	string	Texto sin formato.
Tipo de evidencia	evidence.evidence_type	string	Evidencia de tipo pf.
Cargado en	evidence.uploaded_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.

Creación de un grupo de clientes

Id. de la operación:: CustomGroupCreate

Crea un nuevo grupo de clientes para una empresa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name		string	Nombre del objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	group.id	string	Identificador único emitido por Square.
Nombre	group.name	string	Nombre del objeto.
Creado en	group.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	group.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Creación de una suscripción

Id. de la operación:: SubscriptionCreate

Crea una suscripción para un cliente a un plan de suscripción. Si proporciona una tarjeta en el archivo en la solicitud, Square carga la tarjeta de la suscripción. De lo contrario, Square factura una factura a la dirección de correo electrónico del cliente. La suscripción se inicia inmediatamente, a menos que la solicitud incluya el start_date opcional. Cada suscripción individual está asociada a una ubicación determinada.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de ubicación	location_id	string	Identificador de ubicación.
Id. de plan	plan_id	string	Identificador del plan de suscripción creado mediante la API de catálogo.
Id. de cliente	customer_id	string	Identificador del cliente que se va a vincular.
Id. de tarjeta	card_id	string	Identificador de la tarjeta de cliente que se va a cargar.
Fecha de inicio	start_date	string	La fecha de inicio de la suscripción, en formato aaaa-MM-DD.
Porcentaje fiscal	tax_percentage	string	Impuesto que se agregará al facturar la suscripción.
Importe	amount	integer	Cantidad de dinero que se aceptará para este pago, no incluyendo tip_money.
Moneda	currency	string	Código de moneda ISO 4217 de 3 caracteres.
Timezone	timezone	string	Zona horaria que se usa en los cálculos de fecha de la suscripción.
Nombre	name	string	Nombre del objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	subscription.id	string	Identificador único emitido por Square.
Id. de ubicación	subscription.location_id	string	Identificador de la ubicación.
Id. de plan	subscription.plan_id	string	Identificador del plan de suscripción asociado.
Id. de cliente	subscription.customer_id	string	Identificador de este objeto que representa al cliente.
Fecha de inicio	subscription.start_date	string	La fecha de inicio de la suscripción, en formato aaaa-MM-DD.
Estado	subscription.status	string	Estado de comprobación actual de este objeto.
Porcentaje fiscal	subscription.tax_percentage	string	Importe fiscal aplicado al facturar la suscripción.
Importe	subscription.price_override_money.amount	integer	Cantidad.
Moneda	subscription.price_override_money.currency	string	Moneda.
Versión	subscription.version	integer	La versión actual de este objeto.
Creado en	subscription.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. de tarjeta	subscription.card_id	string	Identificador de la tarjeta de cliente que se cobra por la suscripción.
Timezone	subscription.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscription.source.name	string	Nombre.

Crear cliente

Id. de la operación:: CustomerCreate

Crea un nuevo cliente para una empresa.

Parámetros

Nombre	Clave	Tipo	Description
Nombre propio	given_name	string	Nombre dado (es decir, el nombre) asociado al perfil de cliente.
Apellido	family_name	string	Nombre de familia (es decir, el apellido) asociado al perfil de cliente.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Nombre de la compañía	company_name	string	Un nombre de negocio asociado al perfil de cliente.
Nickname	nickname	string	Un alias para el perfil de cliente.
Línea de dirección 1	address_line_1	string	Primera línea de la dirección.
Línea de dirección 2	address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	postal_code	string	El código postal de la dirección.
País	country	string	Código de país ISO 3166 Alpha-2.
Número de teléfono	phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificador de referencia	reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Nota:	note	string	Una nota personalizada asociada al perfil de cliente.
Cumpleaños	birthday	string	El cumpleaños asociado al perfil de cliente, en formato RFC 3339. El año es opcional. No se permite la zona horaria y la hora. Por ejemplo, 0000-09-21T00:00:00-00:00 representa un cumpleaños el 21 de septiembre y 1998-09-21T00:00:00-00:00 representa un cumpleaños el 21 de septiembre de 1998. También puede especificar este valor en formato aaaa-MM-DD.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	customer.id	string	Identificador único emitido por Square.
Creado en	customer.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	customer.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Nombre propio	customer.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	customer.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	customer.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Nombre de la compañía	customer.company_name	string	Un nombre de negocio asociado al perfil de cliente.
Nickname	customer.nickname	string	Un alias para el perfil de cliente.
Línea de dirección 1	customer.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	customer.address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	customer.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	customer.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	customer.address.postal_code	string	El código postal de la dirección.
País	customer.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Número de teléfono	customer.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificador de referencia	customer.reference_id	string	Identificador de referencia definido por el usuario opcional.
Nota:	customer.note	string	Una nota personalizada asociada al perfil de cliente.
Cumpleaños	customer.birthday	string	El cumpleaños asociado al perfil de cliente, en formato RFC 3339. El año es opcional. No se permite la zona horaria y la hora. Por ejemplo, 0000-09-21T00:00:00-00:00 representa un cumpleaños el 21 de septiembre y 1998-09-21T00:00:00-00:00 representa un cumpleaños el 21 de septiembre de 1998.
Correo electrónico cancelado	customer.preferences.email_unsubscribed	boolean	Indica si el cliente ha cancelado la suscripción a los correos electrónicos de campaña de marketing. Un valor true significa que el cliente eligió no participar en el marketing por correo electrónico del vendedor actual de Square o de todos los vendedores de Square.
Origen de creación	customer.creation_source	string	Un origen de creación representa el método usado para crear el perfil de cliente.
Versión	customer.version	integer	La versión actual de este objeto.

Crear factura

Id. de la operación:: InvoiceCreate

Crea una factura de borrador para un pedido creado mediante orders API. Una factura de borrador permanece en su cuenta y no se realiza ninguna acción. Debe publicar la factura antes de que Square pueda procesarla (enviarla a la dirección de correo electrónico del cliente o cargar la tarjeta del cliente en el archivo).

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de ubicación	location_id	string	Identificador de la ubicación.
Id. de pedido	order_id	string	Identificador del pedido.
Programado en	scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Id. de cliente	customer_id	string	Identificador del cliente asociado al pedido.
Delivery (método)	delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Tipo de solicitud	request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Origen de pago automático	automatic_payment_source	string	Método de pago para un pago automático.
Message	message	string	Mensaje.
Días programados relativos	relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Número de factura	invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	title	string	Título.
Description	description	string	Descripción.
Card	card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Etiqueta	label	string	Etiqueta o título del campo personalizado.
Importancia	value	string	Texto del campo personalizado.
Colocación	placement	string	Ubicación del campo personalizado en la factura.
Fecha de venta o servicio	sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	invoice.id	string	Identificador único emitido por Square.
Versión	invoice.version	integer	La versión actual de este objeto.
Id. de ubicación	invoice.location_id	string	Identificador de la ubicación.
Id. de pedido	invoice.order_id	string	Identificador del pedido.
Solicitudes de pago	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identificador generado por square.
Tipo de solicitud	invoice.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoice.payment_requests.due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	invoice.payment_requests.tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Un identificador asignado a Cuadrado.
Días programados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoice.payment_requests.reminders.message	string	Mensaje.
Estado	invoice.payment_requests.reminders.status	string	Estado actual.
Importe	invoice.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoice.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoice.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Número de factura	invoice.invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	invoice.title	string	Título.
Description	invoice.description	string	Descripción.
Programado en	invoice.scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Estado	invoice.status	string	Estado de comprobación actual de este objeto.
Timezone	invoice.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoice.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	invoice.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de cliente	invoice.primary_recipient.customer_id	string	Identificador del cliente asociado al pedido.
Nombre propio	invoice.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoice.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoice.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoice.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Card	invoice.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoice.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoice.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoice.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoice.custom_fields.placement	string	Ubicación del campo personalizado en la factura.
Delivery (método)	invoice.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Fecha de venta o servicio	invoice.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Crear pago

Id. de la operación:: PaymentCreate

Crea un pago mediante el origen proporcionado. Puede usar este punto de conexión para cargar una tarjeta (tarjeta de crédito/débito o tarjeta de regalo cuadrada) o registrar un pago que el vendedor recibió fuera de Square (pago en efectivo de un comprador o un pago que una entidad externa procesó en nombre del vendedor).

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Importe	amount	integer	Cantidad de dinero que se aceptará para este pago, no incluyendo tip_money.
Moneda	currency	string	Código de moneda ISO 4217 de 3 caracteres.
Id. de origen	source_id	string	Identificador de la fuente de fondos para este pago. Puede ser un token de pago (nonce de tarjeta) generado por el formulario de pago square o una tarjeta en el archivo realizado con la API customers. Si registra un pago que el vendedor recibió fuera de Square, especifique EFECTIVO o EXTERNAL.
Autocompletar	autocomplete	boolean	Si se establece en true, este pago se completará cuando sea posible. Si se establece en false, este pago se mantiene en un estado aprobado hasta que se complete explícitamente (capturado) o se cancele (anulado).
Id. de cliente	customer_id	string	Identificador del cliente que se va a vincular.
Id. de ubicación	location_id	string	Identificador de ubicación.
Identificador de referencia	reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Nota:	note	string	Una nota personalizada asociada al perfil de cliente.
Importe	amount	integer	Cantidad de dinero que se aceptará para este pago, no incluyendo tip_money.
Moneda	currency	string	Código de moneda ISO 4217 de 3 caracteres.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	payment.id	string	Identificador único emitido por Square.
Creado en	payment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	payment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	payment.amount_money.amount	integer	Cantidad.
Moneda	payment.amount_money.currency	string	Moneda.
Importe	payment.app_fee_money.amount	integer	Cantidad.
Moneda	payment.app_fee_money.currency	string	Moneda.
Estado	payment.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payment.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago. Esta delay_action automática solo se aplica a los pagos que no alcanzan un estado terminal (COMPLETADO, CANCELADO o FAILED) antes del período de tiempo de delay_duration. Este campo se especifica como una duración de tiempo, en formato RFC 3339.
Tipo de origen	payment.source_type	string	Tipo de origen para este pago. Los valores actuales incluyen CARD, BANK_ACCOUNT, WALLET, CASH o EXTERNAL.
Estado	payment.card_details.status	string	Estado actual.
Marca de tarjeta	payment.card_details.card.card_brand	string	La marca de la tarjeta.
Últimos 4	payment.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payment.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payment.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payment.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payment.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payment.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payment.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Entry (método)	payment.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de CVV	payment.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de AVS	payment.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payment.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payment.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payment.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Capturado en	payment.card_details.card_payment_timeline.captured_at	string	Marca de tiempo en la que se capturó el pago, en formato RFC 3339.
Id. de ubicación	payment.location_id	string	Identificador de la ubicación.
Id. de pedido	payment.order_id	string	Identificador del pedido.
Identificador de referencia	payment.reference_id	string	Identificador de referencia definido por el usuario opcional.
Creado en	payment.risk_evaluation.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Nivel de riesgo	payment.risk_evaluation.risk_level	string	Nivel de riesgo asociado al pago.
Nota:	payment.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de cliente	payment.customer_id	string	Identificador de este objeto que representa al cliente.
Importe	payment.total_money.amount	integer	Cantidad.
Moneda	payment.total_money.currency	string	Moneda.
Importe	payment.approved_money.amount	integer	Cantidad.
Moneda	payment.approved_money.currency	string	Moneda.
Número de recibo	payment.receipt_number	string	Número de recibo del pago. Falta el campo si se cancela un pago.
Dirección URL de recibo	payment.receipt_url	string	Dirección URL del recibo del pago. El campo solo se rellena para pagos COMPLETADOs.
Acción de retraso	payment.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payment.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Square Product	payment.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payment.application_details.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Token de versión	payment.version_token	string	Este token opaco identifica una versión específica del objeto.

Crear pedido

Id. de la operación:: OrderCreate

Crea un nuevo pedido que puede incluir información sobre los productos de compra y configuración que se aplicarán a la compra.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Identificador de referencia	reference_id	string	Identificador de referencia definido por el usuario opcional.
Id. de ubicación	location_id	string	Identificador de la ubicación.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Cantidad	quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.
Id. de objeto de catálogo	catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Id. de objeto de catálogo	catalog_object_id	string	Identificador del objeto de catálogo.
UID de descuento	discount_uid	string	Interfaz de usuario del descuento que representa el descuento aplicado.
UID	uid	string	Identificador generado por square.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje	percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Ámbito	scope	string	Indica el nivel actual.
UID	uid	string	Identificador generado por square.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje	percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Ámbito	scope	string	Indica el nivel actual.
Id. de objeto de catálogo	catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	order.id	string	Identificador único emitido por Square.
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Elementos de línea	order.line_items	array of object
UID	order.line_items.uid	string	Identificador generado por square.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Impuestos aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Un identificador asignado a Cuadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	El UID del impuesto para el que representa este impuesto aplicado.
Importe	order.line_items.applied_taxes.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_taxes.applied_money.currency	string	Moneda.
Descuentos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Un identificador asignado a Cuadrado.
UID de descuento	order.line_items.applied_discounts.discount_uid	string	Interfaz de usuario del descuento que representa el descuento aplicado.
Importe	order.line_items.applied_discounts.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_discounts.applied_money.currency	string	Moneda.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Importe	order.line_items.variation_total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.variation_total_price_money.currency	string	Moneda.
Id. de objeto de catálogo	order.line_items.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Nombre de variación	order.line_items.variation_name	string	Nombre de la variación aplicada a este elemento de línea.
Modificadores	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Un identificador asignado a Cuadrado.
Id. de objeto de catálogo	order.line_items.modifiers.catalog_object_id	string	Identificador del objeto de catálogo.
Nombre	order.line_items.modifiers.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	order.line_items.modifiers.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.modifiers.base_price_money.currency	string	Moneda.
Importe	order.line_items.modifiers.total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.modifiers.total_price_money.currency	string	Moneda.
Impuestos	order.taxes	array of object
UID	order.taxes.uid	string	Identificador generado por square.
Nombre	order.taxes.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Tipo	order.taxes.type	string	Indica el tipo.
Porcentaje	order.taxes.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.taxes.applied_money.amount	integer	Cantidad.
Moneda	order.taxes.applied_money.currency	string	Moneda.
Ámbito	order.taxes.scope	string	Indica el nivel actual.
Descuentos	order.discounts	array of object
UID	order.discounts.uid	string	Identificador generado por square.
Id. de objeto de catálogo	order.discounts.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Nombre	order.discounts.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Tipo	order.discounts.type	string	Indica el tipo.
Porcentaje	order.discounts.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.discounts.applied_money.amount	integer	Cantidad.
Moneda	order.discounts.applied_money.currency	string	Moneda.
Ámbito	order.discounts.scope	string	Indica el nivel actual.
Importe	order.discounts.amount_money.amount	integer	Cantidad.
Moneda	order.discounts.amount_money.currency	string	Moneda.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Estado	order.state	string	Estado actual.
Versión	order.version	integer	La versión actual de este objeto.
Identificador de referencia	order.reference_id	string	Identificador de referencia definido por el usuario opcional.
Importe	order.total_money.amount	integer	Cantidad.
Moneda	order.total_money.currency	string	Moneda.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Importe	order.total_tip_money.amount	integer	Cantidad.
Moneda	order.total_tip_money.currency	string	Moneda.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.tip_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tip_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.
Nombre	order.source.name	string	Nombre.

Crear reembolso de terminal

Id. de la operación:: TerminalCreateRefund

Crea una solicitud para reembolsar un pago interac completado en una terminal cuadrada.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.
Id. de dispositivo	device_id	string	Identificador único del dispositivo destinado a este TerminalRefund.
Motivo	reason	string	Motivo de este objeto.
Identificador de pago	payment_id	string	Identificador único del pago.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	refund.id	string	Identificador único emitido por Square.
Identificador de pago	refund.payment_id	string	Identificador único del pago.
Importe	refund.amount_money.amount	integer	Cantidad.
Moneda	refund.amount_money.currency	string	Moneda.
Motivo	refund.reason	string	Motivo de este objeto.
Id. de dispositivo	refund.device_id	string	Identificador único del dispositivo destinado a este TerminalRefund.
Duración de la fecha límite	refund.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Estado	refund.status	string	Estado de comprobación actual de este objeto.
Creado en	refund.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	refund.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	refund.app_id	string	Identificador de la aplicación que creó la desprotección.
Marca de tarjeta	refund.card.card_brand	string	Marca de la tarjeta.
last_4	refund.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	refund.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	refund.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	refund.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	refund.card.card_type	string	Tipo de la tarjeta.
BOTE	refund.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Id. de pedido	refund.order_id	string	Identificador del pedido.
Id. de ubicación	refund.location_id	string	Identificador de la ubicación.

Crear tarjeta

Id. de la operación:: CardCreate

Agrega una tarjeta en el archivo a un comerciante existente.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Clave de idempoencia.
Id. de origen	source_id	string	Identificador del origen.
Línea de dirección 1	address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	postal_code	string	El código postal de la dirección.
País	country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Nombre del titular de tarjeta	cardholder_name	string	Nombre del titular de la tarjeta.
Id. de cliente	customer_id	string	Identificador de este objeto que representa al cliente.
Identificador de referencia	reference_id	string	Identificador de referencia definido por el usuario opcional.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	card.id	string	Identificador único emitido por Square.
Línea de dirección 1	card.billing_address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	card.billing_address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	card.billing_address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	card.billing_address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	card.billing_address.postal_code	string	El código postal de la dirección.
País	card.billing_address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Huellas	card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
BOTE	card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Marca de tarjeta	card.card_brand	string	La marca de la tarjeta.
Tipo de tarjeta	card.card_type	string	Tipo de la tarjeta.
Nombre del titular de tarjeta	card.cardholder_name	string	Nombre del titular de la tarjeta.
Id. de cliente	card.customer_id	string	Identificador de este objeto que representa al cliente.
Enabled	card.enabled	boolean	Indica si está habilitado.
Exp Month	card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Últimos 4	card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Tipo de prepago	card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
Identificador de referencia	card.reference_id	string	Identificador de referencia definido por el usuario opcional.
Versión	card.version	integer	La versión actual de este objeto.

Deshabilitar tarjeta

Id. de la operación:: CardDisable

Deshabilita la tarjeta, evitando actualizaciones o cargos adicionales. Se permite deshabilitar una tarjeta ya deshabilitada, pero no tiene ningún efecto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de tarjeta	card_id	True	string	Identificador de la tarjeta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	card.id	string	Identificador único emitido por Square.
Línea de dirección 1	card.billing_address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	card.billing_address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	card.billing_address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	card.billing_address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	card.billing_address.postal_code	string	El código postal de la dirección.
País	card.billing_address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Huellas	card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
BOTE	card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Marca de tarjeta	card.card_brand	string	La marca de la tarjeta.
Tipo de tarjeta	card.card_type	string	Tipo de la tarjeta.
Nombre del titular de tarjeta	card.cardholder_name	string	Nombre del titular de la tarjeta.
Id. de cliente	card.customer_id	string	Identificador de este objeto que representa al cliente.
Enabled	card.enabled	boolean	Indica si está habilitado.
Exp Month	card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Últimos 4	card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Tipo de prepago	card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
Identificador de referencia	card.reference_id	string	Identificador de referencia definido por el usuario opcional.
Versión	card.version	integer	La versión actual de este objeto.

Eliminación por lotes de objetos de catálogo

Id. de la operación:: CatalogBatchDelete

Elimina un conjunto de catalogItems en función de la lista proporcionada de identificadores de destino y devuelve un conjunto de identificadores eliminados correctamente en la respuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificadores de objeto	object_ids		array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Identificadores de objeto eliminados	deleted_object_ids	array of string
Eliminado en	deleted_at	string	Marca de tiempo de la base de datos de esta eliminación en formato RFC 3339

Eliminar cliente

Id. de la operación:: CustomerDelete

Elimina un perfil de cliente de una empresa. Esta operación también desvincula las tarjetas asociadas en el archivo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente	customer_id	True	string	Identificador del cliente.

Devoluciones

response: object

Eliminar evidencia de controversia

Id. de la operación:: DisputeDeleteEvidence

Quita las pruebas especificadas de una disputa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.
Identificador de evidencia	evidence_id	True	string	Identificador de la evidencia.

Devoluciones

response: object

Eliminar factura

Id. de la operación:: InvoiceDelete

Elimina la factura especificada. Cuando se elimina una factura, el estado del pedido asociado cambia a CANCELED. Solo puede eliminar una factura de borrador (no se puede eliminar una factura publicada, incluida una programada para su procesamiento).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de factura	invoice_id	True	string	Identificador de la factura.
Versión	version		integer	Versión de la factura que se va a eliminar.

Devoluciones

response: object

Eliminar grupo de clientes

Id. de la operación:: CustomerGroupDelete

Elimina un grupo de clientes identificado por el valor de group_id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	group_id	True	string	Identificador del grupo.

Devoluciones

response: object

Eliminar objeto de catálogo

Id. de la operación:: CatalogDelete

Elimina un único CatalogObject basado en el identificador proporcionado y devuelve el conjunto de identificadores eliminados correctamente en la respuesta. La eliminación es un evento en cascada de modo que también se eliminen todos los elementos secundarios del objeto de destino. Por ejemplo, al eliminar un objeto CatalogItem también se eliminarán todos sus elementos secundarios CatalogItemVariation.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de objeto	object_id	True	string	Identificador del objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Identificadores de objeto eliminados	deleted_object_ids	array of string
Eliminado en	deleted_at	string	Marca de tiempo de la base de datos de esta eliminación en formato RFC 3339

Enumerar clientes

Id. de la operación:: CustomerList

Enumera los perfiles de cliente asociados a una cuenta de Square. En condiciones de funcionamiento normales, los perfiles de cliente recién creados o actualizados estarán disponibles para la operación de descripción en menos de 30 segundos. En ocasiones, la propagación de los perfiles nuevos o actualizados puede tardar más de un minuto o más, especialmente durante incidentes y interrupciones de red.

Parámetros

Nombre	Clave	Tipo	Description
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Ordenar campo	sort_field	string	Indica cómo se deben ordenar los clientes. El valor predeterminado es DEFAULT.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Clientela	customers	array of object
identificación	customers.id	string	Identificador único emitido por Square.
Creado en	customers.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	customers.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Nombre propio	customers.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	customers.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	customers.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Línea de dirección 1	customers.address.address_line_1	string	Primera línea de la dirección.
Línea de dirección 2	customers.address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	customers.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	customers.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	customers.address.postal_code	string	El código postal de la dirección.
País	customers.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Número de teléfono	customers.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificador de referencia	customers.reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Nota:	customers.note	string	Una nota personalizada asociada al perfil de cliente.
Correo electrónico cancelado	customers.preferences.email_unsubscribed	boolean	Indica si el cliente ha cancelado la suscripción a los correos electrónicos de campaña de marketing. Un valor true significa que el cliente eligió no participar en el marketing por correo electrónico del vendedor actual de Square o de todos los vendedores de Square. Este valor es de solo lectura de la API Customers.
Origen de creación	customers.creation_source	string	Un origen de creación representa el método usado para crear el perfil de cliente.
Identificadores de grupo	customers.group_ids	array of string
Identificadores de segmento	customers.segment_ids	array of string
Versión	customers.version	integer	Versión actual del objeto.

Enumerar controversias

Id. de la operación:: DisputeList

Devuelve una lista de disputas asociadas a una cuenta determinada.

Parámetros

Nombre	Clave	Tipo	Description
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
States	states	string	La disputa indica que se va a filtrar el resultado. Si no se especifica, el punto de conexión devuelve todas las disputas abiertas (el estado de la disputa no es INQUIRY_CLOSED, WON o LOST).
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Disputas	disputes	array of object
identificación	disputes.id	string	Identificador único emitido por Square.
Importe	disputes.amount_money.amount	integer	Cantidad.
Moneda	disputes.amount_money.currency	string	Moneda.
Motivo	disputes.reason	string	La razón de la disputa por la que el titular de la tarjeta inició la disputa con su banco.
Estado	disputes.state	string	Estado actual.
Vencimiento a	disputes.due_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.
Pagos disputados	disputes.disputed_payments	array of object
Identificador de pago	disputes.disputed_payments.payment_id	string	Identificador único generado por cuadrados del pago que se está disputando.
Marca de tarjeta	disputes.card_brand	string	La marca de tarjeta utilizada en el pago disputado.
Creado en	disputes.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	disputes.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Identificador de disputa de marca	disputes.brand_dispute_id	string	El identificador de la disputa en el sistema de marca de tarjeta, generado por la marca de tarjeta.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar eventos de suscripción

Id. de la operación:: SubscriptionListEvents

Enumera todos los eventos de una suscripción específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscription_id	True	string	Identificador de la suscripción.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Eventos de suscripción	subscription_events	array of object
identificación	subscription_events.id	string	Identificador único emitido por Square.
Tipo de evento subscription	subscription_events.subscription_event_type	string	Tipo del evento de suscripción.
Fecha de entrada en vigor	subscription_events.effective_date	string	La fecha, en formato AAAA-MM-DD, cuando el evento de suscripción entró en vigor.
Id. de plan	subscription_events.plan_id	string	Identificador del plan de suscripción asociado

Enumerar evidencia de controversias

Id. de la operación:: DisputeListEvidence

Devuelve una lista de pruebas asociadas a una disputa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Evidence	evidence	array of object
identificación	evidence.id	string	Identificador único emitido por Square.
Id. de disputa	evidence.dispute_id	string	El identificador de la disputa con el que está asociada la evidencia.
Texto de evidencia	evidence.evidence_text	string	Texto sin formato.
Tipo de evidencia	evidence.evidence_type	string	Tipo de la evidencia.
Cargado en	evidence.uploaded_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.
Identificador de evidencia	evidence.evidence_id	string	Identificador generado por Square de la evidencia.
Filename	evidence.evidence_file.filename	string	Nombre de archivo que incluye la extensión de archivo
Tipo de archivo	evidence.evidence_file.filetype	string	Los archivos de evidencia de controversia deben ser formatos application/pdf, image/heic, image/heif, image/jpeg, image/png o image/tiff.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar facturas

Id. de la operación:: InvoiceList

Devuelve una lista de facturas para una ubicación determinada.

Parámetros

Nombre	Clave	Tipo	Description
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Invoices	invoices	array of object
identificación	invoices.id	string	Identificador único emitido por Square.
Versión	invoices.version	integer	Versión actual del objeto.
Id. de ubicación	invoices.location_id	string	Identificador de la ubicación.
Id. de pedido	invoices.order_id	string	Identificador del pedido.
Solicitudes de pago	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Identificador generado por Square de la solicitud de pago en una factura.
Tipo de solicitud	invoices.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoices.payment_requests.due_date	string	Fecha de vencimiento (en la zona horaria de la factura) para la solicitud de pago, en formato AAAA-MM-DD.
Propina habilitada	invoices.payment_requests.tipping_enabled	boolean	Si se establece en true, la página de factura hospedada en Cuadrado (el campo public_url de la factura) proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoices.payment_requests.reminders	array of object	Recordatorios
UID	invoices.payment_requests.reminders.uid	string	Un identificador asignado a Square que identifica de forma única el aviso dentro de InvoicePaymentRequest.
Días programados relativos	invoices.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoices.payment_requests.reminders.message	string	Mensaje de recordatorio.
Estado	invoices.payment_requests.reminders.status	string	Estado del aviso.
Importe	invoices.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoices.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoices.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoices.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoices.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Porcentaje solicitado	invoices.payment_requests.percentage_requested	string	Especifica el importe de la solicitud de pago en porcentaje.
Id. de tarjeta	invoices.payment_requests.card_id	string	El identificador de la tarjeta de crédito o débito en el archivo para cobrar por la solicitud de pago.
Número de factura	invoices.invoice_number	string	Número de factura fácil de usar.
Title	invoices.title	string	Título de la factura.
Description	invoices.description	string	Descripción.
Programado en	invoices.scheduled_at	string	Marca de tiempo cuando la factura está programada para su procesamiento, en formato RFC 3339. Una vez publicada la factura, Square procesa la factura en la fecha especificada, según la configuración de la solicitud de pago y el método de entrega.
Estado	invoices.status	string	Estado de comprobación actual de este objeto.
Timezone	invoices.timezone	string	Zona horaria usada para interpretar las fechas del calendario en la factura, como due_date. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoices.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	invoices.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Id. de cliente	invoices.primary_recipient.customer_id	string	Identificador de un cliente que se va a asociar a la tarjeta.
Nombre propio	invoices.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoices.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoices.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoices.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Card	invoices.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoices.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoices.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoices.custom_fields	array of object
Etiqueta	invoices.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoices.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoices.custom_fields.placement	string	Ubicación del campo personalizado en la factura
Delivery (método)	invoices.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente.
Fecha de venta o servicio	invoices.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.
Dirección URL pública	invoices.public_url	string	Dirección URL de la página de factura hospedada en Square. Después de publicar la factura mediante el punto de conexión PublishInvoice, Square hospeda la página de factura y devuelve la dirección URL de la página en la respuesta.
Importe	invoices.next_payment_amount_money.amount	integer	Cantidad.
Moneda	invoices.next_payment_amount_money.currency	string	Moneda.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar grupos de clientes

Id. de la operación:: CustomerGroupList

Recupera la lista de grupos de clientes de una empresa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Groups	groups	array of object
identificación	groups.id	string	Identificador único emitido por Square.
Nombre	groups.name	string	Nombre del objeto.
Creado en	groups.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	groups.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339

Enumerar pagos

Id. de la operación:: PaymentList

Recupera una lista de pagos tomados por la cuenta que realiza la solicitud. Los resultados son finalmente coherentes y los nuevos pagos o cambios en los pagos pueden tardar varios segundos en aparecer.

Parámetros

Nombre	Clave	Tipo	Description
Hora de inicio	begin_time	string	Hora de inicio inclusiva de la consulta en opened_at, en formato ISO 8601.
Hora de finalización	end_time	string	Fecha de finalización exclusiva de la consulta en opened_at, en formato ISO 8601.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Total	total	integer	El importe exacto del total_money para un pago.
Últimos 4	last_4	string	Los últimos cuatro dígitos de una tarjeta de pago.
Marca de tarjeta	card_brand	string	Marca de la tarjeta de pago (por ejemplo, VISA).
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Payments	payments	array of object
identificación	payments.id	string	Identificador único emitido por Square.
Creado en	payments.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	payments.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Importe	payments.amount_money.amount	integer	Cantidad.
Moneda	payments.amount_money.currency	string	Moneda.
Estado	payments.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payments.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago.
Tipo de origen	payments.source_type	string	Tipo de origen para este pago.
Estado	payments.card_details.status	string	Estado actual del pago de la tarjeta. El estado puede ser AUTHORIZED, CAPTURED, VOIDED o FAILED.
Marca de tarjeta	payments.card_details.card.card_brand	string	La marca de la tarjeta.
last_4	payments.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payments.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payments.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payments.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payments.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payments.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payments.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN)
Entry (método)	payments.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de cvv	payments.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de Avs	payments.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payments.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payments.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payments.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Capturado en	payments.card_details.card_payment_timeline.captured_at	string	Marca de tiempo en la que se capturó el pago, en formato RFC 3339.
Id. de ubicación	payments.location_id	string	Identificador de la ubicación.
Id. de pedido	payments.order_id	string	Identificador del pedido.
Cuota de procesamiento	payments.processing_fee	array of object
Efectivo en	payments.processing_fee.effective_at	string	Marca de tiempo de cuando la cuota surte efecto, en formato RFC 3339.
Tipo	payments.processing_fee.type	string	El tipo de este objeto.
Importe	payments.processing_fee.amount_money.amount	integer	Cantidad.
Moneda	payments.processing_fee.amount_money.currency	string	Moneda.
Nota:	payments.note	string	Una nota personalizada asociada al perfil de cliente.
Importe	payments.total_money.amount	integer	Cantidad.
Moneda	payments.total_money.currency	string	Moneda.
Importe	payments.approved_money.amount	integer	Cantidad.
Moneda	payments.approved_money.currency	string	Moneda.
Número de recibo	payments.receipt_number	string	Número de recibo del pago. Falta el campo si se cancela un pago.
Dirección URL de recibo	payments.receipt_url	string	Dirección URL del recibo del pago. El campo solo se rellena para pagos COMPLETADOs.
Acción de retraso	payments.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payments.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Id. de miembro del equipo	payments.team_member_id	string	Identificador del objeto TeamMember del miembro del equipo asociado al objeto .
Square Product	payments.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payments.application_details.application_id	string	Id. cuadrado asignado a la aplicación que se usa para realizar el pago. Los desarrolladores de aplicaciones pueden usar esta información para identificar los pagos procesados por su aplicación. Por ejemplo, si un desarrollador usa una aplicación personalizada para procesar pagos, este campo contiene el identificador de aplicación del Panel de desarrolladores. Si un vendedor usa una aplicación de Square App Marketplace para procesar pagos, el campo contiene el identificador de aplicación correspondiente.
Token de versión	payments.version_token	string	Se usa para la simultaneidad optimista. Este token opaco identifica una versión específica del objeto Payment.

Enumerar reembolsos de pago

Id. de la operación:: RefundList

Recupera una lista de reembolsos para la cuenta que realiza la solicitud. Los resultados son finalmente coherentes y los nuevos reembolsos o cambios en los reembolsos pueden tardar varios segundos en aparecer.

Parámetros

Nombre	Clave	Tipo	Description
Hora de inicio	begin_time	string	Hora de inicio inclusiva de la consulta en opened_at, en formato ISO 8601.
Hora de finalización	end_time	string	Fecha de finalización exclusiva de la consulta en opened_at, en formato ISO 8601.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Estado	status	string	Si se especifica, solo devuelve objetos que coinciden con los estados especificados.
Tipo de origen	source_type	string	Si se proporciona, solo se devuelven reembolsos con el tipo de origen especificado.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Reembolsos	refunds	array of object
identificación	refunds.id	string	Identificador único emitido por Square.
Estado	refunds.status	string	Estado de comprobación actual de este objeto.
Importe	refunds.amount_money.amount	integer	Cantidad.
Moneda	refunds.amount_money.currency	string	Moneda.
Identificador de pago	refunds.payment_id	string	Identificador del pago.
Id. de pedido	refunds.order_id	string	Identificador del pedido.
Creado en	refunds.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	refunds.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Cuota de procesamiento	refunds.processing_fee	array of object
Efectivo en	refunds.processing_fee.effective_at	string	Marca de tiempo de cuando la cuota surte efecto, en formato RFC 3339.
Tipo	refunds.processing_fee.type	string	El tipo de este objeto.
Importe	refunds.processing_fee.amount_money.amount	integer	Cantidad.
Moneda	refunds.processing_fee.amount_money.currency	string	Moneda.
Id. de ubicación	refunds.location_id	string	Identificador de la ubicación.
Motivo	refunds.reason	string	La razón de la disputa por la que el titular de la tarjeta inició la disputa con su banco.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar segmentos de clientes

Id. de la operación:: CustomerSegmentList

Recupera la lista de segmentos de cliente de una empresa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cursor	cursor		string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Limit	limit		integer	Límite superior del número que se va a devolver en la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Segmentos	segments	array of object
identificación	segments.id	string	Identificador único emitido por Square.
Nombre	segments.name	string	Nombre del objeto.
Creado en	segments.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	segments.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339

Enumerar tarjetas

Id. de la operación:: CardList

Recupera una lista de tarjetas propiedad de la cuenta que realiza la solicitud.

Parámetros

Nombre	Clave	Tipo	Description
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Id. de cliente	customer_id	string	Limite los resultados a las tarjetas asociadas con el cliente proporcionado. De forma predeterminada, se devuelven todas las tarjetas que pertenecen al comerciante.
Incluir deshabilitado	include_disabled	boolean	Incluye tarjetas deshabilitadas. De forma predeterminada, se devuelven todas las tarjetas habilitadas que pertenecen al comerciante.
Identificador de referencia	reference_id	string	Limite los resultados a las tarjetas asociadas con el reference_id proporcionado.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cards	cards	array of object
identificación	cards.card.id	string	Identificador del objeto
Línea de dirección 1	cards.card.billing_address.address_line_1	string	Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	cards.card.billing_address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	cards.card.billing_address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	cards.card.billing_address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	cards.card.billing_address.postal_code	string	El código postal de la dirección.
País	cards.card.billing_address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Huellas	cards.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
BOTE	cards.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Marca de tarjeta	cards.card.card_brand	string	La marca de la tarjeta.
Tipo de tarjeta	cards.card.card_type	string	Tipo de la tarjeta.
Nombre del titular de tarjeta	cards.card.cardholder_name	string	Nombre del titular de la tarjeta.
Id. de cliente	cards.card.customer_id	string	Identificador de un cliente que se va a asociar a la tarjeta.
Enabled	cards.card.enabled	boolean	Indica si se puede usar un objeto o no.
Mes de expiración	cards.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Año de expiración	cards.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Últimos 4	cards.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Tipo de prepago	cards.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
Identificador de referencia	cards.card.reference_id	string	Identificador de referencia opcional definido por el usuario que asocia esta tarjeta a otra entidad en un sistema externo.
Versión	cards.card.version	integer	Número de versión actual de la tarjeta. Incrementa con cada actualización de tarjeta. Las solicitudes para actualizar un objeto Card existente se rechazarán a menos que la versión de la solicitud coincida con la versión actual de la tarjeta.

Enviar evidencia

Id. de la operación:: EvidenceSubmit

Envía pruebas al banco del titular de la tarjeta. Antes de enviar pruebas, Square compila todas las pruebas disponibles. Esto incluye pruebas cargadas mediante los puntos de conexión CreateDisputeEvidenceFile y CreateDisputeEvidenceText y las pruebas proporcionadas automáticamente por Square, cuando están disponibles.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	dispute.id	string	Identificador único emitido por Square.
Importe	dispute.amount_money.amount	integer	Cantidad.
Moneda	dispute.amount_money.currency	string	Moneda.
Motivo	dispute.reason	string	Motivo de este objeto.
Estado	dispute.state	string	Estado actual.
Vencimiento a	dispute.due_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.
Pagos disputados	dispute.disputed_payments	array of object
Identificador de pago	dispute.disputed_payments.payment_id	string	Identificador único generado por cuadrados del pago.
Marca de tarjeta	dispute.card_brand	string	La marca de la tarjeta.
Creado en	dispute.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	dispute.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de disputa de marca	dispute.brand_dispute_id	string	El identificador de la disputa en el sistema de marca de tarjeta, generado por la marca de tarjeta.

Información del catálogo

Id. de la operación:: CatalogInfo

Recupera información sobre square Catalog API, como los límites de tamaño de lote que puede usar el punto de conexión batchUpsertCatalogObjects.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Batch Upsert Max Objects per Batch	limits.batch_upsert_max_objects_per_batch	integer	Número máximo de objetos que pueden aparecer dentro de un único lote en una solicitud /v2/catalog/batch-upsert.
Batch Upsert Max Total Objects	limits.batch_upsert_max_total_objects	integer	Número máximo de objetos que pueden aparecer en todos los lotes de una solicitud /v2/catalog/batch-upsert.
Identificadores máximos de objeto de recuperación por lotes	limits.batch_retrieve_max_object_ids	integer	Número máximo de identificadores de objeto que pueden aparecer en una solicitud /v2/catalog/batch-retrieve.
Límite máximo de páginas de búsqueda	limits.search_max_page_limit	integer	Número máximo de resultados que se pueden devolver en una página de una respuesta /v2/catalog/search.
Identificadores de objeto máximo de eliminación por lotes	limits.batch_delete_max_object_ids	integer	Número máximo de identificadores de objeto que se pueden incluir en una única solicitud /v2/catalog/batch-delete.
Actualizar los identificadores máximos de elementos de los impuestos de elementos	limits.update_item_taxes_max_item_ids	integer	Número máximo de identificadores de elemento que se pueden incluir en una única solicitud /v2/catalog/update-item-taxes.
Actualizar impuestos máximos de artículos para habilitar	limits.update_item_taxes_max_taxes_to_enable	integer	Número máximo de identificadores fiscales que se van a habilitar que se pueden incluir en una única solicitud /v2/catalog/update-item-tax.
Actualizar impuestos máximos de artículos para deshabilitar	limits.update_item_taxes_max_taxes_to_disable	integer	Número máximo de identificadores fiscales que se van a deshabilitar que se pueden incluir en una única solicitud /v2/catalog/update-item-tax.
Actualizar modificador de elemento enumera los identificadores máximos de elementos	limits.update_item_modifier_lists_max_item_ids	integer	Número máximo de identificadores fiscales que se van a deshabilitar que se pueden incluir en una única solicitud /v2/catalog/update-item-tax.
Actualizar modificador de elementos enumera listas de modificadores máximos para habilitar	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Número máximo de identificadores de lista modificadores que se van a habilitar que se pueden incluir en una única solicitud /v2/catalog/update-item-modifier-lists.
Actualizar modificador de elementos enumera listas de modificadores máximos para deshabilitar	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Número máximo de identificadores de lista modificadores que se van a deshabilitar que se pueden incluir en una única solicitud /v2/catalog/update-item-modifier-lists.

Inventario de cambios por lotes

Id. de la operación:: InventoryBatchChange

Aplica ajustes y recuentos a las cantidades de artículos proporcionadas. Si se ejecuta correctamente: devuelve los recuentos calculados actuales de todos los objetos a los que se hace referencia en la solicitud.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Tipo	type	string	El tipo de este objeto.
Identificador de referencia	reference_id	string	Identificador de referencia opcional definido por el usuario que asocia esta tarjeta a otra entidad en un sistema externo.
Id. de objeto de catálogo	catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Estado	state	string	Estado de inventario actual para la cantidad relacionada de artículos.
Id. de ubicación	location_id	string	Identificador de ubicación de un destinatario (distinto del comerciante) que recibe una parte de esta licitación.
Cantidad	quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Id. de empleado	employee_id	string	El identificador generado por Square del empleado responsable del recuento físico.
Se produjo en	occurred_at	string	Marca de tiempo con formato RFC 3339 generado por el cliente que indica cuándo se examinó el recuento físico. En el caso de las actualizaciones de recuento físico, la occurred_at marca de tiempo no puede tener más de 24 horas o en el futuro en relación con el tiempo de la solicitud.
Omitir recuentos sin cambios	ignore_unchanged_counts	boolean	Indica si se debe omitir el recuento físico actual si la cantidad no cambia desde el último recuento físico.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cuenta	counts	array of object
Id. de objeto de catálogo	counts.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	counts.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Estado	counts.state	string	Estado actual.
Id. de ubicación	counts.location_id	string	Identificador de la ubicación.
Cantidad	counts.quantity	string	Número de elementos afectados por el recuento estimado como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Calculado en	counts.calculated_at	string	Marca de tiempo con formato RFC 3339 que indica cuándo se recibe el recuento físico o ajuste más reciente que afecta al recuento estimado.

Obtención de la factura

Id. de la operación:: InvoiceGet

Recupera una factura por identificador de factura.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de factura	invoice_id	True	string	Identificador de la factura.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	invoice.id	string	Identificador único emitido por Square.
Versión	invoice.version	integer	La versión actual de este objeto.
Id. de ubicación	invoice.location_id	string	Identificador de la ubicación.
Id. de pedido	invoice.order_id	string	Identificador del pedido.
Solicitudes de pago	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identificador generado por square.
Tipo de solicitud	invoice.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoice.payment_requests.due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	invoice.payment_requests.tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Un identificador asignado a Cuadrado.
Días programados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoice.payment_requests.reminders.message	string	Mensaje.
Estado	invoice.payment_requests.reminders.status	string	Estado actual.
Importe	invoice.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoice.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoice.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Número de factura	invoice.invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	invoice.title	string	Título.
Description	invoice.description	string	Descripción.
Programado en	invoice.scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Estado	invoice.status	string	Estado de comprobación actual de este objeto.
Timezone	invoice.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoice.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	invoice.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de cliente	invoice.primary_recipient.customer_id	string	Identificador del cliente asociado al pedido.
Nombre propio	invoice.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoice.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoice.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoice.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Card	invoice.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoice.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoice.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoice.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoice.custom_fields.placement	string	Ubicación del campo personalizado en la factura.
Delivery (método)	invoice.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Fecha de venta o servicio	invoice.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Obtención de la finalización de la compra del terminal

Id. de la operación:: TerminalGetCheckout

Recupera una solicitud de desprotección de Terminal checkout_id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de desprotección	checkout_id	True	string	Identificador de la desprotección.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	checkout.id	string	Identificador único emitido por Square.
Importe	checkout.amount_money.amount	integer	Cantidad.
Moneda	checkout.amount_money.currency	string	Moneda.
Identificador de referencia	checkout.reference_id	string	Identificador de referencia definido por el usuario opcional.
Nota:	checkout.note	string	Una nota personalizada asociada al perfil de cliente.
Id. de dispositivo	checkout.device_options.device_id	string	El identificador único del dispositivo destinado a este TerminalCheckout.
Permitir propina	checkout.device_options.tip_settings.allow_tipping	boolean	Indica si la propina está habilitada para esta desprotección. El valor predeterminado es False.
Omitir pantalla de recepción	checkout.device_options.skip_receipt_screen	boolean	Indica al dispositivo que omita la pantalla de recepción. El valor predeterminado es False.
Estado	checkout.status	string	Estado de comprobación actual de este objeto.
Creado en	checkout.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	checkout.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	checkout.app_id	string	Identificador de la aplicación que creó la desprotección.
Duración de la fecha límite	checkout.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación

Obtención del reembolso del pago

Id. de la operación:: RefundGet

Recupera un reembolso específico mediante el refund_id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de reembolso	refund_id	True	string	Identificador del reembolso.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	refund.id	string	Identificador único emitido por Square.
Estado	refund.status	string	Estado de comprobación actual de este objeto.
Importe	refund.amount_money.amount	integer	Cantidad.
Moneda	refund.amount_money.currency	string	Moneda.
Identificador de pago	refund.payment_id	string	Identificador único del pago.
Id. de pedido	refund.order_id	string	Identificador del pedido.
Creado en	refund.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	refund.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Cuota de procesamiento	refund.processing_fee	array of object
Efectivo en	refund.processing_fee.effective_at	string	Marca de tiempo de cuando la cuota surte efecto, en formato RFC 3339.
Tipo	refund.processing_fee.type	string	Indica el tipo.
Importe	refund.processing_fee.amount_money.amount	integer	Cantidad.
Moneda	refund.processing_fee.amount_money.currency	string	Moneda.
Id. de ubicación	refund.location_id	string	Identificador de la ubicación.
Motivo	refund.reason	string	Motivo de este objeto.

Obtención del reembolso del terminal

Id. de la operación:: TerminalGetRefund

Recupera un objeto de reembolso de Terminal Interac por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de reembolso del terminal	terminal_refund_id	True	string	Identificador del reembolso del terminal.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	refund.id	string	Identificador único emitido por Square.
Id. de reembolso	refund.refund_id	string	El identificador único de este reembolso, generado por Square.
Identificador de pago	refund.payment_id	string	Identificador único del pago.
Importe	refund.amount_money.amount	integer	Cantidad.
Moneda	refund.amount_money.currency	string	Moneda.
Motivo	refund.reason	string	Motivo de este objeto.
Id. de dispositivo	refund.device_id	string	Identificador único del dispositivo destinado a este TerminalRefund.
Duración de la fecha límite	refund.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Estado	refund.status	string	Estado de comprobación actual de este objeto.
Creado en	refund.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	refund.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de aplicación	refund.app_id	string	Identificador de la aplicación que creó la desprotección.
Marca de tarjeta	refund.card.card_brand	string	Marca de la tarjeta.
last_4	refund.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	refund.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	refund.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	refund.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	refund.card.card_type	string	Tipo de la tarjeta.
BOTE	refund.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Id. de pedido	refund.order_id	string	Identificador del pedido.
Id. de ubicación	refund.location_id	string	Identificador de la ubicación.

Obtener pago

Id. de la operación:: PaymentGet

Recupera los detalles de un pago específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de pago	payment_id	True	string	Identificador del pago.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	payment.id	string	Identificador único emitido por Square.
Creado en	payment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	payment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	payment.amount_money.amount	integer	Cantidad.
Moneda	payment.amount_money.currency	string	Moneda.
Estado	payment.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payment.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago. Esta delay_action automática solo se aplica a los pagos que no alcanzan un estado terminal (COMPLETADO, CANCELADO o FAILED) antes del período de tiempo de delay_duration. Este campo se especifica como una duración de tiempo, en formato RFC 3339.
Tipo de origen	payment.source_type	string	Tipo de origen para este pago. Los valores actuales incluyen CARD, BANK_ACCOUNT, WALLET, CASH o EXTERNAL.
Estado	payment.card_details.status	string	Estado actual.
Marca de tarjeta	payment.card_details.card.card_brand	string	La marca de la tarjeta.
Últimos 4	payment.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payment.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payment.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payment.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payment.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payment.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payment.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Entry (método)	payment.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de CVV	payment.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de AVS	payment.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payment.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payment.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payment.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Capturado en	payment.card_details.card_payment_timeline.captured_at	string	Marca de tiempo en la que se capturó el pago, en formato RFC 3339.
Id. de ubicación	payment.location_id	string	Identificador de la ubicación.
Id. de pedido	payment.order_id	string	Identificador del pedido.
Cuota de procesamiento	payment.processing_fee	array of object
Efectivo en	payment.processing_fee.effective_at	string	Marca de tiempo de cuando la cuota surte efecto, en formato RFC 3339.
Tipo	payment.processing_fee.type	string	Indica el tipo.
Importe	payment.processing_fee.amount_money.amount	integer	Cantidad.
Moneda	payment.processing_fee.amount_money.currency	string	Moneda.
Nota:	payment.note	string	Una nota personalizada asociada al perfil de cliente.
Importe	payment.total_money.amount	integer	Cantidad.
Moneda	payment.total_money.currency	string	Moneda.
Importe	payment.approved_money.amount	integer	Cantidad.
Moneda	payment.approved_money.currency	string	Moneda.
Id. de empleado	payment.employee_id	string	Identificador generado por cuadrados del empleado.
Número de recibo	payment.receipt_number	string	Número de recibo del pago. Falta el campo si se cancela un pago.
Dirección URL de recibo	payment.receipt_url	string	Dirección URL del recibo del pago. El campo solo se rellena para pagos COMPLETADOs.
Acción de retraso	payment.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payment.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Id. de miembro del equipo	payment.team_member_id	string	Identificador del miembro del equipo.
Square Product	payment.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payment.application_details.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Token de versión	payment.version_token	string	Este token opaco identifica una versión específica del objeto.

Orden de actualización (beta)

Id. de la operación:: OrderUpdate

Actualiza un pedido abierto agregando, reemplazando o eliminando campos. Los pedidos con un estado COMPLETED o CANCELED no se pueden actualizar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de pedido	order_id	True	string	Identificador del pedido.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Versión	version		integer	La versión actual de este objeto.
UID	uid		string	Identificador generado por square.
Cantidad	quantity		string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Nombre	name		string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Campos que se van a borrar	fields_to_clear		array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Versión	order.version	integer	La versión actual de este objeto.
Moneda	order.total_money.currency	string	Moneda.
Importe	order.total_money.amount	integer	Cantidad.
Nombre	order.source.name	string	Nombre.
Elementos de línea	order.line_items	array of object
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
UID	order.line_items.uid	string	Identificador generado por square.
Importe	order.line_items.variation_total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.variation_total_price_money.currency	string	Moneda.
Estado	order.state	string	Estado actual.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
identificación	order.id	string	Identificador único emitido por Square.
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Orden de clonación (beta)

Id. de la operación:: OrderClone

Crea un nuevo orden, en el estado DRAFT, duplicando un orden existente. El pedido recién creado solo tiene los campos principales (como los artículos de línea, los impuestos y los descuentos) copiados del pedido original.

Parámetros

Nombre	Clave	Tipo	Description
Id. de pedido	order_id	string	Identificador de pedido.
Versión	version	integer	La versión.
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	order.id	string	Identificador único emitido por Square.
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Elementos de línea	order.line_items	array of object
UID	order.line_items.uid	string	Identificador generado por square.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Impuestos aplicados	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Un identificador asignado a Cuadrado.
UID fiscal	order.line_items.applied_taxes.tax_uid	string	El UID del impuesto para el que representa este impuesto aplicado.
Importe	order.line_items.applied_taxes.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_taxes.applied_money.currency	string	Moneda.
Descuentos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Un identificador asignado a Cuadrado.
UID de descuento	order.line_items.applied_discounts.discount_uid	string	Interfaz de usuario del descuento que representa el descuento aplicado.
Importe	order.line_items.applied_discounts.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_discounts.applied_money.currency	string	Moneda.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Importe	order.line_items.variation_total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.variation_total_price_money.currency	string	Moneda.
Id. de objeto de catálogo	order.line_items.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Nombre de variación	order.line_items.variation_name	string	Nombre de la variación aplicada a este elemento de línea.
Modificadores	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Un identificador asignado a Cuadrado.
Id. de objeto de catálogo	order.line_items.modifiers.catalog_object_id	string	Identificador del objeto de catálogo.
Nombre	order.line_items.modifiers.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	order.line_items.modifiers.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.modifiers.base_price_money.currency	string	Moneda.
Importe	order.line_items.modifiers.total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.modifiers.total_price_money.currency	string	Moneda.
Impuestos	order.taxes	array of object
UID	order.taxes.uid	string	Identificador generado por square.
Nombre	order.taxes.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Tipo	order.taxes.type	string	Indica el tipo.
Porcentaje	order.taxes.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.taxes.applied_money.amount	integer	Cantidad.
Moneda	order.taxes.applied_money.currency	string	Moneda.
Ámbito	order.taxes.scope	string	Indica el nivel actual.
Descuentos	order.discounts	array of object
UID	order.discounts.uid	string	Identificador generado por square.
Id. de objeto de catálogo	order.discounts.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Nombre	order.discounts.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Tipo	order.discounts.type	string	Indica el tipo.
Porcentaje	order.discounts.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.discounts.applied_money.amount	integer	Cantidad.
Moneda	order.discounts.applied_money.currency	string	Moneda.
Ámbito	order.discounts.scope	string	Indica el nivel actual.
Importe	order.discounts.amount_money.amount	integer	Cantidad.
Moneda	order.discounts.amount_money.currency	string	Moneda.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Estado	order.state	string	Estado actual.
Versión	order.version	integer	La versión actual de este objeto.
Identificador de referencia	order.reference_id	string	Identificador de referencia definido por el usuario opcional.
Importe	order.total_money.amount	integer	Cantidad.
Moneda	order.total_money.currency	string	Moneda.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Importe	order.total_tip_money.amount	integer	Cantidad.
Moneda	order.total_tip_money.currency	string	Moneda.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.tip_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tip_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.
Nombre	order.source.name	string	Nombre.

Pago completo

Id. de la operación:: PaymentComplete

Completa (captura) un pago. De forma predeterminada, los pagos se establecen para completarse inmediatamente después de crearse.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de pago	payment_id	True	string	Identificador del pago.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	payment.id	string	Identificador único emitido por Square.
Creado en	payment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	payment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	payment.amount_money.amount	integer	Cantidad.
Moneda	payment.amount_money.currency	string	Moneda.
Estado	payment.status	string	Estado de comprobación actual de este objeto.
Duración del retraso	payment.delay_duration	string	La duración del tiempo después de la creación del pago cuando Square aplica automáticamente el delay_action al pago. Esta delay_action automática solo se aplica a los pagos que no alcanzan un estado terminal (COMPLETADO, CANCELADO o FAILED) antes del período de tiempo de delay_duration. Este campo se especifica como una duración de tiempo, en formato RFC 3339.
Tipo de origen	payment.source_type	string	Tipo de origen para este pago. Los valores actuales incluyen CARD, BANK_ACCOUNT, WALLET, CASH o EXTERNAL.
Estado	payment.card_details.status	string	Estado actual.
Marca de tarjeta	payment.card_details.card.card_brand	string	La marca de la tarjeta.
Últimos 4	payment.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	payment.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	payment.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	payment.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	payment.card_details.card.card_type	string	Tipo de la tarjeta.
Tipo de prepago	payment.card_details.card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
BOTE	payment.card_details.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Entry (método)	payment.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para el pago. El método puede ser KEYED, SWIPED, EMV, ON_FILE o CONTACTLESS.
Estado de CVV	payment.card_details.cvv_status	string	El código de estado devuelto desde la comprobación del valor de verificación de tarjeta (CVV). El código puede ser CVV_ACCEPTED, CVV_REJECTED o CVV_NOT_CHECKED.
Estado de AVS	payment.card_details.avs_status	string	El código de estado devuelto desde la comprobación del sistema de comprobación de direcciones (AVS). El código puede ser AVS_ACCEPTED, AVS_REJECTED o AVS_NOT_CHECKED.
Código de resultado de autenticación	payment.card_details.auth_result_code	string	El código de estado devuelto por el emisor de la tarjeta que describe el estado de autorización del pago.
Descripción de la instrucción	payment.card_details.statement_description	string	Descripción de la instrucción enviada a las redes de tarjetas.
Autorizado en	payment.card_details.card_payment_timeline.authorized_at	string	Marca de tiempo cuando se autorizó el pago, en formato RFC 3339.
Capturado en	payment.card_details.card_payment_timeline.captured_at	string	Marca de tiempo en la que se capturó el pago, en formato RFC 3339.
Id. de ubicación	payment.location_id	string	Identificador de la ubicación.
Id. de pedido	payment.order_id	string	Identificador del pedido.
Cuota de procesamiento	payment.processing_fee	array of object
Efectivo en	payment.processing_fee.effective_at	string	Marca de tiempo de cuando la cuota surte efecto, en formato RFC 3339.
Tipo	payment.processing_fee.type	string	Indica el tipo.
Importe	payment.processing_fee.amount_money.amount	integer	Cantidad.
Moneda	payment.processing_fee.amount_money.currency	string	Moneda.
Nota:	payment.note	string	Una nota personalizada asociada al perfil de cliente.
Importe	payment.total_money.amount	integer	Cantidad.
Moneda	payment.total_money.currency	string	Moneda.
Importe	payment.approved_money.amount	integer	Cantidad.
Moneda	payment.approved_money.currency	string	Moneda.
Id. de empleado	payment.employee_id	string	Identificador generado por cuadrados del empleado.
Número de recibo	payment.receipt_number	string	Número de recibo del pago. Falta el campo si se cancela un pago.
Dirección URL de recibo	payment.receipt_url	string	Dirección URL del recibo del pago. El campo solo se rellena para pagos COMPLETADOs.
Acción de retraso	payment.delay_action	string	Acción que se aplicará al pago cuando haya transcurrido el delay_duration.
Retraso hasta	payment.delayed_until	string	Marca de tiempo de solo lectura de cuando se aplica automáticamente el delay_action, en formato RFC 3339.
Id. de miembro del equipo	payment.team_member_id	string	Identificador del miembro del equipo.
Square Product	payment.application_details.square_product	string	El producto Square, como punto de venta cuadrado (POS), facturas cuadradas o terminal virtual cuadrado.
Id. de solicitud	payment.application_details.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Token de versión	payment.version_token	string	Este token opaco identifica una versión específica del objeto.

Pago de reembolso

Id. de la operación:: RefundPayment

Devuelve un pago. Puede reembolsar el importe de pago completo o una parte de él. Puede usar este punto de conexión para reembolsar un pago con tarjeta o registrar un reembolso de un pago en efectivo o externo.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Identificador de pago	payment_id	string	Identificador único del pago que se va a reembolsar.
Importe	amount	integer	Cantidad de dinero que se aceptará para este pago, no incluyendo tip_money.
Moneda	currency	string	Código de moneda ISO 4217 de 3 caracteres.
Importe	amount	integer	Cantidad de dinero que se aceptará para este pago, no incluyendo tip_money.
Moneda	currency	string	Código de moneda ISO 4217 de 3 caracteres.
Motivo	reason	string	Descripción del motivo del reembolso.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	refund.id	string	Identificador único emitido por Square.
Estado	refund.status	string	Estado de comprobación actual de este objeto.
Importe	refund.amount_money.amount	integer	Cantidad.
Moneda	refund.amount_money.currency	string	Moneda.
Identificador de pago	refund.payment_id	string	Identificador único del pago.
Id. de pedido	refund.order_id	string	Identificador del pedido.
Creado en	refund.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	refund.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Importe	refund.app_fee_money.amount	integer	Cantidad.
Moneda	refund.app_fee_money.currency	string	Moneda.
Id. de ubicación	refund.location_id	string	Identificador de la ubicación.
Motivo	refund.reason	string	Motivo de este objeto.

Pedido de pago (beta)

Id. de la operación:: OrderPay

Pague un pedido con uno o más pagos aprobados o liquide un pedido con un total de 0. El total del payment_ids enumerado en la solicitud debe ser igual al total del pedido. Los pedidos con un importe total de 0 se pueden marcar como pagados especificando una matriz vacía de payment_ids en la solicitud.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de pedido	order_id	True	string	Identificador del pedido.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Identificadores de pago	payment_ids		array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	order.id	string	Identificador único emitido por Square.
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Elementos de línea	order.line_items	array of object
UID	order.line_items.uid	string	Identificador generado por square.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Versión	order.version	integer	La versión actual de este objeto.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Importe	order.total_money.amount	integer	Cantidad.
Moneda	order.total_money.currency	string	Moneda.
Cerrado en	order.closed_at	string	Hora en que se cierra, en formato ISO 8601.
Licitaciones	order.tenders	array of object
identificación	order.tenders.id	string	Identificador del objeto
Id. de ubicación	order.tenders.location_id	string	Identificador de ubicación de un destinatario (distinto del comerciante) que recibe una parte de esta licitación.
Id. de transacción	order.tenders.transaction_id	string	Identificador de la transacción asociada de la licitación.
Creado en	order.tenders.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Importe	order.tenders.amount_money.amount	integer	Cantidad.
Moneda	order.tenders.amount_money.currency	string	Moneda.
Tipo	order.tenders.type	string	Indica el tipo.
Estado	order.tenders.card_details.status	string	Estado actual del pago de la tarjeta de crédito (como AUTORIZADO o CAPTURADO)
Marca de tarjeta	order.tenders.card_details.card.card_brand	string	La marca de la tarjeta.
last_4	order.tenders.card_details.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Exp Month	order.tenders.card_details.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	order.tenders.card_details.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	order.tenders.card_details.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Entry (método)	order.tenders.card_details.entry_method	string	Método usado para escribir los detalles de la tarjeta para la transacción.
Identificador de pago	order.tenders.payment_id	string	Identificador único generado por cuadrados del pago.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.tip_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tip_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.
Nombre	order.source.name	string	Nombre.
Estado	order.state	string	Estado actual.

Pedidos de búsqueda

Id. de la operación:: OrderSearch

Busque todos los pedidos de una o varias ubicaciones. Los pedidos incluyen todas las ventas, devoluciones e intercambios independientemente de cómo o cuando entraron en el ecosistema square (como las API punto de venta, facturas y Connect).

Parámetros

Nombre	Clave	Tipo	Description
Devolver entradas	return_entries	boolean	Valor booleano que controla el formato de los resultados de búsqueda. Si es true, SearchOrders devuelve objetos OrderEntry. Si es false, SearchOrders devuelve objetos de orden completos.
Limit	limit	integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.
Identificadores de ubicación	location_ids	array of string
Comenzar a	start_at	string	Valor datetime en formato RFC 3339 que indica cuándo se inicia el intervalo de tiempo.
Finalizar al	end_at	string	Valor datetime en formato RFC 3339 que indica cuándo finaliza el intervalo de tiempo.
States	states	array of string
Ordenar campo	sort_field	string	Campo por el que se va a ordenar.
Criterio de ordenación	sort_order	string	Orden cronológico en el que se devuelven los resultados.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Entradas de pedido	order_entries	array of object
Id. de pedido	order_entries.order_id	string	Identificador del pedido.
Id. de ubicación	order_entries.location_id	string	Identificador de la ubicación.
Versión	order_entries.version	integer	Versión actual del objeto.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Procesamiento por lotes de objetos de catálogo upsert

Id. de la operación:: CatalogBatchUpsert

Crea o actualiza hasta 10 000 objetos de destino en función de la lista de objetos proporcionada. Los objetos de destino se agrupan en lotes y cada lote se inserta o actualiza de forma total o nada. Si un objeto dentro de un lote tiene un formato incorrecto o infringe una restricción de base de datos, se omitirá todo el lote que contiene ese elemento. Sin embargo, es posible que otros lotes de la misma solicitud se realicen correctamente. Cada lote puede contener hasta 1000 objetos y los lotes se procesarán en orden siempre que el número total de objetos para la solicitud (elementos, variaciones, listas modificadoras, descuentos e impuestos) no sea superior a 10 000.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Tipo	type	string	El tipo de este objeto.
identificación	id	string	Identificador para hacer referencia a este objeto.
Presente en todas las ubicaciones	present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Description	title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Id. de categoría	category_id	string	Identificador de la categoría del elemento, si existe.
Números de Identificación Fiscal	tax_ids	array of string
Tipo	type	string	El tipo de este objeto. Cada tipo de objeto tiene propiedades esperadas expresadas en un formato estructurado dentro de su campo *_data correspondiente a continuación.
identificación	id	string	Identificador para hacer referencia a este objeto.
Presente en todas las ubicaciones	present_at_all_locations	boolean	Si está presente en todas las ubicaciones.
Id. de elemento	item_id	string	Identificador del elemento.
Nombre	name	string	El nombre del elemento.
Tipo de precios	pricing_type	string	Tipo de precios.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Fase de cálculo	calculation_phase	string	Si el impuesto se calcula en función del subtotal o total de un pago.
Tipo de inclusión	inclusion_type	string	Si el impuesto es ADITIVO o INCLUSIVO.
Porcentaje	percentage	string	Porcentaje del impuesto en formato decimal, utilizando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Se aplica a importes personalizados	applies_to_custom_amounts	boolean	Si es true, la tarifa se aplica a los importes personalizados introducidos en la aplicación Square Point of Sale que no están asociadas a un catalogItem determinado.
Enabled	enabled	boolean	Marca booleana para indicar si el impuesto se muestra como habilitado (true) en la aplicación Punto de venta cuadrado o no (false).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	El tipo de este objeto.
identificación	objects.id	string	Identificador único emitido por Square.
Actualizado en	objects.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.version	integer	Versión actual del objeto.
Está eliminado	objects.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	objects.item_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Description	objects.item_data.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Id. de categoría	objects.item_data.category_id	string	Identificador de la categoría del elemento, si existe.
Números de Identificación Fiscal	objects.item_data.tax_ids	array of string
Variaciones	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	El tipo de este objeto. Cada tipo de objeto tiene propiedades esperadas expresadas en un formato estructurado dentro de su campo *_data correspondiente a continuación.
identificación	objects.item_data.variations.id	string	Identificador para hacer referencia a este objeto.
Actualizado en	objects.item_data.variations.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.item_data.variations.version	integer	Versión del objeto . Al actualizar un objeto, la versión proporcionada debe coincidir con la versión de la base de datos; de lo contrario, la escritura se rechazará como en conflicto.
Está eliminado	objects.item_data.variations.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.item_data.variations.present_at_all_locations	boolean	Lista de ubicaciones en las que está presente el objeto, incluso si present_at_all_locations es false. Esto puede incluir ubicaciones desactivadas.
Id. de elemento	objects.item_data.variations.item_variation_data.item_id	string	Identificador del objeto con esta variación de elemento.
Nombre	objects.item_data.variations.item_variation_data.name	string	Nombre de este elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Orden en el que se debe mostrar esta variación de elemento. Este valor es de solo lectura.
Tipo de precios	objects.item_data.variations.item_variation_data.pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Importe	objects.item_data.variations.item_variation_data.price_money.amount	integer	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda. Por ejemplo, cuando la moneda es USD, la cantidad está en centavos. Las cantidades monetarias pueden ser positivas o negativas. Vea la descripción de campo específica para determinar el significado del inicio de sesión en un caso determinado.
Moneda	objects.item_data.variations.item_variation_data.price_money.currency	string	Tipo de moneda, en formato ISO 4217. Por ejemplo, el código de moneda para dólares estadounidenses es USD.
Nombre	objects.category_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Nombre	objects.tax_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Fase de cálculo	objects.tax_data.calculation_phase	string	Si el impuesto se calcula en función del subtotal o total de un pago.
Tipo de inclusión	objects.tax_data.inclusion_type	string	Si el impuesto es ADITIVO o INCLUSIVO.
Porcentaje	objects.tax_data.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Se aplica a cantidades personalizadas	objects.tax_data.applies_to_custom_amounts	boolean	Si es true, la tarifa se aplica a los importes personalizados introducidos en la aplicación Square Point of Sale que no están asociadas a un catalogItem determinado.
Enabled	objects.tax_data.enabled	boolean	Indica si se puede usar un objeto o no.
Asignaciones de identificadores	id_mappings	array of object
Id. de objeto de cliente	id_mappings.client_object_id	string	Identificador #-prefijo temporal proporcionado por el cliente para un nuevo CatalogObject.
Id. de objeto	id_mappings.object_id	string	Identificador permanente creado por el servidor.

Publicar factura

Id. de la operación:: InvoicePublish

Publica la factura de borrador especificada. Una vez publicada una factura, Square se rige por la configuración de la factura. Por ejemplo, Square envía la factura a la dirección de correo electrónico del cliente, cobra la tarjeta del cliente en el archivo o no hace nada. Square también hace que la factura esté disponible en una página de factura hospedada en Square.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de factura	invoice_id	True	string	Identificador de la factura.
Versión	version		integer	La versión.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	invoice.id	string	Identificador único emitido por Square.
Versión	invoice.version	integer	La versión actual de este objeto.
Id. de ubicación	invoice.location_id	string	Identificador de la ubicación.
Id. de pedido	invoice.order_id	string	Identificador del pedido.
Solicitudes de pago	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identificador generado por square.
Tipo de solicitud	invoice.payment_requests.request_type	string	Identifica el tipo de solicitud de pago. Este tipo define cómo se determina el importe de la solicitud de pago.
Fecha límite	invoice.payment_requests.due_date	string	Fecha de vencimiento de la solicitud de pago, en formato aaaa-MM-DD.
Propina habilitada	invoice.payment_requests.tipping_enabled	boolean	Si se establece en true, proporciona un lugar para que el cliente pague una propina.
Recordatorios	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Un identificador asignado a Cuadrado.
Días programados relativos	invoice.payment_requests.reminders.relative_scheduled_days	integer	El número de días antes (un número negativo) o después (un número positivo) la solicitud de pago due_date cuando se envía el aviso.
Message	invoice.payment_requests.reminders.message	string	Mensaje.
Estado	invoice.payment_requests.reminders.status	string	Estado actual.
Importe	invoice.payment_requests.computed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.computed_amount_money.currency	string	Moneda.
Importe	invoice.payment_requests.total_completed_amount_money.amount	integer	Cantidad.
Moneda	invoice.payment_requests.total_completed_amount_money.currency	string	Moneda.
Origen de pago automático	invoice.payment_requests.automatic_payment_source	string	Método de pago para un pago automático.
Número de factura	invoice.invoice_number	string	Número de factura fácil de usar. El valor es único dentro de una ubicación. Si no se proporciona al crear una factura, Square asigna un valor.
Title	invoice.title	string	Título.
Description	invoice.description	string	Descripción.
Programado en	invoice.scheduled_at	string	Marca de tiempo cuando se programa el procesamiento, en formato RFC 3339.
Estado	invoice.status	string	Estado de comprobación actual de este objeto.
Timezone	invoice.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Creado en	invoice.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	invoice.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de cliente	invoice.primary_recipient.customer_id	string	Identificador del cliente asociado al pedido.
Nombre propio	invoice.primary_recipient.given_name	string	El nombre del destinatario (es decir, primero).
Apellido	invoice.primary_recipient.family_name	string	Familia del destinatario (es decir, apellido).
Dirección de correo electrónico	invoice.primary_recipient.email_address	string	La dirección de correo electrónico del destinatario.
Número de teléfono	invoice.primary_recipient.phone_number	string	Número de teléfono del destinatario.
Dirección URL pública	invoice.public_url	string	Dirección URL de la página de factura hospedada en Square. Después de publicar la factura mediante el punto de conexión PublishInvoice, Square hospeda la página de factura y devuelve la dirección URL de la página en la respuesta.
Card	invoice.accepted_payment_methods.card	boolean	Indica si se aceptan pagos con tarjeta de crédito o tarjeta de débito.
Tarjeta regalo cuadrada	invoice.accepted_payment_methods.square_gift_card	boolean	Indica si se aceptan pagos con tarjeta de regalo Square.
Cuenta bancaria	invoice.accepted_payment_methods.bank_account	boolean	Indica si se aceptan pagos de transferencia bancaria.
Campos personalizados	invoice.custom_fields	array of object
Etiqueta	invoice.custom_fields.label	string	Etiqueta o título del campo personalizado.
Importancia	invoice.custom_fields.value	string	Texto del campo personalizado.
Colocación	invoice.custom_fields.placement	string	Ubicación del campo personalizado en la factura.
Delivery (método)	invoice.delivery_method	string	El método de entrega que Square usa para enviar la factura, los recordatorios y los recibos al cliente. Una vez publicada la factura, Square procesa la factura en función del método de entrega y la configuración de la solicitud de pago, ya sea inmediatamente o en la fecha de scheduled_at, si se especifica.
Fecha de venta o servicio	invoice.sale_or_service_date	string	La fecha de la venta o la fecha en que se representa el servicio, en formato AAAA-MM-DD. Este campo se puede usar para especificar una fecha pasada o futura que se muestra en la factura.

Quitar grupo del cliente

Id. de la operación:: CustomerRemoveGroup

Quita una pertenencia a un grupo de un cliente. El cliente se identifica mediante el valor de customer_id y el grupo de clientes se identifica mediante el valor de group_id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente	customer_id	True	string	Identificador del cliente.
Identificador de grupo	group_id	True	string	Identificador del grupo.

Devoluciones

response: object

Reanudación de la suscripción

Id. de la operación:: SubscriptionResume

Reanuda una suscripción desactivada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscription_id	True	string	Identificador de la suscripción.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	subscription.id	string	Identificador único emitido por Square.
Id. de ubicación	subscription.location_id	string	Identificador de la ubicación.
Id. de plan	subscription.plan_id	string	Identificador del plan de suscripción asociado.
Id. de cliente	subscription.customer_id	string	Identificador de este objeto que representa al cliente.
Estado	subscription.status	string	Estado de comprobación actual de este objeto.
Importe	subscription.price_override_money.amount	integer	Cantidad.
Moneda	subscription.price_override_money.currency	string	Moneda.
Versión	subscription.version	integer	La versión actual de este objeto.
Creado en	subscription.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Timezone	subscription.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscription.source.name	string	Nombre.

Recuentos de inventario de recuperación por lotes

Id. de la operación:: InventoryBatchRetrieveCounts

Devuelve los recuentos actuales de los objetos CatalogObject proporcionados en las ubicaciones solicitadas.

Parámetros

Nombre	Clave	Tipo	Description
Identificadores de objeto de catálogo	catalog_object_ids	array of string
Identificadores de ubicación	location_ids	array of string
Actualizado después	updated_after	string	Filtro para devolver resultados con su valor de calculated_at después del tiempo especificado en una marca de tiempo RFC 3339.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cuenta	counts	array of object
Id. de objeto de catálogo	counts.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	counts.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Estado	counts.state	string	Estado actual.
Id. de ubicación	counts.location_id	string	Identificador de la ubicación.
Cantidad	counts.quantity	string	Número de elementos afectados por el recuento estimado como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Calculado en	counts.calculated_at	string	Marca de tiempo con formato RFC 3339 que indica cuándo se recibe el recuento físico o ajuste más reciente que afecta al recuento estimado.

Recuperación de la suscripción

Id. de la operación:: SubscriptionRetrieve

Recupera una suscripción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscription_id	True	string	Identificador de la suscripción.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	subscription.id	string	Identificador único emitido por Square.
Id. de ubicación	subscription.location_id	string	Identificador de la ubicación.
Id. de plan	subscription.plan_id	string	Identificador del plan de suscripción asociado.
Id. de cliente	subscription.customer_id	string	Identificador de este objeto que representa al cliente.
Fecha de inicio	subscription.start_date	string	La fecha de inicio de la suscripción, en formato aaaa-MM-DD.
Fecha de cargo	subscription.charged_through_date	string	Fecha hasta la que se factura al cliente para la suscripción, en formato aaaa-MM-DD.
Estado	subscription.status	string	Estado de comprobación actual de este objeto.
Identificadores de factura	subscription.invoice_ids	array of string
Importe	subscription.price_override_money.amount	integer	Cantidad.
Moneda	subscription.price_override_money.currency	string	Moneda.
Creado en	subscription.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Fecha de pago hasta la fecha	subscription.paid_until_date	string	Fecha de pago hasta.
Timezone	subscription.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Nombre	subscription.source.name	string	Nombre.

Recuperación de la transferencia de inventario (Beta)

Id. de la operación:: InventoryRetrieveTransfer

Devuelve el objeto InventoryTransfer con el transfer_id proporcionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la transferencia	transfer_id	True	string	Identificador de la transferencia.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	transfer.id	string	Identificador único emitido por Square.
Id. de objeto de catálogo	transfer.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	transfer.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Creado en	transfer.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. de empleado	transfer.employee_id	string	Identificador generado por cuadrados del empleado.
Id. de ubicación	transfer.from_location_id	string	Identificador generado por cuadrados de la ubicación en la que se realizó el seguimiento de la cantidad relacionada de elementos antes de la transferencia.
Id. de ubicación	transfer.to_location_id	string	Identificador generado por cuadrados de la ubicación en la que se realizó el seguimiento de la cantidad relacionada de elementos después de la transferencia.
Se produjo en	transfer.occurred_at	string	Marca de tiempo con formato RFC 3339 generado por el cliente que indica cuándo tuvo lugar el ajuste del inventario. En el caso de las actualizaciones de ajuste de inventario, la marca de tiempo de occurred_at no puede ser anterior a las 24 horas o en el futuro en relación con el tiempo de la solicitud.
Cantidad	transfer.quantity	string	Número de elementos afectados por el ajuste como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Identificador de referencia	transfer.reference_id	string	Identificador de referencia definido por el usuario opcional.
Producto	transfer.source.product	string	Tipo de producto para la aplicación.
Id. de solicitud	transfer.source.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Nombre	transfer.source.name	string	Nombre.
Estado	transfer.state	string	Estado actual.

Recuperación de objetos de catálogo por lotes

Id. de la operación:: CatalogBatchRetrieve

Devuelve un conjunto de objetos basado en el identificador proporcionado. Cada catalogItem devuelto en el conjunto incluye toda su información secundaria, incluyendo: todos sus objetos CatalogItemVariation, referencias a sus objetos CatalogModifierList y los identificadores de los objetos CatalogTax que se aplican a él.

Parámetros

Nombre	Clave	Tipo	Description
Identificadores de objeto	object_ids	array of string
Versión del catálogo	catalog_version	integer	Versión específica de los objetos de catálogo que se van a incluir en la respuesta. Esto le permite recuperar versiones históricas de objetos. El valor de versión especificado coincide con el atributo de versión de CatalogObjects.
Incluir objetos relacionados	include_related_objects	boolean	Si es true, la respuesta incluirá objetos adicionales relacionados con los objetos solicitados, como se indica a continuación: Si el campo de objetos de la respuesta contiene un objeto CatalogItem, sus objetos CatalogCategory asociados, objetos CatalogTax, objetos CatalogImage y CatalogModifierLists se devolverán en el campo related_objects de la respuesta. Si el campo objetos de la respuesta contiene catalogItemVariation, se devolverá su objeto CatalogItem primario en el campo related_objects de la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Objetos	objects	array of object
Tipo	objects.type	string	El tipo de este objeto.
identificación	objects.id	string	Identificador único emitido por Square.
Actualizado en	objects.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.version	integer	Versión actual del objeto.
Está eliminado	objects.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	objects.item_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Description	objects.item_data.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Id. de categoría	objects.item_data.category_id	string	Identificador de la categoría del elemento, si existe.
Números de Identificación Fiscal	objects.item_data.tax_ids	array of string
Variaciones	objects.item_data.variations	array of object
Tipo	objects.item_data.variations.type	string	El tipo de este objeto. Cada tipo de objeto tiene propiedades esperadas expresadas en un formato estructurado dentro de su campo *_data correspondiente a continuación.
identificación	objects.item_data.variations.id	string	Identificador para hacer referencia a este objeto.
Actualizado en	objects.item_data.variations.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	objects.item_data.variations.version	integer	Versión del objeto . Al actualizar un objeto, la versión proporcionada debe coincidir con la versión de la base de datos; de lo contrario, la escritura se rechazará como en conflicto.
Está eliminado	objects.item_data.variations.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	objects.item_data.variations.present_at_all_locations	boolean	Lista de ubicaciones en las que está presente el objeto, incluso si present_at_all_locations es false. Esto puede incluir ubicaciones desactivadas.
Id. de elemento	objects.item_data.variations.item_variation_data.item_id	string	Identificador del objeto con esta variación de elemento.
Nombre	objects.item_data.variations.item_variation_data.name	string	Nombre de este elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Ordinal	objects.item_data.variations.item_variation_data.ordinal	integer	Orden en el que se debe mostrar esta variación de elemento. Este valor es de solo lectura.
Tipo de precios	objects.item_data.variations.item_variation_data.pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Importe	objects.item_data.variations.item_variation_data.price_money.amount	integer	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda. Por ejemplo, cuando la moneda es USD, la cantidad está en centavos. Las cantidades monetarias pueden ser positivas o negativas. Vea la descripción de campo específica para determinar el significado del inicio de sesión en un caso determinado.
Moneda	objects.item_data.variations.item_variation_data.price_money.currency	string	Tipo de moneda, en formato ISO 4217. Por ejemplo, el código de moneda para dólares estadounidenses es USD.
Objetos relacionados	related_objects	array of object
Tipo	related_objects.type	string	El tipo de este objeto.
identificación	related_objects.id	string	Identificador único emitido por Square.
Actualizado en	related_objects.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Versión	related_objects.version	integer	Versión actual del objeto.
Está eliminado	related_objects.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	related_objects.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	related_objects.category_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Nombre	related_objects.tax_data.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Fase de cálculo	related_objects.tax_data.calculation_phase	string	Si el impuesto se calcula en función del subtotal o total de un pago.
Tipo de inclusión	related_objects.tax_data.inclusion_type	string	Si el impuesto es ADITIVO o INCLUSIVO.
Porcentaje	related_objects.tax_data.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Enabled	related_objects.tax_data.enabled	boolean	Indica si se puede usar un objeto o no.

Recuperación del ajuste de inventario

Id. de la operación:: InventoryRetrieveAdjustment

Devuelve el objeto InventoryAdjustment con el adjustment_id proporcionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ajuste	adjustment_id	True	string	Identificador del ajuste.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	adjustment.id	string	Identificador único emitido por Square.
Identificador de referencia	adjustment.reference_id	string	Identificador de referencia definido por el usuario opcional.
From State	adjustment.from_state	string	Estado de inventario de la cantidad relacionada de artículos antes del ajuste.
A estado	adjustment.to_state	string	Estado de inventario de la cantidad relacionada de artículos después del ajuste.
Id. de ubicación	adjustment.location_id	string	Identificador de la ubicación.
Id. de objeto de catálogo	adjustment.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	adjustment.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Cantidad	adjustment.quantity	string	Número de elementos afectados por el ajuste como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Importe	adjustment.total_price_money.amount	integer	Cantidad.
Moneda	adjustment.total_price_money.currency	string	Moneda.
Se produjo en	adjustment.occurred_at	string	Marca de tiempo con formato RFC 3339 generado por el cliente que indica cuándo tuvo lugar el ajuste del inventario. En el caso de las actualizaciones de ajuste de inventario, la marca de tiempo de occurred_at no puede ser anterior a las 24 horas o en el futuro en relación con el tiempo de la solicitud.
Creado en	adjustment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Producto	adjustment.source.product	string	Tipo de producto para la aplicación.
Id. de solicitud	adjustment.source.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Nombre	adjustment.source.name	string	Nombre.
Id. de empleado	adjustment.employee_id	string	Identificador generado por cuadrados del empleado.

Recuperación del cliente

Id. de la operación:: CustomerRetrieve

Devuelve los detalles de un solo cliente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente	customer_id	True	string	Identificador del cliente.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	customer.id	string	Identificador único emitido por Square.
Creado en	customer.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	customer.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Nombre propio	customer.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	customer.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	customer.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Línea de dirección 1	customer.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	customer.address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	customer.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	customer.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	customer.address.postal_code	string	El código postal de la dirección.
País	customer.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Número de teléfono	customer.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificador de referencia	customer.reference_id	string	Identificador de referencia definido por el usuario opcional.
Nota:	customer.note	string	Una nota personalizada asociada al perfil de cliente.
Correo electrónico cancelado	customer.preferences.email_unsubscribed	boolean	Indica si el cliente ha cancelado la suscripción a los correos electrónicos de campaña de marketing. Un valor true significa que el cliente eligió no participar en el marketing por correo electrónico del vendedor actual de Square o de todos los vendedores de Square.
Origen de creación	customer.creation_source	string	Un origen de creación representa el método usado para crear el perfil de cliente.
Identificadores de grupo	customer.group_ids	array of string
Identificadores de segmento	customer.segment_ids	array of string
Versión	customer.version	integer	La versión actual de este objeto.

Recuperación del grupo de clientes

Id. de la operación:: CustomerGroupRetrieve

Recupera un grupo de clientes específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	group_id	True	string	Identificador del grupo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	group.id	string	Identificador único emitido por Square.
Nombre	group.name	string	Nombre del objeto.
Creado en	group.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	group.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperación del recuento de inventario

Id. de la operación:: InventoryRetrieveCount

Recupera el recuento de existencias calculado actual para un catalogObject determinado en un conjunto determinado de ubicaciones.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de objeto de catálogo	catalog_object_id	True	string	Identificador del objeto de catálogo.
Identificadores de ubicación	location_ids		string	Identificadores de ubicación para buscar como una lista separada por comas. Una lista vacía consulta todas las ubicaciones.
Cursor	cursor		string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cuenta	counts	array of object
Id. de objeto de catálogo	counts.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	counts.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Estado	counts.state	string	Estado actual.
Id. de ubicación	counts.location_id	string	Identificador de la ubicación.
Cantidad	counts.quantity	string	Número de elementos afectados por el recuento estimado como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Calculado en	counts.calculated_at	string	Marca de tiempo con formato RFC 3339 que indica cuándo se recibe el recuento físico o ajuste más reciente que afecta al recuento estimado.

Recuperación del recuento físico de inventario

Id. de la operación:: InventoryRetrievePhysicalCount

Devuelve el objeto InventoryPhysicalCount con el physical_count_id proporcionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recuento físico	physical_count_id	True	string	Identificador del recuento físico.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	count.id	string	Identificador único emitido por Square.
Identificador de referencia	count.reference_id	string	Identificador de referencia definido por el usuario opcional.
Id. de objeto de catálogo	count.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	count.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Estado	count.state	string	Estado actual.
Id. de ubicación	count.location_id	string	Identificador de la ubicación.
Cantidad	count.quantity	string	Número de elementos afectados por el ajuste como una cadena decimal. Puede admitir hasta 5 dígitos después del separador decimal.
Producto	count.source.product	string	Tipo de producto para la aplicación.
Id. de solicitud	count.source.application_id	string	Id. cuadrado de solo lectura asignado a la aplicación.
Nombre	count.source.name	string	Nombre.
Id. de empleado	count.employee_id	string	Identificador generado por cuadrados del empleado.
Se produjo en	count.occurred_at	string	Marca de tiempo con formato RFC 3339 generado por el cliente que indica cuándo tuvo lugar el ajuste del inventario. En el caso de las actualizaciones de ajuste de inventario, la marca de tiempo de occurred_at no puede ser anterior a las 24 horas o en el futuro en relación con el tiempo de la solicitud.
Creado en	count.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.

Recuperación del segmento de cliente

Id. de la operación:: CustomerSegmentRetrieve

Recupera un segmento de cliente específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de segmento	segment_id	True	string	Identificador del segmento.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	segment.id	string	Identificador único emitido por Square.
Nombre	segment.name	string	Nombre del objeto.
Creado en	segment.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	segment.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperación por lotes de cambios de inventario

Id. de la operación:: InventoryBatchRetrieveChanges

Devuelve recuentos físicos históricos y ajustes en función de los criterios de filtro proporcionados.

Parámetros

Nombre	Clave	Tipo	Description
Identificadores de objeto de catálogo	catalog_object_ids	array of string
Identificadores de ubicación	location_ids	array of string
Tipos	types	array of string
States	states	array of string
Actualizado después	updated_after	string	Filtro para devolver resultados con su valor de calculated_at después del tiempo especificado en una marca de tiempo RFC 3339.
Actualizado antes	updated_before	string	Filtro para devolver resultados con su valor de created_at o calculated_at estrictamente antes del tiempo especificado en una marca de tiempo RFC 3339.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Changes	changes	array of object
Tipo	changes.type	string	El tipo de este objeto.
identificación	changes.physical_count.id	string	Identificador del objeto
Identificador de referencia	changes.physical_count.reference_id	string	Identificador de referencia opcional definido por el usuario que asocia esta tarjeta a otra entidad en un sistema externo.
Id. de objeto de catálogo	changes.physical_count.catalog_object_id	string	Identificador generado por Square del objeto CatalogObject al que se realiza el seguimiento.
Tipo de objeto catalog	changes.physical_count.catalog_object_type	string	Tipo del objeto CatalogObject al que se realiza el seguimiento.
Estado	changes.physical_count.state	string	Estado de inventario actual para la cantidad relacionada de artículos.
Id. de ubicación	changes.physical_count.location_id	string	Identificador de ubicación de un destinatario (distinto del comerciante) que recibe una parte de esta licitación.
Cantidad	changes.physical_count.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Producto	changes.physical_count.source.product	string	Tipo de producto para la aplicación.
Id. de solicitud	changes.physical_count.source.application_id	string	Id. cuadrado asignado a la aplicación.
Nombre	changes.physical_count.source.name	string	El nombre del elemento.
Id. de empleado	changes.physical_count.employee_id	string	El identificador generado por Square del empleado responsable del recuento físico.
Se produjo en	changes.physical_count.occurred_at	string	Marca de tiempo con formato RFC 3339 generado por el cliente que indica cuándo se examinó el recuento físico. En el caso de las actualizaciones de recuento físico, la occurred_at marca de tiempo no puede tener más de 24 horas o en el futuro en relación con el tiempo de la solicitud.
Creado en	changes.physical_count.created_at	string	Marca de tiempo con formato RFC 3339 generada por el cliente que indica cuándo se creó el recuento físico.

Recuperar disputa

Id. de la operación:: DisputeRetrieve

Devuelve detalles sobre una disputa específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	dispute.id	string	Identificador único emitido por Square.
Importe	dispute.amount_money.amount	integer	Cantidad.
Moneda	dispute.amount_money.currency	string	Moneda.
Motivo	dispute.reason	string	Motivo de este objeto.
Estado	dispute.state	string	Estado actual.
Vencimiento a	dispute.due_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.
Pagos disputados	dispute.disputed_payments	array of object
Identificador de pago	dispute.disputed_payments.payment_id	string	Identificador único generado por cuadrados del pago.
Marca de tarjeta	dispute.card_brand	string	La marca de la tarjeta.
Creado en	dispute.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	dispute.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Identificador de disputa de marca	dispute.brand_dispute_id	string	El identificador de la disputa en el sistema de marca de tarjeta, generado por la marca de tarjeta.

Recuperar evidencia de controversia

Id. de la operación:: DisputeRetrieveEvidence

Devuelve los metadatos de evidencia especificados por el identificador de evidencia en la ruta de acceso de la dirección URL de la solicitud. Debe mantener una copia de la evidencia que cargue si desea hacer referencia a ella más adelante. No puede descargar la evidencia después de cargarla.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de disputa	dispute_id	True	string	Identificador de la disputa.
Identificador de evidencia	evidence_id	True	string	Identificador de la evidencia.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	evidence.id	string	Identificador único emitido por Square.
Id. de disputa	evidence.dispute_id	string	El identificador de la disputa con el que está asociada la evidencia.
Filename	evidence.evidence_file.filename	string	Los archivos de evidencia de controversia deben ser formatos application/pdf, image/heic, image/heif, image/jpeg, image/png o image/tiff.
Tipo de archivo	evidence.evidence_file.filetype	string	Nombre de archivo que incluye la extensión de archivo.
Tipo de evidencia	evidence.evidence_type	string	Evidencia de tipo pf.
Cargado en	evidence.uploaded_at	string	Hora a la que se debe realizar la siguiente acción, en formato RFC 3339.

Recuperar objeto de catálogo

Id. de la operación:: CatalogRetrieve

Devuelve un único CatalogItem como catalogObject basado en el identificador proporcionado. El objeto devuelto incluye toda la información catalogItem pertinente, incluidos los elementos secundarios CatalogItemVariation, las referencias a sus objetos CatalogModifierList y los identificadores de los objetos CatalogTax que se aplican a él.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de objeto	object_id	True	string	Identificador del objeto.
Incluir objetos relacionados	include_related_objects		boolean	Si es true, la respuesta incluirá objetos adicionales relacionados con el objeto solicitado, como se indica a continuación: Si el campo de objeto de la respuesta contiene un objeto CatalogItem, sus objetos CatalogCategory, CatalogTax, CatalogImage y CatalogModifierList se devolverán en el campo related_objects de la respuesta. Si el campo de objeto de la respuesta contiene catalogItemVariation, se devolverá su objeto CatalogItem primario en el campo related_objects de la respuesta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Tipo	object.type	string	El tipo de este objeto.
identificación	object.id	string	Identificador único emitido por Square.
Actualizado en	object.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Versión	object.version	integer	La versión actual de este objeto.
Está eliminado	object.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
present_at_all_locations	object.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	object.item_data.name	string	Nombre.
Description	object.item_data.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Id. de categoría	object.item_data.category_id	string	Identificador de la categoría del elemento, si existe.
Números de Identificación Fiscal	object.item_data.tax_ids	array of string
Variaciones	object.item_data.variations	array of object
Tipo	object.item_data.variations.type	string	El tipo de este objeto.
identificación	object.item_data.variations.id	string	Identificador para hacer referencia a este objeto en el catálogo.
Actualizado en	object.item_data.variations.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339.
Versión	object.item_data.variations.version	integer	Versión del objeto . Al actualizar un objeto, la versión proporcionada debe coincidir con la versión de la base de datos; de lo contrario, la escritura se rechazará como en conflicto.
Está eliminado	object.item_data.variations.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	object.item_data.variations.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Id. de elemento	object.item_data.variations.item_variation_data.item_id	string	Identificador del objeto CatalogItem asociado a esta variación de elemento.
Nombre	object.item_data.variations.item_variation_data.name	string	Nombre de la variación del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Ordinal	object.item_data.variations.item_variation_data.ordinal	integer	Orden en el que se debe mostrar esta variación de elemento. Este valor es de solo lectura. En las escrituras, el ordinal para cada variación de elemento dentro de un CatalogItem primario se establece según la posición de las variaciones de elemento. En las lecturas, no se garantiza que el valor sea secuencial o único.
Tipo de precios	object.item_data.variations.item_variation_data.pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Importe	object.item_data.variations.item_variation_data.price_money.amount	integer	Cantidad.
Moneda	object.item_data.variations.item_variation_data.price_money.currency	string	Moneda.

Recuperar pedido

Id. de la operación:: OrderRetrieve

Recupera un pedido por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de pedido	order_id	True	string	Identificador del pedido.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	order.id	string	Identificador único emitido por Square.
Id. de ubicación	order.location_id	string	Identificador de la ubicación.
Elementos de línea	order.line_items	array of object
UID	order.line_items.uid	string	Identificador generado por square.
Cantidad	order.line_items.quantity	string	Número de elementos afectados por el recuento físico como una cadena decimal. El número puede admitir hasta 5 dígitos después del separador decimal.
Nombre	order.line_items.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Importe	order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	order.line_items.base_price_money.currency	string	Moneda.
Importe	order.line_items.gross_sales_money.amount	integer	Cantidad.
Moneda	order.line_items.gross_sales_money.currency	string	Moneda.
Importe	order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	order.line_items.total_tax_money.currency	string	Moneda.
Importe	order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	order.line_items.total_discount_money.currency	string	Moneda.
Importe	order.line_items.total_money.amount	integer	Cantidad.
Moneda	order.line_items.total_money.currency	string	Moneda.
Importe	order.line_items.variation_total_price_money.amount	integer	Cantidad.
Moneda	order.line_items.variation_total_price_money.currency	string	Moneda.
Descuentos aplicados	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Un identificador asignado a Cuadrado.
UID de descuento	order.line_items.applied_discounts.discount_uid	string	Interfaz de usuario del descuento que representa el descuento aplicado.
Importe	order.line_items.applied_discounts.applied_money.amount	integer	Cantidad.
Moneda	order.line_items.applied_discounts.applied_money.currency	string	Moneda.
Descuentos	order.discounts	array of object
UID	order.discounts.uid	string	Identificador generado por square.
Nombre	order.discounts.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Porcentaje	order.discounts.percentage	string	Porcentaje en formato decimal, usando un signo "." como separador decimal y sin un signo "%". Un valor de 7,5 corresponde a 7,5%.
Importe	order.discounts.applied_money.amount	integer	Cantidad.
Moneda	order.discounts.applied_money.currency	string	Moneda.
Tipo	order.discounts.type	string	Indica el tipo.
Ámbito	order.discounts.scope	string	Indica el nivel actual.
Creado en	order.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	order.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Estado	order.state	string	Estado actual.
Versión	order.version	integer	La versión actual de este objeto.
Importe	order.total_tax_money.amount	integer	Cantidad.
Moneda	order.total_tax_money.currency	string	Moneda.
Importe	order.total_discount_money.amount	integer	Cantidad.
Moneda	order.total_discount_money.currency	string	Moneda.
Importe	order.total_tip_money.amount	integer	Cantidad.
Moneda	order.total_tip_money.currency	string	Moneda.
Importe	order.total_money.amount	integer	Cantidad.
Moneda	order.total_money.currency	string	Moneda.
Importe	order.total_service_charge_money.amount	integer	Cantidad.
Moneda	order.total_service_charge_money.currency	string	Moneda.
Importe	order.net_amounts.total_money.amount	integer	Cantidad.
Moneda	order.net_amounts.total_money.currency	string	Moneda.
Importe	order.net_amounts.tax_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tax_money.currency	string	Moneda.
Importe	order.net_amounts.discount_money.amount	integer	Cantidad.
Moneda	order.net_amounts.discount_money.currency	string	Moneda.
Importe	order.net_amounts.tip_money.amount	integer	Cantidad.
Moneda	order.net_amounts.tip_money.currency	string	Moneda.
Importe	order.net_amounts.service_charge_money.amount	integer	Cantidad.
Moneda	order.net_amounts.service_charge_money.currency	string	Moneda.

Recuperar pedidos por lotes

Id. de la operación:: OrderBatchRetrieve

Recupera un conjunto de pedidos por sus identificadores. Si no existe un identificador de pedido determinado, se omite el identificador en lugar de generar un error.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ubicación	location_id		string	Identificador de ubicación.
Identificadores de pedido	order_ids		array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Orders	orders	array of object
identificación	orders.id	string	Identificador único emitido por Square.
Id. de ubicación	orders.location_id	string	Identificador de la ubicación.
Identificador de referencia	orders.reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Elementos de línea	orders.line_items	array of object
UID	orders.line_items.uid	string	Identificador generado por Square de la solicitud de pago en una factura.
Nombre	orders.line_items.name	string	Un nombre legible.
Cantidad	orders.line_items.quantity	string	Cantidad comprada, con formato de número decimal.
Importe	orders.line_items.base_price_money.amount	integer	Cantidad.
Moneda	orders.line_items.base_price_money.currency	string	Moneda.
Importe	orders.line_items.total_money.amount	integer	Cantidad.
Moneda	orders.line_items.total_money.currency	string	Moneda.
Importe	orders.total_money.amount	integer	Cantidad.
Moneda	orders.total_money.currency	string	Moneda.

Recuperar tarjeta

Id. de la operación:: CardRetrieve

Recupera los detalles de una tarjeta específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de tarjeta	card_id	True	string	Identificador de la tarjeta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	card.id	string	Identificador único emitido por Square.
Línea de dirección 1	card.billing_address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	card.billing_address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	card.billing_address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	card.billing_address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	card.billing_address.postal_code	string	El código postal de la dirección.
País	card.billing_address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Huellas	card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
BOTE	card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Marca de tarjeta	card.card_brand	string	La marca de la tarjeta.
Tipo de tarjeta	card.card_type	string	Tipo de la tarjeta.
Nombre del titular de tarjeta	card.cardholder_name	string	Nombre del titular de la tarjeta.
Id. de cliente	card.customer_id	string	Identificador de este objeto que representa al cliente.
Enabled	card.enabled	boolean	Indica si está habilitado.
Exp Month	card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Exp Year	card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Últimos 4	card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Tipo de prepago	card.prepaid_type	string	Indica si la tarjeta está prepagada o no.
Identificador de referencia	card.reference_id	string	Identificador de referencia definido por el usuario opcional.
Versión	card.version	integer	La versión actual de este objeto.

Reembolsos del terminal de búsqueda

Id. de la operación:: TerminalSearchRefunds

Recupera una lista filtrada de solicitudes de reembolso de Terminal Interac creadas por el vendedor que realiza la solicitud.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.
Estado	status		string	Estado actual.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Reembolsos	refunds	array of object
identificación	refunds.id	string	Identificador único emitido por Square.
Id. de reembolso	refunds.refund_id	string	El identificador único de este reembolso, generado por Square.
Identificador de pago	refunds.payment_id	string	Identificador del pago.
Importe	refunds.amount_money.amount	integer	Cantidad.
Moneda	refunds.amount_money.currency	string	Moneda.
Motivo	refunds.reason	string	La razón de la disputa por la que el titular de la tarjeta inició la disputa con su banco.
Id. de dispositivo	refunds.device_id	string	Identificador único del dispositivo que usó este código. Rellenado cuando el dispositivo está emparejado.
Duración de la fecha límite	refunds.deadline_duration	string	Duración de RFC 3339, después de la cual se cancela automáticamente la finalización de la compra. TerminalCheckout que está pendiente se cancela automáticamente y tiene un motivo de cancelación de TIMED_OUT. Valor predeterminado: 5 minutos a partir de la creación
Estado	refunds.status	string	Estado de comprobación actual de este objeto.
Creado en	refunds.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	refunds.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Identificador de aplicación	refunds.app_id	string	Identificador de la aplicación que creó la desprotección.
Marca de tarjeta	refunds.card.card_brand	string	La marca de la tarjeta.
Últimos 4	refunds.card.last_4	string	Los últimos 4 dígitos del número de tarjeta.
Mes de expiración	refunds.card.exp_month	integer	El mes de expiración de la tarjeta asociada como un entero entre 1 y 12.
Año de expiración	refunds.card.exp_year	integer	El año de cuatro dígitos de la fecha de expiración de la tarjeta.
Huellas	refunds.card.fingerprint	string	Diseñado como identificador asignado a Square, basado en el número de tarjeta, para identificar la tarjeta en varias ubicaciones dentro de una sola aplicación.
Tipo de tarjeta	refunds.card.card_type	string	Tipo de la tarjeta.
BOTE	refunds.card.bin	string	Los seis primeros dígitos del número de tarjeta, conocidos como número de identificación bancaria (BIN).
Id. de pedido	refunds.order_id	string	Identificador del pedido.
Id. de ubicación	refunds.location_id	string	Identificador de la ubicación.

Registro de dominio para Apple Pay

Id. de la operación:: ApplePayRegister

Activa un dominio para su uso con Apple Pay en la Web y Square. Apple realiza una validación en este dominio para asegurarse de que está configurado correctamente como un dominio habilitado para Apple Pay.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de dominio	domain_name	True	string	Un nombre de dominio como se describe en RFC-1034 que se registrará con Apple Pay.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Estado	status	string	Estado del registro de dominio.

Upsert catalog (objeto)

Id. de la operación:: CatalogUpsert

Crea o actualiza el CatalogObject de destino.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
identificación	id	string	Identificador único emitido por Square.
Tipo	type	string	El tipo de este objeto.
Abbreviation	abbreviation	string	Texto de la etiqueta de presentación del elemento en la aplicación Punto de venta cuadrado. Solo se usan hasta los cinco primeros caracteres de la cadena. Este atributo se puede buscar y su longitud de valor es de puntos de código Unicode.
Description	title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Nombre	name	string	Nombre.
identificación	id	string	Identificador para hacer referencia a este objeto en el catálogo.
Tipo	type	string	El tipo de este objeto.
Id. de elemento	item_id	string	Identificador del objeto CatalogItem asociado a esta variación de elemento.
Nombre	name	string	Nombre de la variación del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Tipo de precios	pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Tipo	catalog_object.type	string	El tipo de este objeto.
identificación	catalog_object.id	string	Identificador único emitido por Square.
Actualizado en	catalog_object.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Versión	catalog_object.version	integer	La versión actual de este objeto.
Está eliminado	catalog_object.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Nombre	catalog_object.item_data.name	string	Nombre.
Description	catalog_object.item_data.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Abbreviation	catalog_object.item_data.abbreviation	string	Texto de la etiqueta de presentación del elemento en la aplicación Punto de venta cuadrado. Solo se usan hasta los cinco primeros caracteres de la cadena. Este atributo se puede buscar y su longitud de valor es de puntos de código Unicode.
Variaciones	catalog_object.item_data.variations	array of object
Tipo	catalog_object.item_data.variations.type	string	El tipo de este objeto.
identificación	catalog_object.item_data.variations.id	string	Identificador para hacer referencia a este objeto en el catálogo.
Actualizado en	catalog_object.item_data.variations.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339.
Versión	catalog_object.item_data.variations.version	integer	Versión del objeto . Al actualizar un objeto, la versión proporcionada debe coincidir con la versión de la base de datos; de lo contrario, la escritura se rechazará como en conflicto.
Está eliminado	catalog_object.item_data.variations.is_deleted	boolean	Si es true, el objeto se ha eliminado de la base de datos. Debe ser false para los nuevos objetos que se insertan. Cuando se elimina, el campo updated_at será igual al tiempo de eliminación.
Presente en todas las ubicaciones	catalog_object.item_data.variations.present_at_all_locations	boolean	Si es true, este objeto está presente en todas las ubicaciones (incluidas las futuras), excepto donde se especifica en el campo absent_at_location_ids. Si es false, este objeto no está presente en ninguna ubicación (incluidas las ubicaciones futuras), excepto cuando se especifique en el campo present_at_location_ids. Si no se especifica, el valor predeterminado es true.
Id. de elemento	catalog_object.item_data.variations.item_variation_data.item_id	string	Identificador del objeto CatalogItem asociado a esta variación de elemento.
Nombre	catalog_object.item_data.variations.item_variation_data.name	string	Nombre de la variación del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Ordinal	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Orden en el que se debe mostrar esta variación de elemento. Este valor es de solo lectura. En las escrituras, el ordinal para cada variación de elemento dentro de un CatalogItem primario se establece según la posición de las variaciones de elemento. En las lecturas, no se garantiza que el valor sea secuencial o único.
Tipo de precios	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Indica si el precio de la variación del artículo es fijo o determinado en el momento de la venta.
Stockable	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Si las existencias se cuentan directamente en esta variación (TRUE) o solo en sus componentes (FALSE). Para la compatibilidad con versiones anteriores, los valores que faltan se interpretarán como TRUE.
Importe	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Cantidad.
Moneda	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	Moneda.
Tipo de producto	catalog_object.item_data.product_type	string	Tipo de producto del elemento. Es posible que no se cambie una vez que se haya creado un elemento.
Asignaciones de identificadores	id_mappings	array of object
Id. de objeto de cliente	id_mappings.client_object_id	string	Identificador #-prefijo temporal proporcionado por el cliente para un nuevo CatalogObject.
Id. de objeto	id_mappings.object_id	string	Identificador permanente creado por el servidor.

Definiciones

objeto

Este es el tipo 'object'.

Compartir a través de

Pagos cuadrados (publicador independiente) (versión preliminar)

Limitaciones

Acciones

Aceptar disputa

Parámetros

Devoluciones

Actualización de la factura

Parámetros

Devoluciones

Actualización del pago

Parámetros

Devoluciones

Actualizar cliente

Parámetros

Devoluciones

Actualizar grupo de clientes

Parámetros

Devoluciones

Actualizar impuestos de artículos

Parámetros

Devoluciones

Actualizar listas modificadores de elementos

Parámetros

Devoluciones

Actualizar suscripción

Parámetros

Devoluciones

Agregar grupo al cliente

Parámetros

Devoluciones

Buscar clientes

Parámetros

Devoluciones

Buscar desprotecciones del terminal

Parámetros

Devoluciones

Buscar facturas

Parámetros

Devoluciones

Buscar objetos de catálogo

Parámetros

Devoluciones

Búsqueda de suscripciones

Parámetros

Devoluciones

Calcular el orden (Beta)

Parámetros

Devoluciones

Cancelación de la finalización de la compra del terminal

Parámetros

Devoluciones

Cancelación de la suscripción

Parámetros

Devoluciones

Cancelación del pago por clave de idempotency

Parámetros

Devoluciones

Cancelación del reembolso del terminal

Parámetros

Devoluciones

Cancelar factura

Parámetros

Devoluciones

Cancelar pago

Parámetros

Devoluciones

Catálogo de listas

Parámetros

Devoluciones

Creación de la finalización de la compra del terminal

Parámetros

Devoluciones

Creación de texto de evidencia de controversia

Parámetros

Devoluciones

Creación de un grupo de clientes

Parámetros

Devoluciones

Creación de una suscripción