Managing platforms

How managing platforms work

Run payments for your clients without building a second integration. A managing platform makes the same API calls as any other company. What changes is whose account each call acts for.

Most companies integrate to pay their own recipients from their own account. A managing platform does that work for other companies: its clients. Each client company keeps its own Xtrm account, wallets, recipients and records, and you run its batch payments for it.

You work on a client company's behalf in two ways:

  • Pseudo credentials let you act as the client company. With them, you can make every call the company could make with its own keys, from funding its wallet to paying its recipients.
  • Connections let one account manage more for another. You're connected to your client companies, and each client company is connected to the recipients it creates. Some calls name both accounts: the company making the call, and the connected account it acts on.

#Who's who

TermMeans
Managing platformYour company, once Xtrm has approved it as a manager. You run payments for other companies.
Client companyA company you run payments for. It has its own SPN account, wallets and recipients, and its wallet funds its batches. The example client company in these docs is Contoso Ltd, SPN7777555.
RecipientA person or business a client company pays: individual recipients (PAT…) and business recipients (SPN…).
ConnectionThe link that lets one account manage more for another. See Connections and manager services.
Manager servicesWhat your company can do for a connected company in the Xtrm web app, such as upload its identity documents or get its API credentials. Xtrm turns them on for your company. See Manager services.
Pseudo credentialsA client company's API credentials, issued to your company. They require manager services. See Pseudo credentials.

#Paying for yourself or for client companies

The API calls are the same on both paths. These are the differences:

Paying from your own accountPaying for a client company
CredentialsYour API credentialsThe client company's pseudo credentials
IssuerAccountNumberYour company's SPNThe client company's SPN
The wallet that pays (SourceWalletId)One of your walletsOne of the client company's wallets
Before the first paymentYour company is onboarded and approved, with its documents uploaded in the web appYou're approved as a manager with manager services turned on, you're connected to the client company, and the client company is onboarded and approved, with its documents uploaded in the web app
WebhooksOne endpoint for your companyOne endpoint per client company

Everything else on this site applies to both paths. Where a page says "your company", read it as the company your credentials belong to: with pseudo credentials, that's the client company.

#Act as the client company

With a client company's pseudo credentials, you request an access token from the same /oAuth/token endpoint as with your own credentials and send the client company's SPN in IssuerAccountNumber. Every call then acts for that company: its wallets, its recipients, its batches. Each token acts for exactly one company. Pseudo credentials covers where to get them, the token request and running many client companies side by side.

#Work with connected accounts

Some calls act on a second account besides the one in IssuerAccountNumber, such as LinkBankBeneficiary, which links a bank account for the recipient in UserID. With pseudo credentials, IssuerAccountNumber is the client company's SPN, and the recipient has to be connected to the client company.

Recipients you create with a client company's pseudo credentials are connected to the client company and to your platform. Connections and manager services owns the rest: how accounts become connected, what a connection allows in the API and in the web app, and what manager services add.

#Before a client company can pay

A client company can make batch payments once all of these are true:

  1. Xtrm has approved your company as a manager and turned on the manager services you need, including Get API Credentials for the client company's pseudo credentials and, if you upload its documents for it, Identity Documents.
  2. You're connected to the client company.
  3. The client company is fully onboarded: its Identity profile is complete, so its identity verification level (IDL) is 100%, which the API reports as AccountIdentityLevel Advanced, and its advanced profile is submitted. Reaching 100% includes its documents: a government-issued photo ID for its administrator and, for a private company, a company tax document such as a W-9 for a US company. No API call uploads documents, so this step isn't API-only: your platform uploads them in the Xtrm web app as a manager service, or the client company uploads them from its own account.
  4. Xtrm has approved the advanced profile, which unlocks funding for the client company's account. The review usually takes 1 to 2 days for a US-only profile and 5 to 7 days for an international one.

Onboard a client company walks through each step, from manager approval to the client company's first batch.

#Next steps