Payouts

Table of contents

  1. Payouts
  2. Introduction
  3. Automated Payouts
  4. Manual Payouts
    1. Requesting A Manual Payout
  5. Lifecycle
    1. Holding
    2. Pending
    3. Processing
    4. Completed
    5. Failed
    6. Cancelled
  6. Example Object

Introduction

A payout is a withdrawal of your confirmed balance to an address held in your custody.

As a result of Posfra’s distributed infrastructure, each payout may be separated into 2 or 3 individual transactions.

Automated Payouts

The best practice when using Posfra is to enable automated payouts. This will withdraw your entire confirmed balance to a default address every 24 hours at 6pm UTC.

To update your default payout address, go to Settings -> Payouts. Here you can enable disable automated payouts and set your default payout address.

Manual Payouts

You have the option to manually request a payout at anytime. This is typically used if you receive a large payment and want to withdraw it immediately.

Requesting A Manual Payout

To request a manual payout, go to Payouts -> Request Payout. On this page you can enter the Bitcoin address you would like to send your confirmed balance to.

Lifecycle

Each payouts lifecycle is as follows:

Holding

As a security mechanism all manually created payments are held in the Holding state for 1 hour. An email notification and webhook is triggered when a manual payment is requested, you can cancel a pending manual payout.

Pending

The payout will be in the Pending state when the final payout amount has been calculated and the Bitcoin transactions are ready to be signed.

Processing

The transaction is being signed. Typically a payout should only ever be in this state for less than a minute.

Completed

All of the transactions have been successfully signed and broadcast to the network.

Failed

If one or more of the transactions fail to complete the Payout will be set to Failed.

Cancelled

When a manually created transaction was cancelled while it was in the Holding state

Example Object

{
    "id": "f5c58335-1e49-44f2-9ca9-328e6986a327",
    "groupID": "4af56375-35b8-4f2c-a027-755b2c955f26",
    "address": "bc1qdvcr2hdhdl2f9nj37ar2h4eq2f88r4vqnxas44",
    "status": "Completed",
    "currency": "BTC",
    "requestedBy": "CRON",
    "estValue": "0.00042750",
    "estFee": "0.00002250",
    "estTotal": "0.00045000",
    "value": "0.00042750",
    "fee": "0.00002250",
    "pendingAt": "2025-12-01 18:00:00",
    "completedAt": "2025-12-01 18:00:00",
    "createdAt": "2025-12-01 18:00:00",
    "updatedAt": "2025-12-01 18:00:00"
}

No AI was used in the creation of this documentation.