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.

Argumente

  • id!
Gibt zurück
QUERY

adminListPayoutAccounts

#

List payout accounts with pagination, filtering, and sorting.

Argumente

  • input!

    Standard

    {
  "accountId": null,
  "methodOptionId": null,
  "statuses": [],
  "isDefault": null,
  "isInstantEnabled": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  },
  "sort": []
}
Gibt zurück!
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

Gibt zurück[!]!
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.

Argumente

  • input!
Gibt zurück!
QUERY

getPayoutMethodOption

#

Get a single payout method option by ID.

Argumente

  • id!
Gibt zurück
QUERY

listPayoutMethodOptions

#

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

Argumente

  • input!

    Standard

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

myActivePayoutAccounts

#

List only active payout accounts for the current account

Gibt zurück[!]!
QUERY

myDefaultPayoutAccount

#

Get the default payout account for the current account

Gibt zurück
QUERY

myPayoutAccounts

#

List payout accounts for the current account

Gibt zurück[!]!
QUERY

payoutSchedule

#

Get a specific payout schedule

Argumente

  • id!
Gibt zurück
QUERY

payoutSchedules

#

List payout schedules

Gibt zurück[!]!
QUERY

payoutSession

#

Get payout session details

Argumente

  • id!
Gibt zurück!
QUERY

payoutSessions

#

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

Argumente

  • input!

    Standard

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Gibt zurück!
QUERY

previewPayoutSession

#

Preview a payout session

Argumente

  • input!
Gibt zurück!
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.

Argumente

  • input!
Gibt zurück!

Mutations

MUTATION

activatePayoutSchedule

#

Activate a payout schedule

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

adminDeletePayoutAccount

#

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

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

adminUpdatePayoutAccountStatus

#

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

Argumente

  • input!
Gibt zurück!
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.

Argumente

  • input!
Gibt zurück!
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

Argumente

  • input!
Gibt zurück!
MUTATION

configurePayoutAccount

#

Configure a new payout account

Argumente

  • input!
Gibt zurück!
MUTATION

createPayoutMethodOption

#

Create a new payout method option.

Argumente

  • input!
Gibt zurück!
MUTATION

createPayoutSchedule

#

Create a payout schedule

Argumente

  • input!
Gibt zurück!
MUTATION

createPayoutSession

#

Create a new payout session

Argumente

  • input!
Gibt zurück!
MUTATION

deactivatePayoutSchedule

#

Deactivate a payout schedule

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

deletePayoutAccount

#

Delete a payout account

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

deletePayoutMethodOption

#

Delete a payout method option.

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

initiateStripeConnect

#

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

Argumente

  • input!
Gibt zurück!
MUTATION

processPayoutSession

#

Process a payout session

Argumente

  • sessionId!
Gibt zurück!
MUTATION

rejectPayoutSession

#

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

Argumente

  • input!
Gibt zurück!
MUTATION

updatePayoutAccount

#

Update an existing payout account

Argumente

  • input!
Gibt zurück!
MUTATION

updatePayoutMethodOption

#

Update an existing payout method option.

Argumente

  • input!
Gibt zurück!
MUTATION

updatePayoutSchedule

#

Update a payout schedule

Argumente

  • input!
Gibt zurück!