SchemaBoardingMerchant Platforms

Retrieve merchant platform

View as MarkdownOpen in Claude
Use this method to retrieve information about a merchant platform. To retrieve a merchant platform, you need its merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method. **Note:** If you don't have the merchantPlatformId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for the merchant platform. Our gateway returns the following information about the merchant platform: - Legal information, including its legal name and address. - Contact information, including the email address for the business. - Processing account information, including the processingAccountId and status of each processing account that's linked to the merchant platform.

Authentication

AuthorizationBearer

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

Path parameters

merchantPlatformIdstringRequired
Unique identifier of the merchant platform that we sent to you when you created the merchant platform.

Response

Successful request. Returns 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](https://www.iso.org/iso-8601-date-and-time-format.html) format.
lastModifiedDatedatetime or null
Date that the merchant platform was last modified. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
metadatamap from strings to strings or null
Object that you can send to include custom metadata in the request.

Errors