Onboarding Retailers (For Split Payments)

The structure of Tap's Marketplace model is built on Retailers, each Retailer under your Marketplace should have a retailer.id. This page guides you through creating a [retailer.id] by onboarding your Retailers to split the payments with Them.

📘

For onboarding steps described on this page, you need to use the Marketplace Keys provided by Tap.

Step 1: Uploading KYC documents

Before you begin, you need to upload the required documents for the KYC and get the file.id of each file to be able to attach the file in the Lead API to create a retailer.

You need to provide the required KYC documents, in order to get approval for the created Retailer's account. The minimum KYC requirements depend on the entity type and the country of the Business. You are able to get the KYC requirements from your Account Manager or from [email protected].

For each document, you need to make a File API request. You'll receive a file.id for each file you upload, which you'll use in creating a business.

curl --location --request POST 'https://api.tap.company/v2/files' \
--header 'Authorization: Bearer sk_test_BPmcTgEfuK1dHslMaLGY42Ry' \
--header 'Content-Type: multipart/form-data' \
--header 'content-type: multipart/form-data' \
--form 'file=""' \
--form 'purpose="commercial_registration"' \
--form 'title="Commercial License "' \
--form 'expires_at="1913743462"' \
--form 'file_link_create="true"'

{
  "id": "file_641212279714869248",
  "object": "file",
  "live_mode": false,
  "api_version": "1.0",
  "feature_version": "1.0",
  "created": 1572947320,
  "filename": "8801760e0a28ae2105e4ada503e30b8c.jpg",
  "purpose": "commercial_registration",
  "size": 346827,
  "title": "test",
  "type": "jpg",
  "url": "/files/file_641212279714869248",
  "links": [
    {
      "id": "link_641212281036075008",
      "object": "file_link",
      "live_mode": true,
      "api_version": "1.0",
      "feature_version": "1.0",
      "created": 1572947320,
      "expired": false,
      "expires_at": 1234567,
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "url": "/links/fl_test_641212281036075009"
    }
  ]
}

Step 2: Creating a Retailer Lead

After uploading all KYC documents, you need to make a Retailer Leadrequest in order to generate alead .id` for the Retailer.

Step 3: Convert the Lead ID to a Retailer ID

After you got the lead.id you have to call the create account API with your marketplace API keys in the header. Here is the curl request of the create account API:

curl --location 'https://api.tap.company/v3/connect/account' \
--header 'Authorization: Bearer sk_live_marketplace_key' \
--header 'Content-Type: application/json' \
--data '{
    "lead_id": "led_123456789"
   
}'

Retailer account approval

The KYC verification process will be carried out by our team prior to the account approval. If any required KYC document is missing, or more information is need, our team will reach out to you.