[AU] Invite a Contact

Invite a party to be added to your contact list once they have instantly verified their bank account

Updated over a week ago

Note: This article is relevant to merchants integrating with Zepto in Australia.

Before you can pay anyone, you must ensure that they're part of your contacts list on the Zepto dashboard. There are two ways you can add a new contact:

  • Manually Enter Bank Details

  • Invite a contact via the link

This article covers the Invite a contact method. This method is especially useful to ensure with 100% accuracy that the contact has supplied a valid BSB & account number.

Follow the below steps

  1. Sign in to your Zepto dashboard

  2. Click Contacts from the side menu

  3. Click on the Invite via the link button

  4. Optionally configure what the Contact invitation page will look like by clicking on the + Optional Settings link and modifying the values

  5. Click on the Copy button next to the generated link

  6. You can now share the link or embed it in an iframe. Whatever suits your use case.

The person visiting the link will be taken through our Instant Account Verification process to ensure the bank details used to create the contact are accurate and correct.

Once another party completes the invitation, you will find them added to your contact list.

For developers

In short, the entire process is customisable via the generated URL which looks like this:


https://go{.sandbox}.split.cash/invite_contact/{account_nickname} 

From there, you can append a series of query string parameters to customise the experience. The best way to familiarise yourself with these options is to first use the UI as described in step 4 at the top of this article.

Events

When the invitation form is submitted, there are 2 possible outcomes:

  1. Successful submission

  2. Failed submission

Successful submission
The user will be redirected to either the Zepto success page or your supplied success URL. An contact_id  representing the ID of the newly created Contact will be appended to your nominated success URL.

For example, if you supplied a success_url with http://www.example.com/success?customer_id=1234 . On success, the URL would become:

http://www.example.com/success?contact_id=d1fde769-180f-456f-a04b-fc573f961118&customer_id=1234 

Failure submission
The user will be redirected to either the Zepto failure page or your supplied failure URL. An errors key representing the failure reason will be appended to your nominated failure URL.

For example, if you supplied a failure_url with http://www.example.com/failed?customer_id=1234 . On failure, the URL would become:

http://www.example.com/failed?errors=contact.name_too_long&customer_id=1234 

I hope this article has helped, feel free to reach out to us by clicking on the green bubble icon or email us directly at support@zepto.com.au

Did this answer your question?