All URIs are relative to https://connect.squareup.com/
| Method | HTTP request | Description |
|---|---|---|
| CancelTerminalCheckout | Post /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout |
| CancelTerminalRefund | Post /v2/terminals/refunds/{terminal_refund_id}/cancel | CancelTerminalRefund |
| CreateTerminalCheckout | Post /v2/terminals/checkouts | CreateTerminalCheckout |
| CreateTerminalRefund | Post /v2/terminals/refunds | CreateTerminalRefund |
| GetTerminalCheckout | Get /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout |
| GetTerminalRefund | Get /v2/terminals/refunds/{terminal_refund_id} | GetTerminalRefund |
| SearchTerminalCheckouts | Post /v2/terminals/checkouts/search | SearchTerminalCheckouts |
| SearchTerminalRefunds | Post /v2/terminals/refunds/search | SearchTerminalRefunds |
CancelTerminalCheckoutResponse CancelTerminalCheckout(ctx, checkoutId) CancelTerminalCheckout
Cancels a Terminal checkout request if the status of the request permits it.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| checkoutId | string | Unique ID for the desired `TerminalCheckout` |
CancelTerminalCheckoutResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CancelTerminalRefundResponse CancelTerminalRefund(ctx, terminalRefundId) CancelTerminalRefund
Cancels an Interac terminal refund request by refund request ID if the status of the request permits it.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| terminalRefundId | string | Unique ID for the desired `TerminalRefund` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTerminalCheckoutResponse CreateTerminalCheckout(ctx, body) CreateTerminalCheckout
Creates a new Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | CreateTerminalCheckoutRequest | An object containing the fields to POST for the request. |
See the corresponding object definition for field details. |
CreateTerminalCheckoutResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTerminalRefundResponse CreateTerminalRefund(ctx, body) CreateTerminalRefund
Creates a request to refund an Interac payment completed on a Square Terminal.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | CreateTerminalRefundRequest | An object containing the fields to POST for the request. |
See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTerminalCheckoutResponse GetTerminalCheckout(ctx, checkoutId) GetTerminalCheckout
Retrieves a Terminal checkout request by checkout_id.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| checkoutId | string | Unique ID for the desired `TerminalCheckout` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTerminalRefundResponse GetTerminalRefund(ctx, terminalRefundId) GetTerminalRefund
Retrieves an Interac terminal refund object by ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| terminalRefundId | string | Unique ID for the desired `TerminalRefund` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchTerminalCheckoutsResponse SearchTerminalCheckouts(ctx, body) SearchTerminalCheckouts
Retrieves a filtered list of Terminal checkout requests created by the account making the request.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | SearchTerminalCheckoutsRequest | An object containing the fields to POST for the request. |
See the corresponding object definition for field details. |
SearchTerminalCheckoutsResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchTerminalRefundsResponse SearchTerminalRefunds(ctx, body) SearchTerminalRefunds
Retrieves a filtered list of Terminal Interac refund requests created by the seller making the request.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | SearchTerminalRefundsRequest | An object containing the fields to POST for the request. |
See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]