SchemaBoardingMerchant Platforms

Create merchant platform

Use this method to create the entity that represents a business, including its legal information and all its processing accounts.

Note: To add a processing account to an existing merchant platform, go to Create a processing account.

The response contains some fields that we require for other methods:

  • merchantPlatformId - Unique identifier that we assign to the merchant platform. Use the merchantPlatformId to retrieve and update information about the merchant platform.

  • processingAccountId- Unique identifier that we assign to each processing account. Use the processingAccountId to retrieve and update information about the processing account.


For more information about how to create a merchant platform, go to Create a merchant platform.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequired

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

merchantPlatformIdstringOptional

Unique identifier of the merchant platform.

createdDatestringOptionalformat: "date-time"

Date that the merchant platform was created.

lastModifiedDatestringOptionalformat: "date-time"

Date that the merchant platform was last modified.

metadatamap from strings to stringsOptional

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