APG PayAPG Paydocs

Customers

Create organisation prospects

POST/organisation-prospects

Check a business, or accept one of its owners and create the customer. The token decides which step you are on, and it is the credential for both: neither asks for a permission.

2 actionsOprosCmdAcceptOwnerOprosCmdCheckBusiness

Permissions

Required permission

Required action depends on the request variant. Select a variant in the request body below to see the permission it requires.

Request body

This body is a typed union. Pick a variant to see its fields, the permission it requires, and a matching example.

Discriminated by type
type = "OprosCmdAcceptOwner"
Required permission
Anchored to the presented token

Accept an owner and create the customer on its prospect token

merchantIdMchtIdrequired

The merchant the prospect is becoming a customer of. Named rather than inferred, see the note on the command.

Example mcht_9f2Kd8QpLzXw

prospectTokenstringrequired

The token from the check. It is the credential for this step.

Example tok_9f2Kd8QpLzXwR4mN

ownerIndexinteger (int64)required

The owner's position in the owners list of the check's response, counting from zero.

Example 1250

curl -X POST https://api.tst.au.apgpay.dev/organisation-prospects \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "OprosCmdAcceptOwner",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "prospectToken": "tok_9f2Kd8QpLzXwR4mN",
  "ownerIndex": 1250
}'

Responses

The response is a typed union.

Discriminated by type
type = "OprosRspBusinessFound"

What the business registry said about the business. The registry's own words, passed through.

prospectTokenstringrequired

Carry this into the next step. It now also holds what the check established.

Example tok_9f2Kd8QpLzXwR4mN

Example
{
  "type": "OprosRspBusinessFound",
  "business": {
    "type": "OprosBusinessAttributes",
    "businessIdentifier": {
      "type": "OprosBusinessIdentifierAbn",
      "abn": "string"
    },
    "acn": "string",
    "businessName": "Ada Lovelace",
    "status": "Active",
    "dateRegistered": "string",
    "businessType": "string",
    "businessAddress": {
      "type": "MchtAddressAttributes",
      "unitNumber": "string",
      "streetNumber": "string",
      "streetName": "Ada Lovelace",
      "streetType": "string",
      "suburb": "string",
      "city": "string",
      "state": "string",
      "postalCode": "3000",
      "country": "AU"
    },
    "owners": [
      {
        "type": "PersonAttributes",
        "givenName": "Ada Lovelace",
        "middleName": "Ada Lovelace",
        "familyName": "Ada Lovelace",
        "dateOfBirth": "2026-08-19",
        "address": {
          "type": "MchtAddressAttributes",
          "unitNumber": "string",
          "streetNumber": "string",
          "streetName": "Ada Lovelace",
          "streetType": "string",
          "suburb": "string",
          "city": "string",
          "state": "string",
          "postalCode": "3000",
          "country": "AU"
        }
      }
    ],
    "delegateEmailAddress": "ada@example.com"
  },
  "prospectToken": "tok_9f2Kd8QpLzXwR4mN"
}

Error responses