Home
API Reference

Create a Lead (Retailer)

post
https://api.tap.company/v3/lead/

This API must be used to create a lead for the Retailers (Sub Accounts under the marketplace). This API will create a lead ID only which you have to convert it to be an account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
segment
object
required

The segment of the lead.

string
required
Defaults to SA

The country code in iso-2 format, the country must be the same country of the marketplace account since Tap can not split the payment across the countries.

brand
object
required

The brand details of the retailer account.

entity
object
required

The entity details of the retailer account.

users
array of objects
required

List of the users linked to the account

users*
wallet
object
required

The wallet details of the retailer account.

marketplace
object
required

The object that define the marketplace details.

post
object

the webhook to receive the lead creation response

Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago