---
title: "Create Counterparty Payout"
method: POST
path: "/api/v1/counterparties/:counterpartyId/payouts"
tags: ["Counterparties"]
---

# Create Counterparty Payout

`POST /api/v1/counterparties/:counterpartyId/payouts`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/counterparties/:counterpartyId/payouts`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/counterparties/:counterpartyId/payouts/post.ts> (a function with typed inputs; its response is checked against the schema)

Initiate a payout from the counterparty's available balance to their bank account.

In sandbox, the counterparty's account number decides whether the payout completes, is returned, or fails. See [Simulating returned and failed payouts](/docs/integration/sandbox/instructions#simulating-returned-and-failed-payouts) for the test account numbers and [ACH Return Codes](/docs/webhooks/ach-return-codes) for every return code.

## Path parameters

- `counterpartyId` string, uuid, required: ID of the counterparty from which to payout.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Request body

- object
  - `data` object, required
    - `type` 'CreateCounterpartyPayout', required
    - `attributes` object, required
      - `amount` integer, required: Amount to payout in cents. Capped at 2147483647 ($21,474,836.47) per payout; a larger available balance must be paid out across multiple payouts.
      - `idempotencyKey` string, required: Idempotency key to prevent duplicate payouts

## Response `201`

Payout initiated successfully

- PayoutFromCounterpartyResponse
  - `data` CounterpartyPayout, required: A payout represents a transfer of funds from a counterparty's available balance to their bank account.
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'CounterpartyPayout', required
    - `attributes` object, required
      - `amount` integer, required: Amount in cents
      - `status` 'Approved' | 'Cancelled' | 'Completed' | 'Denied' | 'Failed' | 'NeedsApproval' | 'Pending' | 'Processing' | 'Returned' | 'Reversed' | 'Sent', required: Current status of the payout
      - `description` string, nullable, required: Description of the payout
      - `effectiveDate` string, required: Effective date of the payout (ISO 8601 date string)
      - `counterpartyId` string, uuid, required: Counterparty ID (from our system)
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)