Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 2.27 KB

merchants.md

File metadata and controls

89 lines (57 loc) · 2.27 KB

Merchants

merchants_api = client.merchants

Class Name

MerchantsApi

Methods

List Merchants

Provides details about the merchant associated with a given access token.

The access token used to connect your application to a Square seller is associated with a single merchant. That means that ListMerchants returns a list with a single Merchant object. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted your application access.

If you know the merchant ID, you can also use the RetrieveMerchant endpoint to retrieve the merchant information.

def list_merchants(cursor: nil)

Parameters

Parameter Type Tags Description
cursor Integer Query, Optional The cursor generated by the previous response.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type List Merchants Response Hash.

Example Usage

result = merchants_api.list_merchants

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

Retrieve Merchant

Retrieves the Merchant object for the given merchant_id.

def retrieve_merchant(merchant_id:)

Parameters

Parameter Type Tags Description
merchant_id String Template, Required The ID of the merchant to retrieve. If the string "me" is supplied as the ID,
then retrieve the merchant that is currently accessible to this call.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Merchant Response Hash.

Example Usage

merchant_id = 'merchant_id0'


result = merchants_api.retrieve_merchant(merchant_id: merchant_id)

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