Create a payout account

Módulo Gateway

POST/payout-accountspayoutAccounts.create

Payout details held by the payment provider. XOS stores provider references only. Creates a payout account. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad me.work_details.write.
Alcances de OAuth: me.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PayoutAccountCreate

payoutAccounts.create: PayoutAccountCreate
Campo	Tipo	Obligatorio	Descripción
person_id	string (uuid) \| null	No	Identifier of the payee person.
organization_id	string (uuid) \| null	No	Identifier of the payee organization.
provider	"Stripe Connect" \| "Accounting System"	Sí	Payment provider.
provider_account_reference	string	Sí	Provider account reference.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "provider": "Stripe Connect",
  "provider_account_reference": "acct_1PqRsT"
}

Respuesta 201: PayoutAccount

payoutAccounts.create: PayoutAccount
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payout account.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
person_id	string (uuid) \| null	Sí	Identifier of the payee person.
organization_id	string (uuid) \| null	Sí	Identifier of the payee organization.
provider	"Stripe Connect" \| "Accounting System"	Sí	Payment provider.
provider_account_reference	string	Sí	Provider account reference.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
account_last4	string \| null	Sí	Last four digits of the account.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "provider": "Stripe Connect",
  "provider_account_reference": "acct_1PqRsT",
  "account_last4": "4421"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/payout-accounts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"Stripe Connect","provider_account_reference":"acct_1PqRsT"}'

const { data } = await xos.payoutAccounts.create({
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "provider": "Stripe Connect",
    "provider_account_reference": "acct_1PqRsT"
  });

response = xos.payout_accounts.create({"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "provider": "Stripe Connect", "provider_account_reference": "acct_1PqRsT"})

xos payout-accounts create --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"Stripe Connect","provider_account_reference":"acct_1PqRsT"}'