merchantPlatforms

Create merchant platform

Changed on

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.

post/merchant-platforms

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/merchant-platforms
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring uuid required

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 body

metadataobject

Object that you can send to include custom data in the request.

Response

Successful request. We created the merchant platform.

merchantPlatformIdstring

Unique identifier that we assigned to the merchant platform.

createdDatestring date-time

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

lastModifiedDatestring date-time

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

metadataobject

Object that you can send to include custom metadata in the request.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 2365ff7cb3a5Revision changes
    • breaking

      added subschema #10 to the /// response property oneOf list for the response status

    • info

      added subschema #10 to the /// request property oneOf list