Skip to main content
GET
/
api
/
partner
/
merchants
List merchants
curl --request GET \
  --url https://api.modulate.aurorapayments.net/api/partner/merchants
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

Pattern: ^(active|closed|terminated)$
​
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

Pattern: ^(dba_name|merchant_id|status|onboarding_date|state)$
​
sort_order
string | null
default:asc

Sort direction

Pattern: ^(asc|desc)$
​
compliance_status
string | null

Filter by PCI compliance status

Pattern: ^(compliant|non_compliant|not_started)$

Response

Successful Response