> ## Documentation Index > Fetch the complete documentation index at: https://docs.bijection.com/llms.txt > Use this file to discover all available pages before exploring further. # Square > Resources, examples, configuration and evidence for Square. Use the `@bijection/connectors/square` entrypoint to declare Square resources. ## Availability This page describes the pinned source package. Published availability is unestablished for this artifact. [Source build and package availability](https://docs.bijection.com/client/sdk-distribution.md). ## Resources and modes | Resource | Mode | Description | | - | - | - | | Payments | `pull` | Carried updated\_at walk with a version-token-conditioned capture | | Refunds | `pull` | Creation listing, point-read refresh and an idempotency-keyed refund | | Orders | `pull` | One location's orders by updated\_at | | Catalog objects | `pull` | Catalog search with deleted objects as withdrawals | Declare a resource in application code, then bind deployment-specific settings and credentials. See [typed resources](https://docs.bijection.com/integrations/resources.md), [connections](https://docs.bijection.com/integrations/connections.md) and [source inspection](https://docs.bijection.com/integrations/cli.md). ## Payments ### pull: Carried updated\_at walk with a version-token-conditioned capture The following example matches configuration `standard`. ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} import { square } from "@bijection/connectors/square"; export const payments = square.payments.pull({ environment: "production" }); ``` > **Inferred record types** > > ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > Resource without an operational record table > ``` #### Configuration: standard Case: `square/payments/pull/standard`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "payments" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: payments** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "payments": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": true, > "reconciliation": true, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"payments"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"payments"} | Fixture: ./src/connectors/square/fixtures/empty-page-advances.json | passed (2026-10-24T21:36:12.389Z) | | stated-cursor-repeat-refused | \{"kind":"collection","name":"payments"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.389Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. #### Configuration: capture Case: `square/payments/pull/capture`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "payments" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareupsandbox.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: payments** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": { > "complete": { > "target": "payments", > "delivery": "single_attempt", > "condition": "target_version", > "replayWindowMs": null, > "maxDeliveryHours": "1", > "providerEnforcedExpiry": false > } > } > } > ``` **Commands** | Command | Target | Condition | Delivery | | - | - | - | - | | `complete` | payments | Target version precondition | Single dispatch attempt | > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "payments": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": true, > "reconciliation": true, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": { > "complete": { > "target": "payments", > "delivery": "single_attempt", > "condition": "target_version", > "replayWindowMs": null, > "maxDeliveryHours": "1", > "providerEnforcedExpiry": false > } > } > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": { > "complete": { > "target": "payments", > "condition": { > "kind": "target_version", > "from": { > "kind": "record_version" > } > }, > "delivery": { > "kind": "single_attempt", > "retention": { > "kind": "unknown" > }, > "max_delivery_hours": 1 > } > } > } > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"payments"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"payments"} | Fixture: ./src/connectors/square/fixtures/empty-page-advances.json | passed (2026-10-24T21:36:12.389Z) | | stated-cursor-repeat-refused | \{"kind":"collection","name":"payments"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | command-response-lost | \{"kind":"command","name":"complete"} | Native test: integrations/listeners/calendar\_repair\_preserves\_accepted\_responsibility (shared\_engine) | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.389Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. #### Configuration: webhooks Case: `square/payments/pull/webhooks`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "payments" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: payments** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "acquire.3", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "listener changes", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2", > "acquire.3" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "payments": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": true, > "reconciliation": true, > "notifications": true, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "payment": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange payment", > "limitBytes": null > } > }, > { > "id": "acquire.3", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "listener changes", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2", > "acquire.3" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | listener-custody-before-ack | \{"kind":"listener","collection":"payments"} | Native test: integrations/listeners/webhook\_delivery\_commits\_responsibility\_before\_acknowledging (shared\_engine) | Execution result unavailable | | listener-duplicate-delivery | \{"kind":"listener","collection":"payments"} | Native test: integrations/providers/shopify\_product\_hint\_is\_deduplicated\_and\_refused\_when\_unsigned (shared\_engine) | Execution result unavailable | | page-publication-recovery | \{"kind":"collection","name":"payments"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"payments"} | Fixture: ./src/connectors/square/fixtures/empty-page-advances.json | passed (2026-10-24T21:36:12.390Z) | | stated-cursor-repeat-refused | \{"kind":"collection","name":"payments"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. ## Refunds ### pull: Creation listing, point-read refresh and an idempotency-keyed refund The following example matches configuration `standard`. ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} import { square } from "@bijection/connectors/square"; export const refunds = square.refunds.pull({ environment: "production" }); ``` > **Inferred record types** > > ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > Resource without an operational record table > ``` #### Configuration: standard Case: `square/refunds/pull/standard`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "refunds" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: refunds** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "refund": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange refund", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "refunds": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": true, > "reconciliation": true, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "refund": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange refund", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"refunds"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"refunds"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"refunds"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. #### Configuration: refund Case: `square/refunds/pull/refund`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "refunds" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareupsandbox.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: refunds** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "refund": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange refund", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": { > "refund": { > "target": "refunds", > "delivery": "single_attempt", > "condition": "unconditional", > "replayWindowMs": null, > "maxDeliveryHours": "1", > "providerEnforcedExpiry": false > } > } > } > ``` **Commands** | Command | Target | Condition | Delivery | | - | - | - | - | | `refund` | refunds | Unconditional | Single dispatch attempt | > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "refunds": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": true, > "reconciliation": true, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "list": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > }, > "refund": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "404": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange list", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange refund", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": { > "refund": { > "target": "refunds", > "delivery": "single_attempt", > "condition": "unconditional", > "replayWindowMs": null, > "maxDeliveryHours": "1", > "providerEnforcedExpiry": false > } > } > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": { > "refund": { > "target": "refunds", > "condition": { > "kind": "unconditional" > }, > "delivery": { > "kind": "single_attempt", > "retention": { > "kind": "unknown" > }, > "max_delivery_hours": 1 > } > } > } > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"refunds"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"refunds"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"refunds"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | command-response-lost | \{"kind":"command","name":"refund"} | Native test: integrations/listeners/calendar\_repair\_preserves\_accepted\_responsibility (shared\_engine) | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. ## Orders ### pull: One location's orders by updated\_at The following example matches configuration `standard`. ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} import { square } from "@bijection/connectors/square"; export const orders = square.orders.pull({ environment: "production", locationId: "L1", }); ``` > **Inferred record types** > > ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > Resource without an operational record table > ``` #### Configuration: standard Case: `square/orders/pull/standard`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "orders" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: orders** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "orders": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": false, > "reconciliation": false, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"orders"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"orders"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"orders"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. #### Configuration: webhooks Case: `square/orders/pull/webhooks`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "orders" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: orders** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Deletion detection unsupported | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "listener changes", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "orders": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": false, > "reconciliation": false, > "notifications": true, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "acquire.2", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "listener changes", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1", > "acquire.2" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "unsupported", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | listener-custody-before-ack | \{"kind":"listener","collection":"orders"} | Native test: integrations/listeners/webhook\_delivery\_commits\_responsibility\_before\_acknowledging (shared\_engine) | Execution result unavailable | | listener-duplicate-delivery | \{"kind":"listener","collection":"orders"} | Native test: integrations/providers/shopify\_product\_hint\_is\_deduplicated\_and\_refused\_when\_unsigned (shared\_engine) | Execution result unavailable | | page-publication-recovery | \{"kind":"collection","name":"orders"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"orders"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"orders"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. ## Catalog objects ### pull: Catalog search with deleted objects as withdrawals The following example matches configuration `standard`. ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} import { square } from "@bijection/connectors/square"; export const items = square.catalog.pull({ environment: "production" }); ``` > **Inferred record types** > > ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > Resource without an operational record table > ``` #### Configuration: standard Case: `square/catalog/pull/standard`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "objects" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareup.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: objects** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Explicit deletion evidence | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "explicit_events", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "objects": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": false, > "reconciliation": false, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "explicit_events", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"objects"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"objects"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"objects"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.390Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. #### Configuration: items Case: `square/catalog/pull/items`. Connection and resource configuration are declared by this exact case. Credential kind: `square`. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements. > **Complete configuration contract** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "setup": [], > "resource": { > "access": {}, > "defaults": {}, > "connector": "square", > "output": { > "kind": "single", > "collection": "objects" > }, > "credential_kind": "square", > "connection_fields": [], > "address": { > "kind": "fixed", > "url": "https://connect.squareupsandbox.com" > } > }, > "connection_setup": { > "type": "object", > "value": {} > }, > "execution": null > } > ``` Native admission analysis is available for this exact declaration. **Collection: objects** | Contract | Meaning | | - | - | | Initial | Enumeration of observed records | | Changes | Repeated observations of current records | | Deletions | Explicit deletion evidence | | Resume | Opaque cursor | | Gap | Explicit repair required after a gap | | Retention | Unspecified | > **Complete native profile** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "explicit_events", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > ``` > **Commands, occurrences and artifacts** > > ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} > { > "records": { > "objects": { > "protocol": "record_observation", > "coverage": "records", > "consistency": "observations", > "atomicity": "record", > "history": "observations", > "recordRefresh": false, > "reconciliation": false, > "notifications": false, > "snapshotMaxRows": null, > "profile": { > "movement": { > "exchanges": { > "search": { > "200": { > "placement": "retained_bytes", > "interpretation": "json", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > }, > "429": { > "placement": "retained_bytes", > "interpretation": "opaque", > "projectsBeforeRetention": false, > "retainedBodyLimitBytes": "524288", > "fileLimitBytes": null > } > } > }, > "nativeInputLimitBytes": null, > "steps": [ > { > "id": "acquire.1", > "inputs": [], > "action": { > "operation": "acquire", > "subject": "exchange search", > "limitBytes": null > } > }, > { > "id": "retain.1", > "inputs": [ > "acquire.1" > ], > "action": { > "operation": "retain", > "subject": "acquisition evidence", > "reason": "recovery", > "release": "acquisition_custody" > } > }, > { > "id": "interpret.1", > "inputs": [ > "retain.1" > ], > "action": { > "operation": "interpret", > "subject": "acquired input", > "produces": "records" > } > }, > { > "id": "materialize.1", > "inputs": [ > "interpret.1" > ], > "action": { > "operation": "materialize", > "subject": "source rows", > "reason": "serving", > "release": "replacement" > } > }, > { > "id": "publish.1", > "inputs": [ > "materialize.1" > ], > "action": { > "operation": "publish", > "subject": "source rows", > "visibility": "with_acquisition" > } > } > ] > }, > "initial": "enumeration", > "changes": "observations", > "deletions": "explicit_events", > "resume": "opaque_cursor", > "retentionMs": null, > "gap": "explicit_repair", > "limits": { > "http_response_bytes": "524288" > }, > "restrictions": [], > "commands": {} > } > } > }, > "occurrences": null, > "artifacts": { > "raw_archive": false, > "native_file_transfer_limit_bytes": null, > "external_versions": false, > "files": {} > }, > "commands": {} > } > ``` **Recorded checks** | Requirement | Scope | Evidence | Result | | - | - | - | - | | page-publication-recovery | \{"kind":"collection","name":"objects"} | Native test: integrations/acquisition/acquisition\_windows\_preserve\_sequences\_and\_restart\_fences\_old\_work (shared\_engine) | Execution result unavailable | | stated-cursor-empty-page-advances | \{"kind":"collection","name":"objects"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | stated-cursor-repeat-refused | \{"kind":"collection","name":"objects"} | No check exercises this packaged Square declaration against Square; it has not run or been qualified. | Execution result unavailable | | identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/square/fixtures/identity.json | passed (2026-10-24T21:36:12.391Z) | Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status. ## Provider guidance Compiled declaration examples and configuration details are published in the [connector reference](https://docs.bijection.com/integrations/connectors/index). The connection holds a `square` bearer credential (`square.credential`) for `https://connect.squareup.com` or the sandbox. Every request sends `Square-Version: 2026-09-16`. Identity is `GET /v2/merchants/me`'s merchant id. * `payments.pull` reads List Payments sorted `UPDATED_AT` ascending from `updated_at_begin_time`, following Square's cursor (empty on the last page). `begin_time`, which filters creation and defaults to one year back, is sent as 2009-01-01. The first pass reads from that floor; each finished pass carries the latest `updated_at` it read (`sync.carry`) and the next reads from five minutes before it. `version_token` is the opaque version. `status` APPROVED is an authorization, COMPLETED a capture; `card_details.status` (AUTHORIZED, CAPTURED, VOIDED, FAILED) is kept beside it. Settlement is Square's payout, which is not read. Amounts are exact integer minor units with the currency; `currencyScale` (default 2) names the seller currency's exponent, which Square never states. * With `governingRule`, `complete` captures an APPROVED payment, sending the record's `version_token`: a target-version condition, and a stale token is Square's `VERSION_MISMATCH`, read as a lost conditional write. CompletePayment takes no idempotency key, so it is one attempt and a lost answer stays unknown. * `refunds.pull` lists refunds by creation (List Payment Refunds filters nothing else) and refreshes known refunds by point read every six hours, which is how a status change after creation is seen. With `governingRule`, `refund` sends RefundPayment with the operation identity as `idempotency_key` (32 hex characters, within Square's 45). Square states no key retention, so the engine never resends under it: one attempt, a lost answer stays unknown. A 200 is acceptance (`pending`); the read-back of the refund it named settles COMPLETED as confirmed and REJECTED or FAILED as rejected. * `orders.pull` reads one location's Search Orders filtered and sorted on `updated_at` (Square requires the two to match), 500 per page. * `catalog.pull` reads Search Catalog Objects with `include_deleted_objects`, so `is_deleted: true` withdraws an object; `begin_time` is exclusive and passes re-read five minutes. The type-specific data is kept as received JSON text. Nothing is withdrawn except a deleted catalog object; a 404 on a point read settles nothing. With `updates: "webhooks"`, a Square webhook delivery asks for a read: a point read of `data.id` for payments and refunds, the resource's next pass for orders and the catalog. Square signs the subscription's notification URL followed by the raw body (HMAC-SHA256, base64 in `x-square-hmacsha256-signature`, the signature key as text), so register exactly the URL `bijection integration listener-configure` reports and install the subscription's signature key as the listener's signing credential. `event_id` is the delivery identity. There is no signed time: replay is bounded by the delivery ring and a delivery proves a refresh hint. The verifier passes Square's SDK and documentation vectors in the platform's unit tests. Nothing here has run against Square or been qualified. ## Provider references Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded. ## Source and evidence [Canonical connector source](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/src/connectors/square/README.md), [native analysis](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/contract-analysis.json) and [check receipts](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/evidence.json). Connector artifact: `905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305`. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.