---
title: "Creates a Payout resource."
method: POST
path: "/payouts"
tags: ["Payout"]
---

# Creates a Payout resource.

`POST /payouts`

Creates a Payout resource.

## Request body

- Payout — Payout represents received funds made out to a bank account or debit card
  - `id` string — Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"
  - `amount` integer — The amount to be transferred to a bank account or debit card in cents e.g. 74753
  - `arrivalDate` string, nullable — The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z"
  - `automatic` string, nullable — Whether the payout was created by an automated payout schedule or not e.g. "true"
  - `balanceTransactionId` string, nullable — The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464"
  - `created` string, nullable — The date and time this payout was created e.g. "2020-11-03"
  - `currency` string, nullable — Currency the payout is made in e.g. "USD"
  - `payoutDescription` string, nullable — A description of the payout e.g. "Payout description"
  - `destinationId` string, nullable — The ID of the bank account or card the payout is sent to e.g. "44"
  - `failureBalanceTransactionId` string, nullable — The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77"
  - `failureCode` string, nullable — Error code explaining reason for payout failure.
  - `failureMessage` string, nullable — Message to user further explaining reason for payout failure e.g. "payment failed"
  - `method` string, nullable — Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard"
  - `sourceType` string, nullable — The source balance this payout came from e.g. "card" e.g. "bank_account"
  - `status` string, nullable — Current status of the payout e.g. "paid" e.g. "pending"
  - `payoutType` string, nullable — Type of payout e.g. "bank_account" e.g. "card"

## Response `201`

Payout resource created

- Payout — Payout represents received funds made out to a bank account or debit card
  - `id` string — Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"
  - `amount` integer — The amount to be transferred to a bank account or debit card in cents e.g. 74753
  - `arrivalDate` string, nullable — The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z"
  - `automatic` string, nullable — Whether the payout was created by an automated payout schedule or not e.g. "true"
  - `balanceTransactionId` string, nullable — The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464"
  - `created` string, nullable — The date and time this payout was created e.g. "2020-11-03"
  - `currency` string, nullable — Currency the payout is made in e.g. "USD"
  - `payoutDescription` string, nullable — A description of the payout e.g. "Payout description"
  - `destinationId` string, nullable — The ID of the bank account or card the payout is sent to e.g. "44"
  - `failureBalanceTransactionId` string, nullable — The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77"
  - `failureCode` string, nullable — Error code explaining reason for payout failure.
  - `failureMessage` string, nullable — Message to user further explaining reason for payout failure e.g. "payment failed"
  - `method` string, nullable — Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard"
  - `sourceType` string, nullable — The source balance this payout came from e.g. "card" e.g. "bank_account"
  - `status` string, nullable — Current status of the payout e.g. "paid" e.g. "pending"
  - `payoutType` string, nullable — Type of payout e.g. "bank_account" e.g. "card"

## Other responses

- `400` — Invalid input
- `422` — Unprocessable entity

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/revisions/d08a107895ad/schema)