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

Add a payout bank account

Add an additional destination bank account to the organization's existing payout account. Country and currency are resolved from the organization. The full account number is never returned — only `last4`.

POST
/payouts/bank-accounts

Add an additional destination bank account to the organization's existing payout account. Country and currency are resolved from the organization. The full account number is never returned — only last4.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accountNumber*string
accountHolderName*string
routingNumber?string
accountType?string
setDefault*boolean

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payouts/bank-accounts" \  -H "Content-Type: application/json" \  -d '{    "accountNumber": "string",    "accountHolderName": "string",    "setDefault": false  }'
{  "success": true,  "data": {    "id": "string",    "providerExternalAccountId": "string",    "holderName": "string",    "last4": "string",    "bankName": "string",    "country": "string",    "currency": "string",    "accountType": "checking",    "isDefault": true,    "status": "active",    "createdAt": "2019-08-24T14:15:22Z",    "object": "payout_bank_account",    "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"  }}

Update invoice status PUT

Mark an outstanding invoice as "paid" or "void". Cannot change the status of already paid or voided invoices.

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.