APG PayAPG Paydocs

API reference

Parties

7 endpoints

An organisation is a business's legal record: its registration, its registered office, how it is reached, who owns it and the documents it is evidenced by. It is shared: a merchant, an organisation customer and an owner that are the same business in one enterprise are one organisation, and each names it by organisationId.

A caller reads the organisations of its own scope: a merchant its own, its customers' and every owner reached from either; a marketplace its merchants' and its own settings'; an enterprise every one in it. One outside the scope reads as not found. Customer and delegate sign-ins read none.

Only the contact can be changed here, and it is replaced whole. The registration and the owners follow the merchant, customer or verification that states them. Because every tenant reading an organisation sees its contact, a merchant changes only its own organisation's and a marketplace only its merchants' and its settings'; an enterprise changes any in it. A change to any other organisation reads as not found.

A merchant, an organisation customer or a loan facility may be created as an organisation you read here, by its organisationId, instead of from business details; a merchant or an organisation customer may be moved to another the same way, with MchtUpdateOrganisation or CustUpdateOrganisation.