Run

How card money reaches the business

Card payments for the business's bookings in a period (default this month), who they were paid to, and payouts for jobs NogPets passed to it. Needs business:manage; the signed-in person must be an owner, manager or staff member of an approved NogPets business (bizId only if they run more than one).

get/v1/business/payouts

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/payouts
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.nogpets.com/oauth/authorize, token URL https://api.nogpets.com/oauth/token, scopes: business:manage)
    • HTTP bearer

Query parameters

bizIdstring

Only when the person runs more than one business.

period'today' | 'this_week' | 'last_week' | 'next_7_days' | 'this_month' | 'last_month'

A period in the business's own time zone; weeks run Monday to Sunday.

Instead of from/to.

fromstring

A local date, YYYY-MM-DD.

First day, YYYY-MM-DD, in the business's own time zone.

tostring

A local date, YYYY-MM-DD.

Last day, inclusive.

Response

OK

fromstring
tostring
settlementstring

Changes

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