payout33 عملية

Payout API

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

Queries

QUERY

adminGetPayoutAccount

#

Get a single payout account by ID.

الوسائط

  • id!
يُرجع
QUERY

adminListPayoutAccounts

#

List payout accounts with pagination, filtering, and sorting.

الوسائط

  • input!

    افتراضي

    {
  "accountId": null,
  "methodOptionId": null,
  "statuses": [],
  "isDefault": null,
  "isInstantEnabled": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  },
  "sort": []
}
يُرجع!
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

يُرجع[!]!
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.

الوسائط

  • input!
يُرجع!
QUERY

getPayoutMethodOption

#

Get a single payout method option by ID.

الوسائط

  • id!
يُرجع
QUERY

listPayoutMethodOptions

#

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

الوسائط

  • input!

    افتراضي

    {
  "enabled": null,
  "optionKinds": [],
  "isInstantAvailable": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  },
  "sort": []
}
يُرجع!
QUERY

myActivePayoutAccounts

#

List only active payout accounts for the current account

يُرجع[!]!
QUERY

myDefaultPayoutAccount

#

Get the default payout account for the current account

يُرجع
QUERY

myPayoutAccounts

#

List payout accounts for the current account

يُرجع[!]!
QUERY

payoutSchedule

#

Get a specific payout schedule

الوسائط

  • id!
يُرجع
QUERY

payoutSchedules

#

List payout schedules

يُرجع[!]!
QUERY

payoutSession

#

Get payout session details

الوسائط

  • id!
يُرجع!
QUERY

payoutSessions

#

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

الوسائط

  • input!

    افتراضي

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
يُرجع!
QUERY

previewPayoutSession

#

Preview a payout session

الوسائط

  • input!
يُرجع!
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.

الوسائط

  • input!
يُرجع!

Mutations

MUTATION

activatePayoutSchedule

#

Activate a payout schedule

الوسائط

  • id!
يُرجعBoolean!
MUTATION

adminDeletePayoutAccount

#

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

الوسائط

  • id!
يُرجعBoolean!
MUTATION

adminUpdatePayoutAccountStatus

#

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

الوسائط

  • input!
يُرجع!
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.

الوسائط

  • input!
يُرجع!
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

الوسائط

  • input!
يُرجع!
MUTATION

configurePayoutAccount

#

Configure a new payout account

الوسائط

  • input!
يُرجع!
MUTATION

createPayoutMethodOption

#

Create a new payout method option.

الوسائط

  • input!
يُرجع!
MUTATION

createPayoutSchedule

#

Create a payout schedule

الوسائط

  • input!
يُرجع!
MUTATION

createPayoutSession

#

Create a new payout session

الوسائط

  • input!
يُرجع!
MUTATION

deactivatePayoutSchedule

#

Deactivate a payout schedule

الوسائط

  • id!
يُرجعBoolean!
MUTATION

deletePayoutAccount

#

Delete a payout account

الوسائط

  • id!
يُرجعBoolean!
MUTATION

deletePayoutMethodOption

#

Delete a payout method option.

الوسائط

  • id!
يُرجعBoolean!
MUTATION

initiateStripeConnect

#

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

الوسائط

  • input!
يُرجع!
MUTATION

processPayoutSession

#

Process a payout session

الوسائط

  • sessionId!
يُرجع!
MUTATION

rejectPayoutSession

#

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

الوسائط

  • input!
يُرجع!
MUTATION

updatePayoutAccount

#

Update an existing payout account

الوسائط

  • input!
يُرجع!
MUTATION

updatePayoutMethodOption

#

Update an existing payout method option.

الوسائط

  • input!
يُرجع!
MUTATION

updatePayoutSchedule

#

Update a payout schedule

الوسائط

  • input!
يُرجع!