Skip to main content
GET
/
api
/
v2
/
partner
/
merchants
List merchants
curl --request GET \
  --url https://api.modulate.aurorapayments.net/api/v2/partner/merchants \
  --header 'X-Partner-API-Key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-Partner-API-Key
string
header
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:25

Items per page

Required range: 1 <= x <= 100
status
string | null

Filter by merchant status

search
string | null

Search by DBA name or merchant ID

Maximum string length: 200
updated_since
string<date-time> | null

ISO-8601 timestamp for incremental sync

sort_by
string | null
default:dba_name

Sort field

sort_order
string | null
default:asc

Sort direction

compliance_status
string | null

Filter by PCI compliance status

Response

Successful Response