Skip to content

Square

Square

The future of business is yours to shape.

Supports in this guide: Payments

Provider website: squareup.com

What you need to do for start processing transactions (brief summary)

  1. Get your credentials (from Square)
  2. Connect in Dashboard
  3. Send an API request

Prerequisites: get from Square

Sign up at squareup.com and verify your account before you can process live card payments. Find the credentials below at your Square Developer Dashboard.

  • Access token -> Corefy field access_token.
  • Location ID -> Corefy field location_id.

EUR, USD, GBP.

Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

Open Square in the provider directory and press Connect at Square Provider Overview page in the New connection section.

Step 2 - Fill in fields and select settings

  • Access token
  • Location ID
  • Currency / Features -> choose values available for your account (EUR, USD, GBP)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Square Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and redirects the customer to Square's own hosted Checkout page.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6be05631-8710-4b14-a369-1928a2b70eda",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10
    }
  }
}

Important

customer fields are not used at all by this connector - the checkout line item is built only from amount, currency, and an auto-generated description (description, or Payment_<reference_id> if not set).

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "199be985-c243-478a-86a8-4b8c902e5bb6",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "description": "Order #1024"
    }
  }
}

Extended request (MAX)

Why add extra fields (typical reasons): - Positively influence conversion rate - Include optional fields required by your specific flow

Refunds

Square does not support refunds through Corefy.

Additional info

  1. Active reconciliation only - Corefy finalizes the payment by polling Square's Orders API (GET /v2/orders/{id}); no asynchronous callback/webhook from Square is processed by this connector. A Square-side webhook subscription is not required for Corefy to receive the final status.
  2. No recurring - this connector does not support saving/charging a token through Corefy.
  3. No Options or Constants are configured for this connector.
  4. Square's legacy Checkout API is used (/v2/locations/{location_id}/checkouts) - no 3-D Secure configuration is exposed, since authentication is handled entirely on Square's own hosted page.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the Access token and that the Location ID belongs to the same Square application
  • Currency or service is not supported -> confirm allowed currencies/features in your Square account and in Corefy - only EUR, USD, and GBP are available
  • Payment stuck pending -> Corefy relies on active reconciliation against Square's Orders API; confirm the order exists and its state is not still OPEN
  • Refund fails -> Square does not support refunds through Corefy

Question

Still looking for help connecting your Square account? Please contact our support team!