We allow merchants to use a pool of pre-registered PayIDs that will ensure timely allocation of a PayID to your customer's account when registering or signing up.

Initial Setup

We will require the following information to enable the PayID feature:

• Full legal entity name
  • e.g. Spaceships Pty Ltd
• PayID alias name that customers will see when they enter the supplied PayID
  • e.g. Spaceships Australia
• A legally owned domain that will be used after the @ in the PayID email address
  • e.g. pay.spaceships.com.au

We will notify you once we have created a PayID pool configuration for your account.

PayID pool status

Now that the domain you wish to use for your PayID pool has been configured, we will begin creating PayIDs until the pool has been filled with the configured amount.

You can check the status of a PayID pool by querying the bank accounts API resource. Float accounts with an associated PayID pool configuration will indicate the pool size and state.

Assigning pooled PayIDs to users as they sign up

Now that you have your pool of PayIDs ready to use when your customers register for an account on your end, you can submit an API request to contacts/receivable with the payid_email_domain parameter to create a new contact using the pooled PayID strategy.

Endpoint: POST /contacts/receivable

{
  "name": "Jack Karlson",
  "email": "[email protected]",
  "payid_email_domain": "pay.spaceships.com.au"
}

{
    "data": {
        "id": "f96426bf-c84b-4bc4-b7bd-ea84128b8141",
        "ref": "CNT.7314",
        "name": "Jack Karlson",
        "email": "[email protected]",
        "type": "anyone",
        "metadata": {},
        "bank_account": {
            "id": "8e4a7bb5-ec16-4311-a4ed-cb6d7903ad3f",
            "account_number": "1752092",
            "branch_code": "802919",
            "bank_name": "Zepto Float Account",
            "state": "active",
            "iav_provider": null,
            "iav_status": null,
            "blocks": {
                "debits_blocked": false,
                "credits_blocked": false
            }
        },
        "anyone_account": {
            "id": "bf250c2c-b54d-4355-a90d-7fd36a7771af"
        },
        "payid_details": {
            "alias_value": "[email protected]",
            "alias_type": "email",
            "alias_name": "vishakha_payid",
            "state": "active"
        }
    }
}

Note: A webhook is not sent when a Pooled PayID is assigned to a contact. If you do not receive a response from our API, we suggest reconciling against our list contacts endpoint to obtain the PayID details.

PayID pool top-up

Since one of your pre-registered pooled PayIDs has just been assigned to a customer, our system will create a new PayID to top-up the pool.

Receiving Inbound Payments

Now that you have associated a PayID with your customer internally and shared this PayID with the customer, they are now able to make payments to the assigned PayID and you'll need to be notified and reconcile received payments.