The merchant object
A comprehensive list of the merchant resource's attributes and relationships
A merchant object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/merchants endpoint.
Fields
type
string
merchants
id
string
The merchant unique identifier
links.self
string
The merchant endpoint URL
attributes.name
string
The merchant's internal name.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code.
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.address
object
The associated address.
relationships.attachments
array
The associated attachments.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)
Last updated