merchantPlatforms

Retrieve merchant platform

Changed on

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 method.

Note: If you don't have the merchantPlatformId, use our List Merchant Platforms 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.
get/merchant-platforms/{merchantPlatformId}

Request

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

Path parameters

merchantPlatformIdstring required

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

Response

Successful request. Returns 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