Add a Receivable Contact

Receive funds from a Contact by allowing them to pay to a personalised PayID or account number. Perfect for reconciling incoming funds to a customer, receiving funds instantly, eliminating human error & improving your customer's experience.

To enable this feature, please contact our support team with the following information:

Your full legal business name

A legally owned domain name: for your PayID email addresses

alias_name: the business name that will be displayed to your customers upon PayID resolution. We suggest using a shortened name appropriate for mobile displays

There are two strategies supported for PayID assignment when creating this type of Contact:

On-demand PayID: provide a payid_email and we'll create a contact and register a PayID with the given email address. The PayID registration process happens when the request is received. The initial response for payid_details.state will always be pending. It will transition to active when the PayID registration process is complete. This can take up to a few seconds. You can use webhooks to be informed of this state change.

Pooled PayID: provide your payid_email_domain and we'll create a contact and assign them a PayID from your pool. Pooled PayIDs are pre-registered. The PayID email value is generated using a random value and the email domain from your PayID pool configuration. Providing both payid_email and payid_email_domain will ignore your pool and use the "On-demand PayID" strategy instead.

While unlikely, it is possible that we will be unable to register the given PayID. In this case payid_details.state will transition to failed.

You can simulate this path in sandbox by adding +failure to your payid_email e.g [email protected]

You can test receiving payments to a Receivable Contact in our sandbox environment using the PayID simulation endpoint.