Payout Resources

This page provides a detailed explanation of all payout endpoint responses, including the structure, fields, and possible values returned by the API.

Payout Resource

A payout resource returned in both Get Payout List and Get Payout Detail by ID

{
  "data": {
    "id": "po_yeQv3AJ23ZjmN7y7on4yhBqv",
    "type": "payout",
    "attributes": {
      "amount": 0,
      "adjustment_amount": 450000,
      "bank_account_name": "Staging New Account",
      "bank_account_number": "516646818064",
      "bank_id": "bank_xxxxxxxxxxxx",
      "bank_name": "PAYMONGO PAYMENTS, INC.",
      "converted_net_amount": 450000,
      "currency": "PHP",
      "currency_exchange_rate": {
        "from_currency": "PHP",
        "from_value": 100,
        "to_currency": "PHP",
        "to_value": 100
      },
      "description": "Payout for Staging New Merchant - PHP",
      "digital_tax": 0,
      "digital_withholding_vat_amount": 0,
      "dispute_amount": 0,
      "fee": 0,
      "foreign_fee": 0,
      "last_payout_transfer": {
        "id": "trn_hT5875aAa3Q1CfAdoNrYx6oe",
        "channel": null,
        "origin": "api",
        "provider": "paymongo_central_hub",
        "provider_reference_number": null,
        "reference_number": "zxLG4VwVH5XGJyLzkHSE",
        "receiver_account_name": "Test Account",
        "receiver_account_number": "987654321000",
        "receiver_institution_id": "11",
        "receiver_institution_name": "BDO Unibank, Inc.",
        "status": "processing",
        "error_code": null,
        "error_message": null
      },
      "net_amount": 450000,
      "workflow_id": "flow-xxxxxxxxxxxx",
      "organization": {
        "id": "org_wuzk4s4pBmqqXpW8BcWUFLTL",
        "business_handle": "new-stg",
        "trade_name": "Staging New Merchant",
        "bank_account_name": "Test Account",
        "bank_account_number": "0001234567890",
        "bank_id": "bank_xxxxxxxxxxxxx",
        "bank_name": "BDO Unibank"
      },
      "provider": "paymongo_central_hub",
      "refund_amount": 0,
      "status": "in_transit",
      "tax_amount": 0,
      "taxes": [],
      "created_at": 1767079011,
      "status_updated_at": 1767079325,
      "updated_at": 1767079324
    }
  }
}

Payout Object

Field Name	Type	Description
`adjustment_amount`	integer	Adjustment amount applied to the payout
`amount`	integer	Original payout amount
`bank_account_name`	string	Name of the receiving bank account
`bank_account_number`	string	Number of the receiving bank account
`bank_id`	string	Unique identifier of the receiving bank
`bank_name`	string	Name of the receiving bank
`converted_net_amount`	integer	Net payout amount after conversion
`created_at`	integer	Unix timestamp when the payout was created
`currency`	string	Currency code of the payout
`currency_exchange_rate`	object	Currency exchange rate details (see Currency Exchange Rate Object below)
`description`	string	Description of the payout
`digital_tax`	integer	Digital tax amount
`digital_withholding_vat_amount`	integer	Digital withholding VAT amount
`dispute_amount`	integer	Total dispute amount deducted from payout
`fee`	integer	Payout processing fee
`foreign_fee`	integer	Foreign transaction fee
`id`	string	The payout ID
`last_payout_transfer`	object	Details of the last payout transfer; null if no transfer yet (see Last Payout Transfer Object below)
`net_amount`	integer	Net payout amount after deductions
`organization`	object	Organization details (see Organization Object below)
`provider`	string	Payout provider name
`refund_amount`	integer	Total refund amount deducted from payout
`status`	string	Current status of the payout. Possible values: `pending`, `on_hold`, `in_transit`, `deposited`, `returned`, `cancelled`
`status_updated_at`	integer	Unix timestamp when the payout status was last updated
`tax_amount`	integer	Total tax amount
`taxes`	array	List of taxes applied to the payout (see Taxes Array below)
`type`	string	The resource type
`updated_at`	integer	Unix timestamp when the payout was last updated
`workflow_id`	string	Unique identifier of the payout workflow

Currency Exchange Rate Object

Field Name	Type	Description
`from_currency`	string	Source currency code
`from_value`	integer	Source currency value
`to_currency`	string	Target currency code
`to_value`	integer	Target currency value

Last Payout Transfer Object

Field Name	Type	Description
`id`	string	The transfer ID
`channel`	string	The channel used for the transfer
`origin`	string	The origin of the transfer (e.g., `api`, `dashboard`)
`provider`	string	The payment provider
`provider_reference_number`	string	Reference number from the provider
`receiver_account_name`	string	Name of the receiver's bank account
`receiver_account_number`	string	Account number of the receiver's bank account
`receiver_institution_id`	string	Institution ID of the receiver's bank
`receiver_institution_name`	string	Name of the receiver's bank institution
`reference_number`	string	Internal reference number for the transfer
`status`	string	The current status of the transfer. Possible values: `to_do`, `pending`, `processing`, `deposited`, `returned`
`error_code`	string	Error code if the transfer failed
`error_message`	string	Error message if the transfer failed

Organization Object

Field Name	Type	Description
`id`	string	Organization ID
`bank_account_name`	string	Name of the organization's bank account
`bank_account_number`	string	Organization's bank account number
`bank_id`	string	Unique identifier of the organization's bank
`bank_name`	string	Name of the organization's bank
`business_handle`	string	Business handle
`trade_name`	string	Trade name of the organization

Taxes Array Items

Each item in the taxes array is an object with the following fields:

Field Name	Type	Description
`amount`	integer	Tax amount
`currency`	string	Currency code
`inclusive`	boolean	Whether tax is inclusive in the amount
`name`	string	Tax name
`type`	string	Tax type (e.g., `vat`, `withholding_tax`)
`value`	string	Tax value (e.g., basis points)

Upcoming Payout Resource

An upcoming payout resource returned in Get Upcoming Payout Amount and Schedule

{
  "data": {
    "id": "org_wuzk4s4pBmqqXpW8BcWUFLTL",
    "type": "schedule",
    "attributes": {
      "options": [
        "monthly",
        "weekly"
      ],
      "type": "daily",
      "days": null,
      "lineup": [
        {
          "amount": 10000,
          "currency": "PHP",
          "transactions": {
            "adjustments": {
              "amount": 6000,
              "count": 1,
              "currency": "PHP"
            },
            "disputes": {
              "amount": 0,
              "count": 0,
              "currency": "PHP"
            },
            "payments": {
              "amount": 4000,
              "count": 1,
              "currency": "PHP"
            },
            "refunds": {
              "amount": 0,
              "count": 0,
              "currency": "PHP"
            }
          },
          "generation_at": 1770944400,
          "receive_at": 1771174800
        },
        {
          "amount": 20000,
          "currency": "PHP",
          "transactions": {
            "adjustments": {
              "amount": 0,
              "count": 0,
              "currency": "PHP"
            },
            "disputes": {
              "amount": 0,
              "count": 0,
              "currency": "PHP"
            },
            "payments": {
              "amount": 50000,
              "count": 1,
              "currency": "PHP"
            },
            "refunds": {
              "amount": -30000,
              "count": 1,
              "currency": "PHP"
            }
          },
          "generation_at": 1771030800,
          "receive_at": 1771174800
        }
      ]
    }
  }
}

Upcoming Payout Object

Field Name	Type	Description
`options`	array	Available payout schedule options (e.g., `monthly`, `weekly`)
`type`	string	The current payout schedule type (e.g., `daily`)
`days`	string	The day(s) name for weekly schedule or the date of monthly schedule
`lineup`	array	Upcoming payouts in order (see Lineup Items below)

Lineup Items

Field Name	Type	Description
`amount`	integer	The upcoming payout amount
`currency`	string	The currency code
`generation_at`	integer	Unix timestamp when the upcoming payout will be generated
`receive_at`	integer	Unix timestamp when the upcoming payout will be received
`transactions`	object	Breakdown of transaction types (see Transactions Object below)

Upcoming Payout Transactions Object

Field Name	Type	Description
`adjustments`	object	Adjustment transaction summary (see Transaction Summary Object below)
`disputes`	object	Dispute transaction summary (see Transaction Summary Object below)
`payments`	object	Payment transaction summary (see Transaction Summary Object below)
`refunds`	object	Refund transaction summary (see Transaction Summary Object below)

Transaction Summary Object

Each transaction type (adjustments, disputes, payments, refunds) contains a summary object with the following fields:

Field Name	Type	Description
`amount`	integer	Total amount for this transaction type
`count`	integer	Number of transactions of this type
`currency`	string	Currency code

Payout Transaction Resource

An payout transaction resource returned in Get Payout Transactions by ID

{
  "pagination": {
    "next_cursor": null,
    "prev_cursor": null
  },
  "data": [
    {
      "id": "ref_JS9psHGFrPjeWgJgMDaeX8Ae",
      "type": "refund",
      "attributes": {
        "amount": 100000,
        "balance_transaction_id": "bal_txn_hgw9LnMdUkaSti3UKJcFJHGx",
        "created_at": 1770344659,
        "currency": "PHP",
        "description": null,
        "fee": 0,
        "livemode": true,
        "net_amount": 100000,
        "organization_id": "org_wuzk4s4pBmqqXpW8BcWUFLTL",
        "payout_id": "po_YbCUnoG4AJZ9FSaR1TGYC3QN",
        "transaction_at": 1770344659,
        "updated_at": 1770598929
      }
    },
    {
      "id": "pay_y3qBrpzkaK7NZPvev5JYmYWx",
      "type": "payment",
      "attributes": {
        "amount": 250000,
        "balance_transaction_id": "bal_txn_keTqvkywZv4W3zoc2ox8UpCN",
        "created_at": 1770344429,
        "currency": "PHP",
        "description": null,
        "digital_withholding_vat_amount": 0,
        "fee": 10250,
        "foreign_fee": 2500,
        "livemode": true,
        "net_amount": 237478,
        "organization_id": "org_wuzk4s4pBmqqXpW8BcWUFLTL",
        "paid_at": 1770344429,
        "payout_id": "po_YbCUnoG4AJZ9FSaR1TGYC3QN",
        "tax_amount": 228,
        "transaction_at": 1770344429,
        "updated_at": 1770598928
      }
    },
    {
      "id": "dp_9vLmizjGyggvuXjFQdTcKSkc",
      "type": "dispute",
      "attributes": {
        "amount": 100,
        "balance_transaction_id": "bal_txn_SdN8uPjNQNKktVuopF2aXsUd",
        "created_at": 1770344569,
        "currency": "PHP",
        "description": null,
        "dispute_fee": 20,
        "livemode": true,
        "net_amount": 120,
        "organization_id": "org_wuzk4s4pBmqqXpW8BcWUFLTL",
        "payout_id": "po_YbCUnoG4AJZ9FSaR1TGYC3QN",
        "transaction_at": 1770336000,
        "updated_at": 1770598928
      }
    }
  ]
}

Transaction Object

Field Name	Type	Description
`amount`	integer	Transaction amount
`balance_transaction_id`	string	ID of the associated balance transaction
`created_at`	integer	Unix timestamp when the transaction was created
`currency`	string	Currency code
`description`	string	Description of the transaction
`digital_withholding_vat_amount`	integer	Digital withholding VAT amount (payments only)
`dispute_fee`	integer	Dispute fee (disputes only)
`fee`	integer	Transaction fee (payments only)
`foreign_fee`	integer	Foreign transaction fee (payments only)
`id`	string	The transaction ID
`livemode`	boolean	Whether the transaction is in live mode
`net_amount`	integer	Net transaction amount after fees
`organization_id`	string	Organization ID associated with the transaction
`paid_at`	integer	Unix timestamp when the payment was completed (payments only)
`payout_id`	string	The payout ID associated with this transaction
`tax_amount`	integer	Tax amount (payments only)
`transaction_at`	integer	Unix timestamp of the transaction
`type`	string	The type of transaction. Possible values: `payment`, `refund`, `dispute`, `adjustment`, `split_payment`, `split_refund`
`updated_at`	integer	Unix timestamp when the transaction was last updated

Payout Webhook Event Resource

A webhook event resource sent to your registered webhook endpoint whenever a payout status is updated. You may also refer to the Webhooks, Webhook Event and Webhook Resource documentation for a complete overview of how webhooks work in PayMongo.

{
  "data": {
    "id": "evt_xxxxxxxxxxxxxxxxxxx",
    "type": "event",
    "attributes": {
      "type": "payout.deposited",
      "livemode": true,
      "data": {
        "id": "po_xxxxxxxxxxxxxxxxxx",
        "type": "payout",
        "attributes": {
          "amount": 0,
          "adjustment_amount": 298500,
          "bank_account_name": "Test Account",
          "bank_account_number": "0001234567890",
          "bank_id": "bank_xxxxxxxxxxxx",
          "bank_name": "PAYMONGO PAYMENTS, INC.",
          "converted_net_amount": 298500,
          "currency": "PHP",
          "currency_exchange_rate": {
            "from_currency": "PHP",
            "from_value": 100,
            "to_currency": "PHP",
            "to_value": 100
          },
          "description": "Payout for Test Account - PHP",
          "digital_tax": 1500,
          "digital_withholding_vat_amount": 0,
          "dispute_amount": 0,
          "fee": 0,
          "foreign_fee": 0,
          "last_payout_transfer": {
            "id": "trn_xxxxxxxxxxxxxxx",
            "channel": "paymongo",
            "origin": "api",
            "provider": "paymongo_workflow",
            "provider_reference_number": "3af7d9b2a0dfd43707a58e8a",
            "reference_number": "sEWt2a9YGu2TEg9gqRMb",
            "receiver_account_name": "Test Account",
            "receiver_account_number": "987654321000",
            "receiver_institution_id": "11",
            "receiver_institution_name": "BDO Unibank, Inc.",
            "status": "deposited_in_workflow",
            "error_code": "",
            "error_message": ""
          },
          "net_amount": 298500,
          "workflow_id": "flow-xxxxxxxxxxxx",
          "organization": {
            "id": "org_xxxxxxxxxxxxxxxxxxx",
            "business_handle": "org-test",
            "trade_name": "Test Account",
            "bank_account_name": "Test Account",
            "bank_account_number": "0001234567890",
            "bank_id": "bank_xxxxxxxxxxxxx",
            "bank_name": "BDO Unibank"
          },
          "provider": "paymongo_workflow",
          "refund_amount": 0,
          "status": "deposited",
          "tax_amount": 0,
          "taxes": [],
          "created_at": 1780394601,
          "status_updated_at": 1780395062,
          "updated_at": 1780395074
        }
      },
      "previous_data": {},
      "pending_webhooks": 1,
      "created_at": null,
      "updated_at": null
    }
  }
}

Event Object

Field Name	Type	Description
`id`	string	Unique identifier for the event, prefixed with `evt_`
`type`	string	The resource type. Value is always `event`

Event Attributes Object

Field Name	Type	Description
`type`	string	The event type indicating the payout status change. Possible values: `payout.deposited`, `payout.returned`
`livemode`	boolean	Whether the event originated from a live mode payout (`true`) or test mode (`false`)
`data`	object	The full Payout Resource at the time of the event. See Payout Resource
`previous_data`	object	The previous state of the payout before this event. Empty object if no previous state is available
`pending_webhooks`	integer	Number of webhook endpoints that have yet to receive this event
`created_at`	integer	Unix timestamp when the event was created. May be `null`
`updated_at`	integer	Unix timestamp when the event was last updated. May be `null`