Skip to main content
GET
/
api
/
v2
/
partner
/
residuals
/
reports
/
{year}
/
{month}
/
withholds
Get withholds
curl --request GET \
  --url https://api.modulate.aurorapayments.net/api/v2/partner/residuals/reports/{year}/{month}/withholds \
  --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

Path Parameters

year
integer
required

Report year

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

Report month

Required range: 1 <= x <= 12

Response

Successful Response