​
What PPA mode is

PPA mode (Platform Partner Agreement) lets you provision resources and move money under GOAT Finance’s regulated entity, rather than under your own Balansas business. It is opt-in per request through an umbrellaLinkId field that several create endpoints accept.
ModeHowRegulated relationship
Direct modeOmit umbrellaLinkIdYour own Balansas business, provisioned 1:1 with the underlying banking provider. This is the default.
PPA modeInclude umbrellaLinkIdThe GOAT Finance master business identified by the link. You keep operational visibility (balances, transactions, webhooks) scoped to your customer.

​
Where it applies

The same umbrellaLinkId threads through the resources you create. When you operate in PPA mode, related resources must live under the same link:
  • End users — onboard the end user under a Balansas-managed master business.
  • Accounts — open fiat/virtual accounts under the link.
  • Payees — register payees under the link.
  • Wallets — bind a wallet to the link.
  • Payments — the source account and (for external payments) the payee must already exist under the same link.

​
Applying it

Include the umbrellaLinkId (a UUID) on the create request. Omit it for direct mode — you never need to send one if you are not using PPA mode. 
{
  "umbrellaLinkId": "550e8400-e29b-41d4-a716-446655440000"
}
Whether PPA mode is available to you, and which link IDs you may use, is configured by Balansas operations as part of onboarding under your Platform Partner Agreement. If you do not have an umbrellaLinkId, you do not need to send one.