Skip to main content
GET
/
api
/
v2
/
partner
/
residuals
/
reports
/
{year}
/
{month}
/
merchants
Get merchant residuals
curl --request GET \
  --url https://api.modulate.aurorapayments.net/api/v2/partner/residuals/reports/{year}/{month}/merchants \
  --header 'X-Partner-API-Key: <api-key>'

Authorizations

​
X-Partner-API-Key
string
header
required

Path Parameters

​
year
integer
required

Report year

Required range: 2000 <= x <= 2100
​
month
integer
required

Report month

Required range: 1 <= x <= 12

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
​
sort_by
string
default:agent_payout

Sort field: volume, profit, agent_payout, dba_name

​
sort_order
string
default:desc

Sort direction

​
search
string

Search by merchant name or ID

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

ISO-8601 timestamp for incremental sync

Response

Successful Response