payout16 ops

Payout API

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

Queries

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

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

myPayoutAccounts

#

List payout accounts for the current account

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

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

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

updatePayoutAccount

#

Update an existing payout account

Arguments

  • input!
Returns!
MUTATION

updatePayoutMethodOption

#

Update an existing payout method option.

Arguments

  • input!
Returns!