We now 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.

This article will allow you to understand how this can be achieved in detail. The article outlines:

  1. Initial setup

  2. PayID pool status

  3. Assigning pooled PayIDs to users as they sign up

  4. Receiving Inbound Payments

Initial setup

First, we will need to configure a domain for your PayID pool. In order to do so, you will need to provide us with the following information. You can send these over to us however you wish, although an easy way to do this is via our in-app chatbox.

Information required to configure a PayID pool:

  • 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

  • Number of PayIDs to maintain in the pool (maximum of 100,000).

  • Example PayID email addresses to ensure relevance to end customers
    - e.g. elon11223344@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

  • Assign pooled PayID to your customer

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

Request Payload:

{
"name": "pooled payid test",
"email": "pooledpayid@spacemail.com",
"payid_email_domain": "pay.spaceships.com.au",
"payid_name": "Elon"
}

Response [201]:

{
"data": {
"id": "f96426bf-c84b-4bc4-b7bd-ea84128b8141",
"ref": "CNT.7314",
"name": "pooled payid test",
"email": "pooledpayid@spacemail.com",
"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": "1095eb60@pay.spaceships.com.au",
"alias_type": "email",
"alias_name": "vishakha_payid",
"state": "active"
}
}
}

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. This process is explained in detail here.

Feel free to reach out if you have further questions by emailing us directly at support@zepto.com.au or clicking on the blue bubble icon from the corner of the screen.

Did this answer your question?