payout33 ops

Payout API

Outbound payments to drivers, vendors, and providers — sessions, schedules, and Connect accounts.

Queries

QUERY

adminGetPayoutAccount

#

Get a single payout account by ID.

Arguments

  • id!
Returns
QUERY

adminListPayoutAccounts

#

List payout accounts with pagination, filtering, and sorting.

Arguments

  • input!

    Default

    {
  "accountId": null,
  "methodOptionId": null,
  "statuses": [],
  "isDefault": null,
  "isInstantEnabled": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  },
  "sort": []
}
Returns!
QUERY

availablePayoutMethods

#

List all available payout methods for the current tenant Returns enabled method options with display information including icons Clients can use the returned ID in the configurePayoutAccount mutation

Returns[!]!
QUERY

exportPayoutSession

#

Export payout session data in the specified format Generates the export file, stores it, and returns a presigned download URL. Only available to PlatformAdmin, TenantAdmin, and PartnerAdmin roles.

Arguments

  • input!
Returns!
QUERY

getPayoutMethodOption

#

Get a single payout method option by ID.

Arguments

  • id!
Returns
QUERY

listPayoutMethodOptions

#

List payout method options with pagination, filtering, and sorting.

Arguments

  • input!

    Default

    {
  "enabled": null,
  "optionKinds": [],
  "isInstantAvailable": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  },
  "sort": []
}
Returns!
QUERY

myActivePayoutAccounts

#

List only active payout accounts for the current account

Returns[!]!
QUERY

myDefaultPayoutAccount

#

Get the default payout account for the current account

Returns
QUERY

myPayoutAccounts

#

List payout accounts for the current account

Returns[!]!
QUERY

payoutSchedule

#

Get a specific payout schedule

Arguments

  • id!
Returns
QUERY

payoutSchedules

#

List payout schedules

Returns[!]!
QUERY

payoutSession

#

Get payout session details

Arguments

  • id!
Returns!
QUERY

payoutSessions

#

List payout sessions with filtering and pagination Only available to PlatformAdmin, TenantAdmin, and PartnerAdmin roles.

Arguments

  • input!

    Default

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

previewPayoutSession

#

Preview a payout session

Arguments

  • input!
Returns!
QUERY

sessionPayouts

#

Get payouts for a specific payout session with optional status filtering. This query returns paginated payout transactions that belong to the specified payout session. You can optionally filter by payout status to see only pending, processing, settled, or failed payouts.

Arguments

  • input!
Returns!

Mutations

MUTATION

activatePayoutSchedule

#

Activate a payout schedule

Arguments

  • id!
ReturnsBoolean!
MUTATION

adminDeletePayoutAccount

#

Delete a payout account (admin hard delete). Returns true if deleted, false if not found.

Arguments

  • id!
ReturnsBoolean!
MUTATION

adminUpdatePayoutAccountStatus

#

Update a payout account's status (admin operation).

Arguments

  • input!
Returns!
MUTATION

completePayoutSession

#

Manually complete a payout session. This allows admins to mark a Processing session as Completed or PartiallyFailed when automatic processing needs manual intervention. The session must be in Processing status for this mutation to succeed.

Arguments

  • input!
Returns!
MUTATION

completeStripeConnect

#

Completes the Stripe Connect OAuth flow after user authorization This is called after the user has authorized the connection on Stripe's side

Arguments

  • input!
Returns!
MUTATION

configurePayoutAccount

#

Configure a new payout account

Arguments

  • input!
Returns!
MUTATION

createPayoutMethodOption

#

Create a new payout method option.

Arguments

  • input!
Returns!
MUTATION

createPayoutSchedule

#

Create a payout schedule

Arguments

  • input!
Returns!
MUTATION

createPayoutSession

#

Create a new payout session

Arguments

  • input!
Returns!
MUTATION

deactivatePayoutSchedule

#

Deactivate a payout schedule

Arguments

  • id!
ReturnsBoolean!
MUTATION

deletePayoutAccount

#

Delete a payout account

Arguments

  • id!
ReturnsBoolean!
MUTATION

deletePayoutMethodOption

#

Delete a payout method option.

Arguments

  • id!
ReturnsBoolean!
MUTATION

initiateStripeConnect

#

Initiates the Stripe Connect OAuth flow Returns an OAuth URL to redirect the user to and an intent ID for tracking

Arguments

  • input!
Returns!
MUTATION

processPayoutSession

#

Process a payout session

Arguments

  • sessionId!
Returns!
MUTATION

rejectPayoutSession

#

Reject a payout session with a reason Only available to PlatformAdmin, TenantAdmin, and PartnerAdmin roles. Can only reject sessions in Draft status.

Arguments

  • input!
Returns!
MUTATION

updatePayoutAccount

#

Update an existing payout account

Arguments

  • input!
Returns!
MUTATION

updatePayoutMethodOption

#

Update an existing payout method option.

Arguments

  • input!
Returns!
MUTATION

updatePayoutSchedule

#

Update a payout schedule

Arguments

  • input!
Returns!

Build the foundation once. Expand without limits.

BetterSuite is built for teams who see on-demand as a business — not a feature.

Start Free TrialView Pricing