payout33 ops

API de Payout

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

Consultas

CONSULTA

adminGetPayoutAccount

#

Get a single payout account by ID.

Argumentos

  • id!
Devuelve
CONSULTA

adminListPayoutAccounts

#

List payout accounts with pagination, filtering, and sorting.

Argumentos

  • input!

    Por defecto

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

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

Devuelve[!]!
CONSULTA

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.

Argumentos

  • input!
Devuelve!
CONSULTA

getPayoutMethodOption

#

Get a single payout method option by ID.

Argumentos

  • id!
Devuelve
CONSULTA

listPayoutMethodOptions

#

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

Argumentos

  • input!

    Por defecto

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

myActivePayoutAccounts

#

List only active payout accounts for the current account

Devuelve[!]!
CONSULTA

myDefaultPayoutAccount

#

Get the default payout account for the current account

Devuelve
CONSULTA

myPayoutAccounts

#

List payout accounts for the current account

Devuelve[!]!
CONSULTA

payoutSchedule

#

Get a specific payout schedule

Argumentos

  • id!
Devuelve
CONSULTA

payoutSchedules

#

List payout schedules

Devuelve[!]!
CONSULTA

payoutSession

#

Get payout session details

Argumentos

  • id!
Devuelve!
CONSULTA

payoutSessions

#

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

Argumentos

  • input!

    Por defecto

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Devuelve!
CONSULTA

previewPayoutSession

#

Preview a payout session

Argumentos

  • input!
Devuelve!
CONSULTA

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.

Argumentos

  • input!
Devuelve!

Mutaciones

MUTACIÓN

activatePayoutSchedule

#

Activate a payout schedule

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

adminDeletePayoutAccount

#

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

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

adminUpdatePayoutAccountStatus

#

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

Argumentos

  • input!
Devuelve!
MUTACIÓN

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.

Argumentos

  • input!
Devuelve!
MUTACIÓN

completeStripeConnect

#

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

Argumentos

  • input!
Devuelve!
MUTACIÓN

configurePayoutAccount

#

Configure a new payout account

Argumentos

  • input!
Devuelve!
MUTACIÓN

createPayoutMethodOption

#

Create a new payout method option.

Argumentos

  • input!
Devuelve!
MUTACIÓN

createPayoutSchedule

#

Create a payout schedule

Argumentos

  • input!
Devuelve!
MUTACIÓN

createPayoutSession

#

Create a new payout session

Argumentos

  • input!
Devuelve!
MUTACIÓN

deactivatePayoutSchedule

#

Deactivate a payout schedule

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

deletePayoutAccount

#

Delete a payout account

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

deletePayoutMethodOption

#

Delete a payout method option.

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

initiateStripeConnect

#

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

Argumentos

  • input!
Devuelve!
MUTACIÓN

processPayoutSession

#

Process a payout session

Argumentos

  • sessionId!
Devuelve!
MUTACIÓN

rejectPayoutSession

#

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

Argumentos

  • input!
Devuelve!
MUTACIÓN

updatePayoutAccount

#

Update an existing payout account

Argumentos

  • input!
Devuelve!
MUTACIÓN

updatePayoutMethodOption

#

Update an existing payout method option.

Argumentos

  • input!
Devuelve!
MUTACIÓN

updatePayoutSchedule

#

Update a payout schedule

Argumentos

  • input!
Devuelve!