Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
404 lines (264 loc) · 12.5 KB

TerminalApi.md

File metadata and controls

404 lines (264 loc) · 12.5 KB
Raw

SquareConnect.TerminalApi

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

cancelTerminalCheckout

CancelTerminalCheckoutResponse cancelTerminalCheckout(checkoutId)

CancelTerminalCheckout

Cancels a Terminal checkout request if the status of the request permits it.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var checkoutId = SquareConnect.TerminalApi.constructFromObject({}); // String | Unique ID for the desired `TerminalCheckout`

apiInstance.cancelTerminalCheckout(checkoutId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
checkoutId String Unique ID for the desired `TerminalCheckout`

Return type

CancelTerminalCheckoutResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

cancelTerminalRefund

Note: This endpoint is in beta.

CancelTerminalRefundResponse cancelTerminalRefund(terminalRefundId)

CancelTerminalRefund

Cancels an Interac terminal refund request by refund request ID if the status of the request permits it.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var terminalRefundId = SquareConnect.TerminalApi.constructFromObject({}); // String | Unique ID for the desired `TerminalRefund`

apiInstance.cancelTerminalRefund(terminalRefundId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
terminalRefundId String Unique ID for the desired `TerminalRefund`

Return type

CancelTerminalRefundResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createTerminalCheckout

CreateTerminalCheckoutResponse createTerminalCheckout(body)

CreateTerminalCheckout

Creates a new Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var body = SquareConnect.TerminalApi.constructFromObject({}); // CreateTerminalCheckoutRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.createTerminalCheckout(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
body CreateTerminalCheckoutRequest An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

CreateTerminalCheckoutResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createTerminalRefund

Note: This endpoint is in beta.

CreateTerminalRefundResponse createTerminalRefund(body)

CreateTerminalRefund

Creates a request to refund an Interac payment completed on a Square Terminal.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var body = SquareConnect.TerminalApi.constructFromObject({}); // CreateTerminalRefundRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.createTerminalRefund(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
body CreateTerminalRefundRequest An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

CreateTerminalRefundResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getTerminalCheckout

GetTerminalCheckoutResponse getTerminalCheckout(checkoutId)

GetTerminalCheckout

Retrieves a Terminal checkout request by checkout_id.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var checkoutId = SquareConnect.TerminalApi.constructFromObject({}); // String | Unique ID for the desired `TerminalCheckout`

apiInstance.getTerminalCheckout(checkoutId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
checkoutId String Unique ID for the desired `TerminalCheckout`

Return type

GetTerminalCheckoutResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getTerminalRefund

Note: This endpoint is in beta.

GetTerminalRefundResponse getTerminalRefund(terminalRefundId)

GetTerminalRefund

Retrieves an Interac terminal refund object by ID.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var terminalRefundId = SquareConnect.TerminalApi.constructFromObject({}); // String | Unique ID for the desired `TerminalRefund`

apiInstance.getTerminalRefund(terminalRefundId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
terminalRefundId String Unique ID for the desired `TerminalRefund`

Return type

GetTerminalRefundResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchTerminalCheckouts

SearchTerminalCheckoutsResponse searchTerminalCheckouts(body)

SearchTerminalCheckouts

Retrieves a filtered list of Terminal checkout requests created by the account making the request.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var body = SquareConnect.TerminalApi.constructFromObject({}); // SearchTerminalCheckoutsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.searchTerminalCheckouts(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
body SearchTerminalCheckoutsRequest An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

SearchTerminalCheckoutsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchTerminalRefunds

Note: This endpoint is in beta.

SearchTerminalRefundsResponse searchTerminalRefunds(body)

SearchTerminalRefunds

Retrieves a filtered list of Terminal Interac refund requests created by the seller making the request.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TerminalApi();

var body = SquareConnect.TerminalApi.constructFromObject({}); // SearchTerminalRefundsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.searchTerminalRefunds(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
body SearchTerminalRefundsRequest An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

SearchTerminalRefundsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json