Skip to content

README.md

Latest commit

 

History

History
278 lines (188 loc) · 6.06 KB

README.md

File metadata and controls

278 lines (188 loc) · 6.06 KB

delete

Delete a Reader

Deletes a Reader object.

API Endpoint: DELETE /v1/terminal/readers/{reader}

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.delete(reader="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.delete(reader="string")

list

List all Readers

Returns a list of Reader objects.

API Endpoint: GET /v1/terminal/readers

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.list()

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.list()

get

Retrieve a Reader

Retrieves a Reader object.

API Endpoint: GET /v1/terminal/readers/{reader}

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.get(reader="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.get(reader="string")

create

Create a Reader

Creates a new Reader object.

API Endpoint: POST /v1/terminal/readers

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.create(registration_code="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.create(registration_code="string")

update

Update a Reader

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

API Endpoint: POST /v1/terminal/readers/{reader}

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.update(reader="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.update(reader="string")

cancel_action

Cancel the current reader action

Cancels the current reader action.

API Endpoint: POST /v1/terminal/readers/{reader}/cancel_action

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.cancel_action(reader="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.cancel_action(reader="string")

process_payment_intent

Hand-off a PaymentIntent to a Reader

Initiates a payment flow on a Reader.

API Endpoint: POST /v1/terminal/readers/{reader}/process_payment_intent

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.process_payment_intent(
    payment_intent="string", reader="string"
)

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.process_payment_intent(
    payment_intent="string", reader="string"
)

process_setup_intent

Hand-off a SetupIntent to a Reader

Initiates a setup intent flow on a Reader.

API Endpoint: POST /v1/terminal/readers/{reader}/process_setup_intent

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.process_setup_intent(
    allow_redisplay="always", reader="string", setup_intent="string"
)

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.process_setup_intent(
    allow_redisplay="always", reader="string", setup_intent="string"
)

refund_payment

Refund a Charge or a PaymentIntent in-person

Initiates a refund on a Reader

API Endpoint: POST /v1/terminal/readers/{reader}/refund_payment

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.refund_payment(reader="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.refund_payment(reader="string")

set_reader_display

Set reader display

Sets reader display to show cart details.

API Endpoint: POST /v1/terminal/readers/{reader}/set_reader_display

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.terminal.reader.set_reader_display(reader="string", type_="cart")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.terminal.reader.set_reader_display(reader="string", type_="cart")