Skip to content

Latest commit

 

History

History
324 lines (226 loc) · 9.9 KB

checkout.md

File metadata and controls

324 lines (226 loc) · 9.9 KB

Checkout

checkout_api = client.checkout

Class Name

CheckoutApi

Methods

Create Checkout

Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

NOTE: The Checkout API has been updated with new features. For more information, see Checkout API highlights. We recommend that you use the new CreatePaymentLink  endpoint in place of this previously released endpoint.

def create_checkout(location_id:,
                    body:)

Parameters

Parameter Type Tags Description
location_id String Template, Required The ID of the business location to associate the checkout with.
body Create Checkout Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Create Checkout Response Hash

Example Usage

location_id = 'location_id4'
body = {}
body[:idempotency_key] = '86ae1696-b1e3-4328-af6d-f1e04d947ad6'
body[:order] = {}
body[:order][:order] = {}
body[:order][:order][:location_id] = 'location_id'
body[:order][:order][:reference_id] = 'reference_id'
body[:order][:order][:customer_id] = 'customer_id'
body[:order][:order][:line_items] = []


body[:order][:order][:line_items][0] = {}
body[:order][:order][:line_items][0][:name] = 'Printed T Shirt'
body[:order][:order][:line_items][0][:quantity] = '2'
body[:order][:order][:line_items][0][:applied_taxes] = []


body[:order][:order][:line_items][0][:applied_taxes][0] = {}
body[:order][:order][:line_items][0][:applied_taxes][0][:tax_uid] = '38ze1696-z1e3-5628-af6d-f1e04d947fg3'

body[:order][:order][:line_items][0][:applied_discounts] = []


body[:order][:order][:line_items][0][:applied_discounts][0] = {}
body[:order][:order][:line_items][0][:applied_discounts][0][:discount_uid] = '56ae1696-z1e3-9328-af6d-f1e04d947gd4'

body[:order][:order][:line_items][0][:base_price_money] = {}
body[:order][:order][:line_items][0][:base_price_money][:amount] = 1500
body[:order][:order][:line_items][0][:base_price_money][:currency] = 'USD'

body[:order][:order][:line_items][1] = {}
body[:order][:order][:line_items][1][:name] = 'Slim Jeans'
body[:order][:order][:line_items][1][:quantity] = '1'
body[:order][:order][:line_items][1][:base_price_money] = {}
body[:order][:order][:line_items][1][:base_price_money][:amount] = 2500
body[:order][:order][:line_items][1][:base_price_money][:currency] = 'USD'

body[:order][:order][:line_items][2] = {}
body[:order][:order][:line_items][2][:name] = 'Woven Sweater'
body[:order][:order][:line_items][2][:quantity] = '3'
body[:order][:order][:line_items][2][:base_price_money] = {}
body[:order][:order][:line_items][2][:base_price_money][:amount] = 3500
body[:order][:order][:line_items][2][:base_price_money][:currency] = 'USD'

body[:order][:order][:taxes] = []


body[:order][:order][:taxes][0] = {}
body[:order][:order][:taxes][0][:uid] = '38ze1696-z1e3-5628-af6d-f1e04d947fg3'
body[:order][:order][:taxes][0][:type] = 'INCLUSIVE'
body[:order][:order][:taxes][0][:percentage] = '7.75'
body[:order][:order][:taxes][0][:scope] = 'LINE_ITEM'

body[:order][:order][:discounts] = []


body[:order][:order][:discounts][0] = {}
body[:order][:order][:discounts][0][:uid] = '56ae1696-z1e3-9328-af6d-f1e04d947gd4'
body[:order][:order][:discounts][0][:type] = 'FIXED_AMOUNT'
body[:order][:order][:discounts][0][:amount_money] = {}
body[:order][:order][:discounts][0][:amount_money][:amount] = 100
body[:order][:order][:discounts][0][:amount_money][:currency] = 'USD'
body[:order][:order][:discounts][0][:scope] = 'LINE_ITEM'

body[:order][:idempotency_key] = '12ae1696-z1e3-4328-af6d-f1e04d947gd4'
body[:ask_for_shipping_address] = true
body[:merchant_support_email] = '[email protected]'
body[:pre_populate_buyer_email] = '[email protected]'
body[:pre_populate_shipping_address] = {}
body[:pre_populate_shipping_address][:address_line_1] = '1455 Market St.'
body[:pre_populate_shipping_address][:address_line_2] = 'Suite 600'
body[:pre_populate_shipping_address][:locality] = 'San Francisco'
body[:pre_populate_shipping_address][:administrative_district_level_1] = 'CA'
body[:pre_populate_shipping_address][:postal_code] = '94103'
body[:pre_populate_shipping_address][:country] = 'US'
body[:redirect_url] = 'https://merchant.website.com/order-confirm'
body[:additional_recipients] = []


body[:additional_recipients][0] = {}
body[:additional_recipients][0][:location_id] = '057P5VYJ4A5X1'
body[:additional_recipients][0][:description] = 'Application fees'


result = checkout_api.create_checkout(location_id: location_id, body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

List Payment Links

Lists all payment links.

def list_payment_links(cursor: nil,
                       limit: nil)

Parameters

Parameter Type Tags Description
cursor String Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
If a cursor is not provided, the endpoint returns the first page of the results.
For more information, see Pagination.
limit Integer Query, Optional A limit on the number of results to return per page. The limit is advisory and
the implementation might return more or less results. If the supplied limit is negative, zero, or
greater than the maximum limit of 1000, it is ignored.

Default value: 100

Response Type

List Payment Links Response Hash

Example Usage

result = checkout_api.list_payment_links()

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Create Payment Link

Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.

def create_payment_link(body:)

Parameters

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

See the corresponding object definition for field details.

Response Type

Create Payment Link Response Hash

Example Usage

body = {}
body[:idempotency_key] = 'cd9e25dc-d9f2-4430-aedb-61605070e95f'
body[:quick_pay] = {}
body[:quick_pay][:name] = 'Auto Detailing'
body[:quick_pay][:price_money] = {}
body[:quick_pay][:price_money][:amount] = 10000
body[:quick_pay][:price_money][:currency] = 'USD'
body[:quick_pay][:location_id] = 'A9Y43N9ABXZBP'

result = checkout_api.create_payment_link(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Delete Payment Link

Deletes a payment link.

def delete_payment_link(id:)

Parameters

Parameter Type Tags Description
id String Template, Required The ID of the payment link to delete.

Response Type

Delete Payment Link Response Hash

Example Usage

id = 'id0'

result = checkout_api.delete_payment_link(id: id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Payment Link

Retrieves a payment link.

def retrieve_payment_link(id:)

Parameters

Parameter Type Tags Description
id String Template, Required The ID of link to retrieve.

Response Type

Retrieve Payment Link Response Hash

Example Usage

id = 'id0'

result = checkout_api.retrieve_payment_link(id: id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Payment Link

Updates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data. You cannot update other fields such as the order_id, version, URL, or timestamp field.

def update_payment_link(id:,
                        body:)

Parameters

Parameter Type Tags Description
id String Template, Required The ID of the payment link to update.
body Update Payment Link Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Update Payment Link Response Hash

Example Usage

id = 'id0'
body = {}
body[:payment_link] = {}
body[:payment_link][:version] = 1
body[:payment_link][:checkout_options] = {}
body[:payment_link][:checkout_options][:ask_for_shipping_address] = true

result = checkout_api.update_payment_link(id: id, body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end