Skip to content

Latest commit

 

History

History
602 lines (415 loc) · 16.7 KB

terminal.md

File metadata and controls

602 lines (415 loc) · 16.7 KB
Raw

Terminal

terminal_api = client.terminal

Class Name

TerminalApi

Methods

Create Terminal Action

Creates a Terminal action request and sends it to the specified device.

def create_terminal_action(self,
                          body)

Parameters

Parameter Type Tags Description
body Create Terminal Action Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Create Terminal Action Response.

Example Usage

body = {
    'idempotency_key': 'thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e',
    'action': {
        'device_id': '{{DEVICE_ID}}',
        'deadline_duration': 'PT5M',
        'type': 'SAVE_CARD',
        'save_card_options': {
            'customer_id': '{{CUSTOMER_ID}}',
            'reference_id': 'user-id-1'
        }
    }
}

result = terminal_api.create_terminal_action(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Search Terminal Actions

Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days.

def search_terminal_actions(self,
                           body)

Parameters

Parameter Type Tags Description
body Search Terminal Actions Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Search Terminal Actions Response.

Example Usage

body = {
    'query': {
        'filter': {
            'created_at': {
                'start_at': '2022-04-01T00:00:00.000Z'
            }
        },
        'sort': {
            'sort_order': 'DESC'
        }
    },
    'limit': 2
}

result = terminal_api.search_terminal_actions(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Get Terminal Action

Retrieves a Terminal action request by action_id. Terminal action requests are available for 30 days.

def get_terminal_action(self,
                       action_id)

Parameters

Parameter Type Tags Description
action_id str Template, Required Unique ID for the desired TerminalAction.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Get Terminal Action Response.

Example Usage

action_id = 'action_id6'

result = terminal_api.get_terminal_action(action_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Cancel Terminal Action

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

def cancel_terminal_action(self,
                          action_id)

Parameters

Parameter Type Tags Description
action_id str Template, Required Unique ID for the desired TerminalAction.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Cancel Terminal Action Response.

Example Usage

action_id = 'action_id6'

result = terminal_api.cancel_terminal_action(action_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Dismiss Terminal Action

Dismisses a Terminal action request if the status and type of the request permits it.

See Link and Dismiss Actions for more details.

def dismiss_terminal_action(self,
                           action_id)

Parameters

Parameter Type Tags Description
action_id str Template, Required Unique ID for the TerminalAction associated with the action to be dismissed.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Dismiss Terminal Action Response.

Example Usage

action_id = 'action_id6'

result = terminal_api.dismiss_terminal_action(action_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Create Terminal Checkout

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

def create_terminal_checkout(self,
                            body)

Parameters

Parameter Type Tags Description
body Create Terminal Checkout Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Create Terminal Checkout Response.

Example Usage

body = {
    'idempotency_key': '28a0c3bc-7839-11ea-bc55-0242ac130003',
    'checkout': {
        'amount_money': {
            'amount': 2610,
            'currency': 'USD'
        },
        'device_options': {
            'device_id': 'dbb5d83a-7838-11ea-bc55-0242ac130003'
        },
        'reference_id': 'id11572',
        'note': 'A brief note'
    }
}

result = terminal_api.create_terminal_checkout(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Search Terminal Checkouts

Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

def search_terminal_checkouts(self,
                             body)

Parameters

Parameter Type Tags Description
body Search Terminal Checkouts Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Search Terminal Checkouts Response.

Example Usage

body = {
    'query': {
        'filter': {
            'status': 'COMPLETED'
        }
    },
    'limit': 2
}

result = terminal_api.search_terminal_checkouts(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Get Terminal Checkout

Retrieves a Terminal checkout request by checkout_id. Terminal checkout requests are available for 30 days.

def get_terminal_checkout(self,
                         checkout_id)

Parameters

Parameter Type Tags Description
checkout_id str Template, Required The unique ID for the desired TerminalCheckout.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Get Terminal Checkout Response.

Example Usage

checkout_id = 'checkout_id8'

result = terminal_api.get_terminal_checkout(checkout_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Cancel Terminal Checkout

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

def cancel_terminal_checkout(self,
                            checkout_id)

Parameters

Parameter Type Tags Description
checkout_id str Template, Required The unique ID for the desired TerminalCheckout.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Cancel Terminal Checkout Response.

Example Usage

checkout_id = 'checkout_id8'

result = terminal_api.cancel_terminal_checkout(checkout_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Dismiss Terminal Checkout

Dismisses a Terminal checkout request if the status and type of the request permits it.

def dismiss_terminal_checkout(self,
                             checkout_id)

Parameters

Parameter Type Tags Description
checkout_id str Template, Required Unique ID for the TerminalCheckout associated with the checkout to be dismissed.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Dismiss Terminal Checkout Response.

Example Usage

checkout_id = 'checkout_id8'

result = terminal_api.dismiss_terminal_checkout(checkout_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Create Terminal Refund

Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see Refunds API.

def create_terminal_refund(self,
                          body)

Parameters

Parameter Type Tags Description
body Create Terminal Refund Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Create Terminal Refund Response.

Example Usage

body = {
    'idempotency_key': '402a640b-b26f-401f-b406-46f839590c04',
    'refund': {
        'payment_id': '5O5OvgkcNUhl7JBuINflcjKqUzXZY',
        'amount_money': {
            'amount': 111,
            'currency': 'CAD'
        },
        'reason': 'Returning items',
        'device_id': 'f72dfb8e-4d65-4e56-aade-ec3fb8d33291'
    }
}

result = terminal_api.create_terminal_refund(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Search Terminal Refunds

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.

def search_terminal_refunds(self,
                           body)

Parameters

Parameter Type Tags Description
body Search Terminal Refunds Request Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Search Terminal Refunds Response.

Example Usage

body = {
    'query': {
        'filter': {
            'status': 'COMPLETED'
        }
    },
    'limit': 1
}

result = terminal_api.search_terminal_refunds(body)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Get Terminal Refund

Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.

def get_terminal_refund(self,
                       terminal_refund_id)

Parameters

Parameter Type Tags Description
terminal_refund_id str Template, Required The unique ID for the desired TerminalRefund.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Get Terminal Refund Response.

Example Usage

terminal_refund_id = 'terminal_refund_id0'

result = terminal_api.get_terminal_refund(terminal_refund_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Cancel Terminal Refund

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

def cancel_terminal_refund(self,
                          terminal_refund_id)

Parameters

Parameter Type Tags Description
terminal_refund_id str Template, Required The unique ID for the desired TerminalRefund.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Cancel Terminal Refund Response.

Example Usage

terminal_refund_id = 'terminal_refund_id0'

result = terminal_api.cancel_terminal_refund(terminal_refund_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Dismiss Terminal Refund

Dismisses a Terminal refund request if the status and type of the request permits it.

def dismiss_terminal_refund(self,
                           terminal_refund_id)

Parameters

Parameter Type Tags Description
terminal_refund_id str Template, Required Unique ID for the TerminalRefund associated with the refund to be dismissed.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Dismiss Terminal Refund Response.

Example Usage

terminal_refund_id = 'terminal_refund_id0'

result = terminal_api.dismiss_terminal_refund(terminal_refund_id)
print(result)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)