Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Merchant

List merchants

Returns a paginated list of merchants (normalized payees) linked to the company's transactions. Access requires an admin or one of the transactions_rules_view / transactions_rules_manage permissions. The result is scoped to the merchants referenced by the company's ledger transactions.

Merchants are used to group and label card spend (e.g. resolving "AMZN MKTP US" to "Amazon") and to power transaction rules. All operators in Filters are supported on the columns below.

get/v1/merchants

Query parameters

company_idstring uuid

Company-context fallback used when the company-id header is absent. A non-admin caller must supply company context (header or this query param) to satisfy the permission-based index? gate; admins may omit both.

_startinteger

If all the cards where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the cards where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring
Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

idstring

Filter by merchant id. Use id={"$in":[...]} for batch lookups.

namestring

Normalized merchant name. Combine with $regex for text search.

Headers

company-idstring uuid required

UUID of the company that owns the card.

Response

Paginated list of merchants. Headers include X-Total-Count and Content-Range for offset pagination — see Pagination.

idstring uuid
namestring

Normalized merchant name.

image_urlstring nullable

Logo / image URL for the merchant.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "87128e7e-d774-4e2d-b4b5-5d20c7ebe682",
    "name": "Amazon",
    "image_url": "https://logos.cardda.com/amazon.png"
  }
]