Skip to main content

Children policies

A children policy defines the operating choices an app may grant to its child apps. It is an authority boundary, not the configuration applied to a child: the children policy lists permitted values and ranges, while an operating policy selects concrete values from within those constraints.

Note

This feature is available to selected accounts during private beta.

How children policies govern child apps

The app's active children policy governs the reusable operating policies and inline configurations it can apply while creating a child. Inttegro validates the concrete operating configuration against the parent's latest active children policy before saving an immutable snapshot for the child app. The application relationship is not returned on the children-policy object.

Children policies use immutable versions. id is stable across versions, version identifies the returned record, and active_version identifies the version currently governing new policy decisions. Look up a children policy version by number, or omit version to return the latest active version. Page children policy versions returns the complete history newest first.

Each capability expresses authority differently from an operating policy:

  • Payment currencies are the currency values a child configuration may select.
  • Payment and payout amount limits are inclusive ranges in minor currency units.
  • Payout enabled values list whether enabled, disabled, or both are permitted.
  • Payout balance-transaction aging entries include the platform-owned public identifier and its resolved t_plus duration.
  • Payment-method enabled and confirms_use values list the booleans that an operating policy may select.

The children policy object

Properties​

TypeScript SDK responseChildrenPolicyv14.1.1
  • Name
    activeVersion
    Type
    number
    Description

    Latest active version of this policy.

  • capabilitiesChildrenPolicyCapabilitiesClick or tap to expand

    Permitted payment, payout, and payment-method options for child operating configurations. At least one capability group is present.

  • Name
    createdAt
    Type
    Date
    Description

    When version one of the policy was created.

  • Name
    description
    Type
    string
    Description

    Optional explanation of the authority granted by the policy.

  • Name
    id
    Type
    string
    Description

    Stable policy identifier beginning with cp_.

  • Name
    name
    Type
    string
    Description

    Human-readable policy name.

  • Name
    updatedAt
    Type
    Date
    Description

    When the active version last changed.

  • Name
    version
    Type
    number
    Description

    Immutable version represented by this object.

  • Name
    versionCreatedAt
    Type
    Date
    Description

    When this exact immutable version was created.

Capability properties​

TypeScript SDK responseChildrenPolicyv14.1.1
  • paymentMethodsChildrenPolicyPaymentMethodsCapabilitiesClick or tap to expand

    Optional settings authority for each supported payment method. Each included method has confirms_use and enabled arrays containing its permitted boolean values.

  • paymentsChildrenPolicyPaymentsCapabilitiesClick or tap to expand

    Optional payment authority. currencies contains unique lowercase three-letter currency codes. limits.amount.max and limits.amount.min define the inclusive minor-unit range.

  • payoutsChildrenPolicyPayoutsCapabilitiesClick or tap to expand

    Optional payout authority. bt_aging_spec lists the permitted platform aging specifications, enabled lists permitted boolean values, and limits.amount defines the inclusive minor-unit range.

POST/children_policies/lookup

Look up a children policy version

Returns one children policy version. Omit version to return the latest active version.

Request body​

TypeScript SDK responsev14.1.1
  • Name
    version
    Type
    number
    Description

    Immutable version to return. Must be at least 1. Omit it to return the latest active version.

Response​

The response contains the requested policy version in children_policy.

Request

POST/children_policies/lookup
SDK versionv14.1.1
import { InttegroClient } from '@inttegro/inttegro-sdk'

const apiKey = process.env.INTTEGRO_API_KEY
if (!apiKey) throw new Error('INTTEGRO_API_KEY is required')

const inttegro = new InttegroClient({ apiKey })
const childrenPolicy = await inttegro.childrenPolicies.lookup({ version: 2 })

Response

SDK versionv14.1.1
ChildrenPolicyResponse {
childrenPolicy: { … },
}

Errors​

  • 400 Bad Request — The lookup request is malformed, or version is less than 1.
  • 401 Unauthorized — Authentication is missing or invalid.
  • 403 Forbidden — This feature is not available to the account.
  • 404 Not Found — No children policy exists at the requested version.
  • 422 Unprocessable Entity — The request is invalid for this operation.
  • 503 Service Unavailable — Policy validation or storage is temporarily unavailable. Retry with backoff.
POST/children_policies/page

Page children policy versions

Returns immutable children policy versions newest first.

Request body​

TypeScript SDK responsev14.1.1
  • Name
    number
    Type
    number
    Description

    1-based page number. Defaults to 1.

  • Name
    size
    Type
    number
    Description

    Number of versions per page. Defaults to 20 and cannot exceed 100.

Response​

The response contains pagination metadata and complete children policy objects in page.

TypeScript SDK responsev14.1.1
  • Name
    count
    Type
    number
    Description

    Number of versions returned on this page.

  • Name
    hasMore
    Type
    boolean
    Description

    Whether another page of older versions is available.

  • Name
    number
    Type
    number
    Description

    Current 1-based page number.

  • Name
    size
    Type
    number
    Description

    Requested page size.

  • Name
    total
    Type
    number
    Description

    Total number of immutable versions.

  • Name
    versions
    Type
    unknown[]
    Description

    Full children policy objects, ordered newest first.

Request

POST/children_policies/page
SDK versionv14.1.1
import { InttegroClient } from '@inttegro/inttegro-sdk'

const apiKey = process.env.INTTEGRO_API_KEY
if (!apiKey) throw new Error('INTTEGRO_API_KEY is required')

const inttegro = new InttegroClient({ apiKey })
const page = await inttegro.childrenPolicies.page({ number: 1, size: 2 })

Response

SDK versionv14.1.1
PageResponse {
page: { … },
}

Errors​

  • 400 Bad Request — number or size is outside the accepted range, or the request contains unsupported attributes.
  • 401 Unauthorized — Authentication is missing or invalid.
  • 403 Forbidden — This feature is not available to the account.
  • 404 Not Found — No children policy is available.
  • 422 Unprocessable Entity — The versions cannot be returned for this operation.
  • 503 Service Unavailable — Policy storage is temporarily unavailable. Retry with backoff.
  • Operating policies — Select concrete child settings, create reusable policies, and assign them to apps.
  • Create an app — Create a child app under a parent operating boundary.
  • Lookup an app — Retrieve an app and its operating-policy snapshot.