Skip to main content

Understand payout settings

Payout settings answer two questions: when Inttegro should create automatic payouts, and which financial account should receive each currency. They apply to one Inttegro account, not the whole organization.

Use MCP to read payout settings

An authenticated AI agent can fetch the current schedule, destination mapping, and FX setting so operators can review configuration without constructing the payout settings request by hand.

MCP tools: get_payout_settings

Use Get payout settings for the exact response. Use this guide to interpret the fields.

The settings object

The read response returns a settings object.

FieldMeaning
scheduleCurrent payout mode and timing. Omitted only if a schedule cannot be resolved.
destinationsMap of currency code to financial account ID. Always present and may be empty.
fx_enabledStored FX setting when present. It does not make cross-currency payouts available by itself.

Lookup and mutation responses expose slightly different schedule shapes. The lookup response uses aging_spec; some mutation responses include schedule IDs and use spec. When you are implementing a request or parser, follow the Payouts API reference.

Schedule

schedule tells you whether Inttegro creates payouts automatically.

FieldAutomatic modeManual mode
typeautomaticmanual
nameUsually weeklyUsually manual
intervalweeklymanual
schedule_onsundaymanual
descriptionHuman-readable schedule summary.Human-readable schedule summary.

When schedule.type is automatic, Inttegro creates payouts on the configured cadence when eligible funds and destinations exist. The default automatic schedule runs weekly on Sunday at midnight UTC.

When schedule.type is manual, Inttegro does not create automatic payouts. You create them yourself with Schedule a payout.

Aging rule

schedule.aging_spec controls when balance transactions become payout-eligible.

FieldMeaning
t_plusMinimum age before a balance transaction can be included. The default is 168h.
labelStable label for the aging rule, such as 168_hours.
abideEnforcement mode. Public settings currently use strict enforcement.

The aging window is exact. If a payment settles Monday at 15:00 UTC and t_plus is 168h, it becomes eligible the following Monday at 15:00 UTC. The next payout after that moment can include it.

Destinations

destinations maps payout currencies to financial accounts:

{
  "destinations": {
    "ghs": "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo"
  }
}

Read it as “send eligible GHS payouts to this financial account.”

Destination rules:

  • Currency keys are lowercase currency codes.
  • The financial account must be connected to the same Inttegro account.
  • The account currency must match the map key.
  • The account must be active and able to receive payouts.
  • A missing currency key means automatic payouts cannot be created for that currency.
  • Updating the map affects future payouts, not payouts that are already scheduled or executing.

Manual payout requests still provide destination_id directly. The settings map is primarily automatic-routing configuration, not a reason to omit the destination from a manual payout request.

FX setting

fx_enabled may appear when a setting has been stored. Treat it as informational unless the API reference for the payout operation explicitly supports the cross-currency flow you need.

Today, payout destinations must use the same currency as the funds being paid out.

Operational checks

Use payout settings to answer common operations questions.

QuestionCheck
Are automatic payouts on?schedule.type should be automatic.
Which day do automatic payouts run?schedule.schedule_on.
How long do funds age before payout?schedule.aging_spec.t_plus.
Will GHS funds route anywhere?destinations.ghs should be present and point to an active GHS financial account.
Why did no automatic payout run?Check schedule.type, the destination map, eligible balance transactions, and open payouts for the destination.
Can I pay out in another currency?Confirm both supported currency coverage and a same-currency destination.