SchemaBoardingMerchant Platforms

Create merchant platform

Use this method to board a merchant with Payroc.

Note: This method is part of our Boarding solution. To help you understand how this method works with other Boarding methods, go to Board a Merchant.

In the request, include the following information:

  • Legal information, including its legal name and address.
  • Contact information, including the email address for the business.
  • Processing account information, including the pricing model, owners, and contacts for the processing account.

When you send a successful request, we review the merchant’s information. After we complete our review and approve the merchant, we assign:

  • merchantPlatformId - Unique identifier for the merchant platform.
  • processingAccountId - Unique identifier for each processing account linked to the merchant platform.

You need to keep these to perform follow-on actions, for example, you need the processingAccountId to order terminals for the processing account.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequiredformat: "uuid"

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
businessobjectRequired
Object that contains information about the business.
processingAccountslist of objectsRequired
Array of processingAccounts objects.
metadatamap from strings to stringsOptional
Object that you can send to include custom data in the request.

Response

Successful request. We created the merchant platform.
businessobject
Object that contains information about the business.
processingAccountslist of objects
Array of processingAccount objects.
merchantPlatformIdstring or null
Unique identifier that we assigned to the merchant platform.
createdDatedatetime or null

Date that the merchant platform was created. We return this value in the ISO-8601 format.

lastModifiedDatedatetime or null

Date that the merchant platform was last modified. We return this value in the ISO-8601 format.

metadatamap from strings to strings or null
Object that you can send to include custom metadata in the request.

Errors