This guide shows you how to create a new merchant application using the Application Boarding API resource. The response includes the new application's ID. See Create Application in API Reference for field definitions.

Prerequisites

1. Contact Qualpay to set up your Qualpay Partner account. Qualpay will provide you with a channel_id.
2. Follow the steps in Get Your API Credentials to save your vendor sandbox ID and API key.
3. See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)
4. Send a Browse Sales Reps request to locate a sales representative. Save the associated sales_rep value from the response.

Implement

1. Write a POST request to send to the /platform/application/add endpoint.
2. In the request body, use the channel_id field to add the sales channel in which to start this application.
3. In the request body, use the sales_rep field to add the sales rep associated with this application.
4. If you wish to specify the point in the Qualpay hierarchy in which to board the merchant, use the termination_node in the request body to do so.

Once configured, your request will resemble the sample code below:

curl --request POST \
     --url https://api-test.qualpay.com/platform/application/add \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZZZjMjFhMzFjMjMjFhMzFjMzjMjFhMzFjME2YWJjMTIz' \
     --header 'content-type: application/json' \
     --data '
{
     "channel_id": 1,
     "sales_rep": 1,
     "termination_node": 8971999999
}
'

Integrate

Send your request. You will receive a response like this from the Qualpay server:

{
  "code": 0,
  "message": "Success",
  "data": {
    "app": {
      "app_id": 1,
      "merchant_id": 212000000001, #This number is `0` until the application has been approved and Qualpay has assigned a merchant ID.
      "app_status": "INCOMPLETE",
      "dba_name": "Ben's Bar",
      "db_timestamp": "2022-09-26T15:15:42.953Z",
      "submit_timestamp": "2022-09-26T15:15:42.953Z",
      "credit_timestamp": "2022-09-26T15:15:42.953Z"
    },
    "pricing": {
      "pricing_id": 1,
      "plan": {}
    }
  }
}

Check the code field in the request response: 0 confirms success. The API has created a new application to your specifications. If the value is something other than 0, check Platform API Response Codes in Reference.

In the app object, the app_id field shows this application's ID, which you will use in the API throughout the boarding process.

See Create Application in API Reference for response field definitions.

🚧

Save the Application ID

Be sure to save the app_id value that appears in your request response. You will need it to interact with this application through our APIs.

Test and Go Live

See our Test and Go Live guide to test your API integration and to start transacting with an active production account.