Commet
  • Precios
Iniciar SesiónRegistrarse
Add a payout bank account POSTComplete payout verification POSTRequest a payout POST
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

Request a payout

Withdraw available balance to the organization's verified payout account. `amount` is in cents (USD, minimum 1000 = $10). The payout is created in `pending` and settles to `paid` asynchronously as provider webhooks arrive.

Complete payout verification POST

Provision the organization's payout account in a single call with the full KYC + bank payload. Uploads the identity document, persists the destination bank, and creates the connected account through the org's payout provider. The account starts `pending_verification` and flips to `verified` via the provider's webhook. Idempotent: returns the existing account if the org already has one.

Add plan to group POST

Add an existing plan to a plan group with optional sort order.

POST
/payouts

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer
Range1000 <= value
description?string
length <= 500
Length

Response Body

application/json

curl -X POST "https://commet.co/api/v1/payouts" \  -H "Content-Type: application/json" \  -d '{    "amount": 1000  }'

application/json

application/json

application/json

application/json

Payout amount in cents (USD). Minimum 1000 ($10).

Withdraw available balance to the organization's verified payout account. amount is in cents (USD, minimum 1000 = $10). The payout is created in pending and settles to paid asynchronously as provider webhooks arrive.

{
  "success": true,
  "data": {
    "object": "payout",
    "livemode": true,
    "id": "string",
    "status": "pending",
    "amount": 0,
    "fee": 0,
    "netAmount": 0,
    "currency"





{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
:
"string"
,
"description": "string",
"providerTransferId": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
}