atlas

List payouts with search filters

List payouts with search filters

get/atlas/v1/payouts

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/payouts
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

plannedPayoutDate_gtestring

filter on payouts whose plannedPayoutDate is greater than or equal to this value

plannedPayoutDate_ltestring

filter on payouts whose plannedPayoutDate is less than or equal to this value

offsetinteger

offset

limitinteger

limit

querystring

filter on payouts whose merchantId or merchantRegisteredEntityName has a prefix that matches this value

status_instring[]

filter on payouts whose status matches any value in this array

frequency_instring[]

filter on payouts whose frequency matches any value in this array

Response

success

totalCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.