Overview

The Payout object represents a payment from you to one of your activated connections.

Permission Required

Creating payouts requires the payment.credit permission from the selected account connection. This permission will be granted automatically if a legacy payout method is specified when creating the account connection.

Payout Lifecycle

Each payout follows a lifecycle with events and timing depend on the type of the account connection receiving the payout. Payouts to inactive account connections are considered unclaimed and allow the recipient 30 days to activate their account connection and receive their payout. This diagram shows lifecycle events for the different types of payouts:

Payout Lifecycle.

Methods

POST /payout
Make payouts to your account connections. Include an idempotency key header to make the request idempotent.

Body Parameters

account_connection

string

required

ID of Account Connection to pay

amount_in_cents

number

required

Amount in cents, e.g. $1.00 would be the number 100.

description

string

Description of payout. (Visible to creators.) Default value: Payment from {enterprise_name}

date

string

Schedule a future payout by setting its date with an ISO 8601 date/time string. If omitted, payout will be queued for processing immediately.

user_data

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /payout
{
    "account_connection": "acon_XXXXX",
    "amount_in_cents": 10000,
    "description": "January Payout"
}

POST /payout
Make payouts to your account connections. Include an idempotency key header to make the request idempotent.

Body Parameters

account_connection

string

required

ID of Account Connection to pay

amount_in_cents

number

required

Amount in cents, e.g. $1.00 would be the number 100.

description

string

Description of payout. (Visible to creators.) Default value: Payment from {enterprise_name}

date

string

Schedule a future payout by setting its date with an ISO 8601 date/time string. If omitted, payout will be queued for processing immediately.

user_data

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /payout
{
    "account_connection": "acon_XXXXX",
    "amount_in_cents": 10000,
    "description": "January Payout"
}

POST /payout/batch
Create many payouts at once. This method is more performant than individually creating payouts, and should be used in high-volume situations.

This method is strict. If any payout object fails validation, no payouts will be created. If addition to the top-level error message in the error response, the details key will contain an array of any problematic request objects and their individual errors. See example Bad Request error response below.

Include an idempotency key header to make the request idempotent.

Body Parameters

payouts

object[]

required

Array of payout objects. See Payout object specification from Create Payout method.

Example

// POST /payout/batch
{
    "payouts": [
        {
            "account_connection": "acon_XXXXX",
            "amount_in_cents": 10000,
            "description": "January Payout"
        },
        {
            "account_connection": "acon_YYYYY",
            "amount_in_cents": 10000,
            "description": "January Payout"
        }
    ]
}

GET /payout/:id
Get details of one of your payments.

Path Parameters

string

required

The ID of the payout to retrieve.

Example

{
    "id": "pay_AAAAA",
    "type": "direct",
    "status": "pending",
    "account_connection": "acon_XXXXX",
    "amount_in_cents": 10000,
    "description": "January Payout",
    "date": "2024-11-12T20:22:49.075Z",
    "destination": "Manifest Account - Paul McCartney",
    "fee_in_cents": 10,
    "userdata": {},
    "created_at": "2024-11-12T20:22:49.075Z",
    "updated_at": "2024-11-12T20:22:49.075Z"
}

PUT /payout/:id
Update data associated with one of your enterprise’s payouts. Only certain fields can be updated. See below.

Path Parameters

string

required

The ID of the payout to update.

Body Parameters

status

string

Pass the string canceled to cancel the payout. This is only effective if the payout is in ready status.

description

string

Description of payout. (Visible to creators.) Default value: Payment from {enterprise_name}

date

string

Reschedule a future payout by setting its date with an ISO 8601 date/time string.

user_data

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// PUT /payout/pay_AAAAA
{
    "description": "Royalties for Hey Jude"
}

GET /payout
List all payouts from your enterprise.

Query Parameters

page

integer

The page number to return. Default is 1.

page_size

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "pay_CCCCC",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_XXXXX",
            "amount_in_cents": 10000,
            "description": "January Payout",
            "date": "2024-01-15T20:22:49.075Z",
            "destination": "Manifest Account - Paul McCartney",
            "fee_in_cents": 5,
            "userdata": {},
            "created_at": "2024-01-15T20:22:49.075Z",
            "updated_at": "2024-01-15T20:22:49.075Z"
        },
        {
            "id": "pay_BBBBB",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_YYYYY",
            "amount_in_cents": 10000,
            "description": "January Payout",
            "date": "2024-14-12T20:22:49.075Z",
            "destination": "Manifest Account - Ringo Starr",
            "fee_in_cents": 10,
            "userdata": {},
            "created_at": "2024-14-12T20:22:49.075Z",
            "updated_at": "2024-14-12T20:22:49.075Z"
        },
        {
            "id": "pay_AAAAA",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_XXXXX",
            "amount_in_cents": 10000,
            "description": "December Payout",
            "date": "2024-11-12T20:22:49.075Z",
            "destination": "Manifest Account - Paul McCartney",
            "fee_in_cents": 10,
            "userdata": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

GET /account-connection/:id/payout
List all payouts from your enterprise to a specific account connection.

Path Parameters

string

required

The ID of the account connection to list payouts for.

Query Parameters

page

integer

The page number to return. Default is 1.

page_size

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "pay_CCCCC",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_XXXXX",
            "amount_in_cents": 10000,
            "description": "January Payout",
            "date": "2024-01-15T20:22:49.075Z",
            "destination": "Manifest Account - Paul McCartney",
            "fee_in_cents": 5,
            "userdata": {},
            "created_at": "2024-01-15T20:22:49.075Z",
            "updated_at": "2024-01-15T20:22:49.075Z"
        },
        {
            "id": "pay_BBBBB",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_XXXXX",
            "amount_in_cents": 10000,
            "description": "December Payout",
            "date": "2024-14-12T20:22:49.075Z",
            "destination": "Manifest Account - Paul McCartney",
            "fee_in_cents": 10,
            "userdata": {},
            "created_at": "2024-14-12T20:22:49.075Z",
            "updated_at": "2024-14-12T20:22:49.075Z"
        },
        {
            "id": "pay_AAAAA",
            "type": "direct",
            "status": "sent",
            "account_connection": "acon_XXXXX",
            "description": "November Payout",
            "date": "2024-11-12T20:22:49.075Z",
            "destination": "Manifest Account - Paul McCartney",
            "amount_in_cents": 10000,
            "fee_in_cents": 10,
            "userdata": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

Properties

string

Identifier for this payout.

account_connection

string

ID of Account Connection to pay

description

string

Description of payout. (Visible to creators.)

date

string

Schedule a future payout by setting its date with an ISO 8601 date/time string. If omitted, payout will be queued for processing immediately.

destination

string

A plaintext label of the payout’s destination account, suitable for display.

amount_in_cents

number

Amount in cents, e.g. $1.00 would be the number 100.

fee_in_cents

number

Fee paid to Manifest for this payout, in cents, e.g. $1.00 would be the number 100.

type

string

Type of payment. One of direct, ach, or unclaimed. This field will be populated based on the Account Connection type at the time of payment.

Note: Payouts to inactive account connections are considered unclaimed and allow the recipient 30 days to activate their account connnection and receive their payout.

activity

object[]

An activity log that tracks the status changes, internal transfers, and any errors associated with a given payout.

status

string

Status of payout. One of:

Status	Description
`created`	Initial status after object creation. Payouts should only remain in this status a few seconds.
`ready`	Once a payout’s funds have been moved to your enterprise’s pending payouts account, the payout will be changed to `ready` status.
`pending`	The payment to the creator has been initiated, based on the `type` of the account connection. Final fees are calculated, and any over-estimated fees are put back in your operating account. ACH: Payment is queued for processing, which happens periodically throughout the banking day.
`sent`	Manifest: The payment was completed and the amount is now available in the creator’s account. ACH: The payment was processed and sent out to the ACH network for clearing and settlement.
`error`	The transfer encountered an error during processing. The reasons a transfer might be set to error include insufficient funds, suspected fraud, or failed validation. Check your payout’s `activity` log for details.
`returned` (ACH only)	The transfer was processed and sent, but the network or receiving bank could not complete the transfer successfully. The payout amount has been returned to your operating account.
`canceled`	The payout was canceled by you before its `date`. The pending funds have been returned to your operating account.

user_data

object

User defined data that can be attached to the object. See the User Data page for details.

Documentation

Sending Money

Receiving Money

Resources

Reference

Payouts

Overview

Payout Lifecycle

Methods

Body Parameters

Example

Body Parameters

Example

Body Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Properties

Documentation

Sending Money

Receiving Money

Resources

Reference

​Overview

​Payout Lifecycle

​Methods

​Body Parameters

​Example

​Body Parameters

​Example

​Body Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Body Parameters

​Example

​Query Parameters

​Example

​Path Parameters

​Query Parameters

​Example

​Properties

Overview

Payout Lifecycle

Methods

Body Parameters

Example

Body Parameters

Example

Body Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Properties