643 matches
60 actions
Square
60 actions
Finance/Square
Returns Merchant information for a given access token.
If you don't know a Merchant ID, you can use this endpoint to retrieve the merchant ID for an access token.
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 you access.
If you know the merchant ID, you can also use the endpoint to get the merchant information.
{
"type": "object",
"properties": {
"cursor": {
"type": "integer"
}
},
"additionalProperties": false
}{
"type": "object",
"description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2021-08-18/merchants-api/list-merchants) endpoint.",
"properties": {
"cursor": {
"type": "integer",
"description": "If the response is truncated, the cursor to use in next request to fetch next set of objects."
},
"errors": {
"type": "array",
"description": "Information on errors encountered during the request.",
"items": {
"type": "object",
"description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"description": "The high-level category for the error."
},
"code": {
"type": "string",
"description": "The specific code of the error."
},
"detail": {
"type": "string",
"description": "A human-readable description of the error for debugging purposes."
},
"field": {
"type": "string",
"description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
}
}
}
},
"merchant": {
"type": "array",
"description": "The requested `Merchant` entities.",
"items": {
"type": "object",
"description": "Represents a Square seller.",
"required": [
"country"
],
"properties": {
"business_name": {
"type": "string",
"description": "The business name of the merchant."
},
"country": {
"type": "string",
"description": "The country code associated with the merchant account, in ISO 3166 format."
},
"currency": {
"type": "string",
"description": "The currency associated with the merchant account, in ISO 4217 format."
},
"id": {
"type": "string",
"description": "The Square-issued ID of the merchant."
},
"language_code": {
"type": "string",
"description": "The language code associated with the merchant account, in BCP 47 format."
},
"main_location_id": {
"type": "string",
"description": "The ID of the main `Location` for this merchant."
},
"status": {
"type": "string",
"description": "The merchant status, active or inactive."
}
}
}
}
}
}