Payouts

Payouts move available funds from your Inttegro balance to a connected bank account or mobile money wallet. Schedule a transfer yourself or let Inttegro create payouts automatically, then follow each payout through completion. For the broader settlement model, see Payouts and Understand payouts.

Operations

Schedule a payout
Lookup a payout
Cancel a payout
Get payout settings
Set payout destinations
Disable automatic payouts
Enable automatic payouts
Page through payouts

The payout object

A payout records the destination, authorized amount, status, and balance transactions included in a transfer. Fields that depend on later processing are omitted until they have values.

Properties

amountobjectActual payout amount when known. Omitted before the amount is determined.Click or tap to expand
- Name
  currency
  Type
  string
  Required
  required
  Description
  Lowercase currency code.
- Name
  value
  Type
  integer
  Required
  required
  Description
  Amount in the smallest currency unit.
Name
balance_transactions
Type
array
Description
Source balance transaction IDs linked to the payout. Omitted until transactions are linked. After refunds, their original amounts can sum to more than the payout amount.
Name
canceled_at
Type
timestamp
Description
When the payout was canceled. Omitted otherwise.
custom_dataobjectClick or tap to expand
Your string key-value metadata, when available.
Name
destination_id
Type
string
Required
required
Description
Financial account selected as the destination.
errorobjectPublic error details when payout execution fails. Omitted when no error is present.Click or tap to expand
- Name
  cause
  Type
  string
  Required
  required
  Description
  Underlying public cause.
- Name
  message
  Type
  string
  Required
  required
  Description
  Human-readable error message.
- Name
  occurred_at
  Type
  timestamp
  Required
  required
  Description
  When the error occurred.
- Name
  type
  Type
  string
  Required
  required
  Description
  Machine-readable error type.
Name
execute_after
Type
timestamp
Required
required
Description
Earliest time execution can begin.
Name
executed_by
Type
string
Description
Actor that executed the payout, when available.
Name
expected_at
Type
timestamp
Description
Expected completion time, when available.
Name
failed_at
Type
timestamp
Description
When the payout entered its unsuccessful terminal state. Omitted otherwise.
Name
id
Type
string
Required
required
Description
Unique payout identifier.
Name
initiated_at
Type
timestamp
Required
required
Description
When the payout record was created.
Name
initiated_by
Type
string
Description
Actor that initiated the payout, when available.
max_amountobjectrequiredMaximum authorized payout amount.Click or tap to expand
- Name
  currency
  Type
  string
  Required
  required
  Description
  Lowercase currency code.
- Name
  value
  Type
  integer
  Required
  required
  Description
  Amount in the smallest currency unit.
Name
reference
Type
string
Description
Your reconciliation reference, when provided.
Name
schedule_id
Type
string
Description
Schedule associated with the payout, when available.
Name
scheduled_at
Type
timestamp
Description
When the payout was scheduled, when available.
Name
scheduled_by
Type
string
Description
Actor that scheduled the payout, when available.
Name
sent_at
Type
timestamp
Description
When the transfer was sent, when available.
Name
source_id
Type
string
Description
Source identifier, when available.
Name
status
Type
enum
Required
required
Description
Current state: initialized, scheduled, processing, executing, succeeded, invalid, or canceled.
Name
succeeded_at
Type
timestamp
Description
When the payout succeeded. Omitted otherwise.

max_amount is a ceiling, not a guaranteed transfer amount. The final payout can be lower when less money is available. For balance selection, refunds, and reconciliation examples, see How payouts use your balance.

POST/payouts/schedule

Schedule a payout

Create a payout to a connected financial account. Omit execute_after to begin as soon as possible, or provide a future time to delay the transfer.

The destination determines the payout currency. It must be active, able to receive funds, and cannot already have another payout in progress. The response includes a payout ID that you can use to check progress.

Request attributes

Name
destination_id
Type
string
Required
required
Description
Financial account that receives the funds. Mobile money wallets and complete Ghana bank accounts are supported when push capability is enabled. Scheduling is rejected while another payout for this destination remains open.
Name
execute_after
Type
timestamp
Description
Earliest time Inttegro may begin the payout, as an ISO 8601 UTC timestamp. Omit it to begin as soon as possible.
Name
max_amount
Type
integer
Description
Maximum amount you authorize, in the smallest currency unit. It must be at least 1 and cannot exceed your configured ceiling. If omitted, the configured ceiling is used. The final amount can be lower.
Name
reference
Type
string
Required
required
Description
Your reference for matching the payout to your own records. It does not need to be unique.

Request

POST/payouts/schedule

curl https://api.inttegro.com/payouts/schedule \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: payout-apr-15" \
  -d '{
    "destination_id": "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
    "reference": "PAYOUT-APR-15",
    "max_amount": 250000,
    "execute_after": "2030-04-15T09:00:00Z"
  }'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.schedule({
  destinationId: "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
  reference: "PAYOUT-APR-15",
  maxAmount: 250000,
  executeAfter: "2030-04-15T09:00:00Z",
})

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  params := inttegro.SchedulePayoutParams{
    DestinationID: "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
    Reference: "PAYOUT-APR-15",
    MaxAmount: 250000,
    ExecuteAfter: "2030-04-15T09:00:00Z",
  }
  result, err := client.Payouts.Schedule(ctx, params)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.schedule(inttegro.payouts.ScheduleRequest(
  destination_id="fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
  reference="PAYOUT-APR-15",
  max_amount=250000,
  execute_after="2030-04-15T09:00:00Z",
))

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->schedule([
  'destination_id' => 'fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0',
  'reference' => 'PAYOUT-APR-15',
  'max_amount' => 250000,
  'execute_after' => '2030-04-15T09:00:00Z',
]);

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.schedule(
  destination_id: "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
  reference: "PAYOUT-APR-15",
  max_amount: 250000,
  execute_after: "2030-04-15T09:00:00Z"
)

SDK versionv5.2.0

import com.inttegro.Client;
import com.inttegro.payouts.SchedulePayoutParams;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var params = SchedulePayoutParams.builder()
      .destinationId("fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0")
      .reference("PAYOUT-APR-15")
      .maxAmount(250000L)
      .executeAfter("2030-04-15T09:00:00Z")
      .build();
    var result = client.payouts().schedule(params);
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.ScheduleAsync(new {
  destination_id = "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
  reference = "PAYOUT-APR-15",
  max_amount = 250000,
  execute_after = "2030-04-15T09:00:00Z",
});

Response

Object
JSON

SDK versionv8.2.0

PayoutResponse {
  payout: { … },
}

SDK versionv8.2.0

{
  "payout": {
    "id": "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB",
    "destination_id": "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
    "reference": "PAYOUT-APR-15",
    "status": "scheduled",
    "max_amount": { "currency": "ghs", "value": 250000 },
    "execute_after": "2030-04-15T09:00:00Z",
    "scheduled_at": "2030-04-14T18:32:11.000Z",
    "initiated_at": "2030-04-14T18:32:10.000Z"
  }
}

POST/payouts/lookup

Lookup a payout

Check a payout's current status and final transferred amount. Use this after scheduling or while reconciling a payout.

Optional lifecycle timestamps, error, and balance_transactions are omitted until they have values.

Available through MCP

AI clients can use get_payout for this operation. MCP read tools return minimized business data and do not change Inttegro state.

Request attributes

Name
payout_id
Type
string
Required
required
Description
Payout ID returned when the payout was scheduled.

Request

POST/payouts/lookup

curl https://api.inttegro.com/payouts/lookup \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payout_id": "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB"
  }'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.lookup({
  payoutId: "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB",
})

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  result, err := client.Payouts.Lookup(ctx, "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.lookup("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->lookup("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.lookup(payout_id: "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")

SDK versionv5.2.0

import com.inttegro.Client;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var result = client.payouts().lookup("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.LookupAsync("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");

Response

Object
JSON

SDK versionv8.2.0

PayoutResponse {
  payout: { … },
}

SDK versionv8.2.0

{
  "payout": {
    "id": "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB",
    "destination_id": "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
    "max_amount": { "currency": "ghs", "value": 250000 },
    "amount": { "currency": "ghs", "value": 240000 },
    "status": "processing",
    "execute_after": "2030-04-15T09:00:00.000Z",
    "initiated_at": "2030-04-14T18:32:10.000Z",
    "sent_at": "2030-04-15T09:01:05.000Z",
    "balance_transactions": [ … ]
  }
}

POST/payouts/cancel

Cancel a payout

Stop a future payout before processing begins—for example, when the destination or amount ceiling is wrong.

Cancellation works only while the payout is scheduled and execute_after is still in the future. The response returns the payout with status: "canceled" and its canceled_at time.

Request attributes

Name
payout_id
Type
string
Required
required
Description
ID of the scheduled payout to cancel.

Request

POST/payouts/cancel

curl https://api.inttegro.com/payouts/cancel \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: cancel-payout-apr-15" \
  -d '{
    "payout_id": "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB"
  }'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.cancel({
  payoutId: "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB",
})

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  result, err := client.Payouts.Cancel(ctx, "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.cancel("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->cancel("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.cancel(payout_id: "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB")

SDK versionv5.2.0

import com.inttegro.Client;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var result = client.payouts().cancel("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.CancelAsync("po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB");

Response

Object
JSON

SDK versionv8.2.0

PayoutResponse {
  payout: { … },
}

SDK versionv8.2.0

{
  "payout": {
    "id": "po_yQ2wXm5Dc7Pk9Ls1Vn0RgHaB",
    "destination_id": "fa_Q90wZdd2P7W8hJ1cN9Mx4Rk5sVWBvY3L6pTz8q0",
    "status": "canceled",
    "initiated_by": "app",
    "initiated_at": "2030-04-14T18:32:10.000Z",
    "execute_after": "2030-04-15T09:00:00Z",
    "scheduled_at": "2030-04-14T18:32:11.000Z",
    "canceled_at": "2030-04-14T20:15:44.000Z",
    "max_amount": { "currency": "ghs", "value": 250000 }
  }
}

POST/payouts/settings

Get payout settings

See whether payouts are automatic or manual and which financial account receives each currency. Send an empty JSON object; destinations is always present and can be empty.

If no schedule exists yet, Inttegro applies the default automatic schedule. Configure a destination before relying on automatic payouts. See Understand payout settings for the schedule fields.

Available through MCP

AI clients can use get_payout_settings for this operation. MCP read tools return minimized business data and do not change Inttegro state.

Request

POST/payouts/settings

curl https://api.inttegro.com/payouts/settings \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.settings()

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  result, err := client.Payouts.Settings(ctx)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.settings()

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->settings();

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.settings

SDK versionv5.2.0

import com.inttegro.Client;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var result = client.payouts().settings();
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.SettingsAsync();

Response

Object
JSON

SDK versionv8.2.0

SettingsResponse {
  settings: { … },
}

SDK versionv8.2.0

{
  "settings": {
    "schedule": { … },
    "destinations": { … }
  }
}

POST/payouts/set_destinations

Set payout destinations

Choose the financial account that receives your GHS payouts. Use this when you first set up settlements, switch the receiving account, or intentionally stop routing payouts to an account.

To remove a destination, send an empty string for ghs. Currency keys you omit keep their existing values.

Rules

Each currency key must be supported (currently ghs—see studio.inttegro.com/specs/currencies for the complete list).
The financial account must be active, connected, and have push capability enabled.
Its currency must match the map key. A ghs destination must be denominated in GHS.
Supported destinations are mobile money wallets and complete Ghana bank accounts.

Request attributes

destinationsobjectrequiredClick or tap to expand
Map of currency codes (lowercase) to financial account IDs. Pass an empty string as the value to clear a currency's destination.

Request

POST/payouts/set_destinations

curl https://api.inttegro.com/payouts/set_destinations \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: set-ghs-destination-001" \
  -d '{
    "destinations": {
      "ghs": "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo"
    }
  }'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.setDestinations({
  destinations: {
    ghs: "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo",
  },
})

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  destinations := map[string]string{
  "ghs": "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo",
}
  result, err := client.Payouts.SetDestinations(ctx, destinations)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.set_destinations(inttegro.payouts.DestinationsRequest(
  destinations={
    "ghs": "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo",
  },
))

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->setDestinations([
  'ghs' => 'fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo',
]);

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.set_destinations(
  destinations: {
    ghs: "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo",
  }
)

SDK versionv5.2.0

import com.inttegro.Client;
import java.util.Map;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    Map<String, String> destinations = Map.<String, String>ofEntries(
        Map.entry("ghs", "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo")
      );
    var result = client.payouts().setDestinations(destinations);
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.SetDestinationsAsync(new {
  ghs = "fa_H3cNv7pQf9WbLt2mJs6yXrPq4Kz1Vd5G0aEiUo",
});

Response

Object
JSON

SDK versionv8.2.0

SettingsResponse {
  settings: { … },
}

SDK versionv8.2.0

{
  "settings": {
    "schedule": { … },
    "destinations": { … }
  }
}

POST/payouts/disable

Disable automatic payouts

Switch to manual payouts. Inttegro stops creating new automatic payouts, but payouts that are already scheduled continue normally.

Your destinations do not change. You can still schedule a payout yourself or enable automatic payouts again later.

Request

POST/payouts/disable

curl https://api.inttegro.com/payouts/disable \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: automatic-payouts-off-001" \
  -d '{}'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.disableAutomatic()

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  result, err := client.Payouts.DisableAutomatic(ctx)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.disable_automatic()

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->disableAutomatic();

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.disable_automatic

SDK versionv5.2.0

import com.inttegro.Client;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var result = client.payouts().disableAutomatic();
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.DisableAutomaticAsync();

Response

Object
JSON

SDK versionv8.2.0

SettingsResponse {
  settings: { … },
}

SDK versionv8.2.0

{
  "settings": {
    "schedule": { … },
    "destinations": { … }
  }
}

POST/payouts/enable

Enable automatic payouts

Resume automatic weekly payouts for eligible funds. Your existing destinations remain unchanged, so make sure each currency has a valid destination before enabling the schedule.

Payouts that are already scheduled continue normally.

Request

POST/payouts/enable

curl https://api.inttegro.com/payouts/enable \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: automatic-payouts-on-001" \
  -d '{}'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.enableAutomatic()

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  result, err := client.Payouts.EnableAutomatic(ctx)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.enable_automatic()

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->enableAutomatic();

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.enable_automatic

SDK versionv5.2.0

import com.inttegro.Client;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var result = client.payouts().enableAutomatic();
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.EnableAutomaticAsync();

Response

Object
JSON

SDK versionv8.2.0

SettingsResponse {
  settings: { … },
}

SDK versionv8.2.0

{
  "settings": {
    "schedule": { … },
    "destinations": { … }
  }
}

POST/payouts/page

Page through payouts

Browse payouts from newest to oldest. Use this for settlement history and reconciliation; use Lookup a payout when you already know the payout ID.

Available through MCP

AI clients can use list_payouts for this operation. MCP read tools return minimized business data and do not change Inttegro state.

Request attributes

Name
page_number
Type
integer
Required
required
Description
1-based page index to fetch. Must be between 1 and 10 inclusive.
Name
page_size
Type
integer
Description
Number of payouts per page (1–256). Defaults to 256 when omitted.

Response shape

The response contains number, the number of results in size, and a payouts array when the page is not empty. Every entry uses the payout object.

Request

POST/payouts/page

curl https://api.inttegro.com/payouts/page \
  -H "Authorization: Bearer $INTTEGRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "page_number": 1,
    "page_size": 25
  }'

SDK versionv8.2.0

import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.payouts.page({
  pageNumber: 1,
  pageSize: 25,
})

SDK versionv4.4.0

package main

import (
  "context"
  "log"
  "os"

  inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)

func main() {
  ctx := context.Background()
  client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))

  params := inttegro.PayoutPageParams{
    PageNumber: 1,
    PageSize: 25,
  }
  result, err := client.Payouts.Page(ctx, params)
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

SDK versionv6.2.0

import os
import inttegro

client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.payouts.page(inttegro.payouts.PageRequest(
  page_number=1,
  page_size=25,
))

SDK versionv5.3.0

<?php

use Inttegro\Client;

$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->payouts->page([
  'page_number' => 1,
  'page_size' => 25,
]);

SDK versionv4.3.0

require "inttegro"

client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.payouts.page(
  page_number: 1,
  page_size: 25
)

SDK versionv5.2.0

import com.inttegro.Client;
import com.inttegro.payouts.PayoutPageParams;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = new Client(System.getenv("INTTEGRO_API_KEY"));
    var params = PayoutPageParams.builder()
      .pageNumber(1)
      .pageSize(25)
      .build();
    var result = client.payouts().page(params);
  }
}

SDK versionv6.2.0

using Inttegro;

using var inttegro = new InttegroClient(
    Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Payouts.PageAsync(new {
  page_number = 1,
  page_size = 25,
});

Response

Object
JSON

SDK versionv8.2.0

PageResponse {
  page: { … },
}

SDK versionv8.2.0

{
  "page": {
    "number": 1,
    "size": 2,
    "payouts": [ … ]
  }
}

Payout settings responses

Get payout settings returns the complete configuration. Endpoints that change payout settings return the fields they updated, using a slightly different schedule shape with public schedule and specification IDs.

Settings lookup response

settingsobjectComplete payout settings returned by Get payout settings.Click or tap to expand
- Name
  destinations
  Type
  object
  Required
  required
  View destinations detailsClick or tap to expand
  Currency-to-financial-account map. Always present and may be empty.
- Name
  fx_enabled
  Type
  boolean
  Description
  Present when foreign exchange payouts are enabled.
- Name
  schedule
  Type
  object
  View schedule attributesClick or tap to expand
  Active payout schedule, when available.
  Name
  aging_spec
  Type
  object
  Required
  required
  View aging_spec attributesClick or tap to expand
  Rules that determine when funds become eligible.
  Name
  abide
  Type
  string
  Required
  required
  Description
  How strictly the aging period is applied.
  Name
  label
  Type
  string
  Required
  required
  Description
  Human-readable aging rule label.
  Name
  t_plus
  Type
  string
  Required
  required
  Description
  Required transaction age, such as 168h.
  Name
  description
  Type
  string
  Required
  required
  Description
  Human-readable schedule description.
  Name
  interval
  Type
  string
  Required
  required
  Description
  Schedule frequency.
  Name
  name
  Type
  string
  Required
  required
  Description
  Schedule name.
  Name
  schedule_on
  Type
  string
  Required
  required
  Description
  When payouts run within the interval.
  Name
  type
  Type
  string
  Required
  required
  Description
  Schedule type.

Settings mutation response

settingsobjectPayout settings fields returned after a settings change.Click or tap to expand
- Name
  destinations
  Type
  object
  View destinations detailsClick or tap to expand
  Updated currency-to-financial-account map.
- Name
  id
  Type
  string
  Description
  Payout settings identifier.
- Name
  schedule
  Type
  object
  View schedule attributesClick or tap to expand
  Updated payout schedule.
  Name
  description
  Type
  string
  Required
  required
  Description
  Human-readable schedule description.
  Name
  id
  Type
  string
  Required
  required
  Description
  Schedule identifier.
  Name
  interval
  Type
  string
  Required
  required
  Description
  Schedule frequency.
  Name
  name
  Type
  string
  Required
  required
  Description
  Schedule name.
  Name
  schedule_on
  Type
  string
  Required
  required
  Description
  When payouts run within the interval.
  Name
  spec
  Type
  object
  Required
  required
  View spec attributesClick or tap to expand
  Rules that determine when funds become eligible.
  Name
  abide
  Type
  string
  Required
  required
  Description
  How strictly the aging period is applied.
  Name
  id
  Type
  string
  Required
  required
  Description
  Schedule specification identifier.
  Name
  label
  Type
  string
  Required
  required
  Description
  Human-readable aging rule label.
  Name
  t_plus
  Type
  string
  Required
  required
  Description
  Required transaction age, such as 168h.
  Name
  type
  Type
  string
  Required
  required
  Description
  Schedule type.

Connect a financial account - Add the bank account or mobile money wallet that will receive funds.
Enable push capability - Allow a connected account to receive payouts.
Retrieve your balance - Check funds available for payout.
Page through balance transactions - Reconcile the ledger entries included in a payout.

The payout object

Properties​

Schedule a payout

Request attributes​

Request

Response

Lookup a payout

Request attributes​

Request

Response

Cancel a payout

Request attributes​

Request

Response

Get payout settings

Request

Response

Set payout destinations

Rules​

Request attributes​

Request

Response

Disable automatic payouts

Request

Response

Enable automatic payouts

Request

Response

Page through payouts

Request attributes​

Response shape​

Request

Response

Payout settings responses

Settings lookup response​

Settings mutation response​

Related resources

Properties

Request attributes

Request attributes

Request attributes

Rules

Request attributes

Request attributes

Response shape

Settings lookup response

Settings mutation response