SQUARE TERMINAL API

Connect your app to Square Terminal for in-person payments.

Whether you’re building a point-of-sale app or business management system, you can wirelessly connect your app to Square Terminal, the all-in-one card machine built by Square. Now developers on any platform can offer in-person payments with Square.


Paso 1: Empareje su aplicación con Square Terminal.

Llame a la API para dispositivos para generar un código de dispositivo y mostrarle a su usuario. Una vez que su usuario inicia sesión en la Terminal con el código, un evento de webhook (que contiene el device_id) le notificará que el dispositivo está listo para recibir una solicitud para el proceso de pago de su sistema.

body = {
idempotency_key: '{{RANDOM_STRING}}',
 device_code: {
   name: 'Counter 1',
   product_type: 'TERMINAL_API',
   location_id: 'B5E4484SHHNYH',
 }
}

client.devices.create_device_code(body: body)

Paso 2: Envíe una cantidad de pago desde su aplicación a la Terminal.

Llame a Crear un proceso de pago para Terminal con un monto de pago. Cuando lo haga, el dispositivo le solicitará al comprador el pago.

body = {
 idempotency_key: '{{RANDOM_STRING}}',
 checkout: {
   amount_money: {
     amount: 2610,
     currency: 'USD'
   },
   reference_id: 'id123',
   note: 'A brief note',
   device_options: {
     device_id: '{{DEVICE_ID}}'
   }
 }
}

client.terminal.create_terminal_checkout(body: body)

Paso 3: Cierre la venta en su aplicación.

Una vez que se realice el pago de manera correcta, se le notificará a través de webhooks para que pueda cerrar la venta de su lado.

{
  "merchant_id": "7NZR...NPC",
  "type": "terminal.checkout.updated",
  "event_id": "7229a692-def5-4a7e-b4f3-80638aa2f24d",
  "created_at": "2020-04-10T14:43:55.262Z",
  "data": {
    "type": "checkout.event",
    "id": "dhgENdnFOPXqO",
    "object": {
      "checkout": {
        "amount_money": {
          "amount": 2610,
          "currency": "USD"
        },
        "app_id": "sq0idp-734M...nm6g",
        "created_at": "2020-04-10T14:43:55.262Z",
        "deadline_duration": "PT5M",
        "device_options": {
          "device_id": "{{DEVICE_ID}}",
          "skip_receipt_screen": false,
          "tip_settings": {
            "allow_tipping": false
          }
        },
        "id": "dhgENdnFOPXqO",
        "note": "A brief note",
        "payment_ids": [
           "dgzrZT...PouaB"
         ],
         "reference_id": "id123",
         "status": "COMPLETED",
         "updated_at": "2020-04-10T14:44:06.039Z"
      }
    }
  }
}

¿Por qué Square Terminal?

Square Terminal es un dispositivo integral de tarjetas de crédito para pagos y recibos. Es un desarrollo de Square, por lo que seguro y confiable y ofrece una forma mucho más justa de cobrar.

Permita que Square administre los pagos por usted.

Para obtener más información, consulte la Documentación de la API de Terminal.