Partner Workflows

This page outlines common Partner workflows.

Merchant Setup

Create Merchant -> Create Users -> Create API Keys

TIP

All three steps can be completed in one API call when creating a new Merchant.

To generate API keys for the admin user, include one or both of the following key/value pairs in the user object:

create_api_key -> true

create_pub_api_key -> true

Example

{
  "name": "",
  "description": "",
  "status": "active",
  "website": "customerfacilitate.io",
  "phone": "7403270078",
  "receipt_email": "testmerchant@fluidpay.com",
  "fee_schedule_id": "%s",
  "timezone": "UTC",
  "billing_contact": {
    ...
  },
  "primary_contact": {
    ...
  },
  "limits": {
    "sale": {
      "single": 0,
      "daily": 0,
      "monthly": 0
    },
    "credit": {
      "single": 0,
      "daily": 0,
      "monthly": 0
    }
  },
  "user": {
    ...
    "create_api_key": true, // should we create a private api key and return it to you during merchant creation
    "create_pub_api_key": true // should we create a public api key and return it to you during merchant creation
  },
  "accept_tos": true
}

1. Create Merchant

To create a new merchant, see Create New Merchant.

Note: You will need to provide the initial admin user when making this API request.

2. Create Users

If you need to create additional Users for a Merchant, see Create New User for Merchant.

TIP

API keys can be generated during this step by including one or both of the following key/value pairs:

create_api_key -> true

create_pub_api_key -> true

Example

{
  "username": "user_test_3", // unique username
  "name": "test user",
  "phone": "5555555555",
  "email": "user@fluidpay.com",
  "timezone": "UTC",
  "status": "active",
  "role": "admin",
  "send_welcome": false, // should we send a welcome email? bool
  "create_api_key": true, // should we create a private api key and return it to you during merchant creation
  "create_pub_api_key": true // should we create a public api key and return it to you during merchant creation
}

3. Create API Keys

If you have existing Users without API keys, and you want to generate API keys for said Users, see API Keys.