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.

POST
/payouts

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.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer
description?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payouts" \  -H "Content-Type: application/json" \  -d '{    "amount": 1000  }'
{  "success": true,  "data": {    "id": "string",    "status": "pending",    "amount": -9007199254740991,    "fee": -9007199254740991,    "netAmount": -9007199254740991,    "currency": "string",    "description": "string",    "providerTransferId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "object": "payout",    "livemode": true  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

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.