--- title: "List merchant platforms" method: GET path: "/merchant-platforms" tags: ["merchantPlatforms"] --- # List merchant platforms `GET /merchant-platforms` Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of merchant platforms that are linked to your ISV account. **Note**: If you want to view the details of a specific merchant platform and you have its merchantPlatformId, use our [Retrieve Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. Our gateway returns the following information about each merchant platform in the list: - 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. For each merchant platform, we also return its merchantPlatformId and its linked processingAccountIds, which you can use to perform follow-on actions. ## Query parameters - `before` string - `after` string - `limit` integer ## Headers - `Authorization` string, required ## Response `200` Successful request. Returns a list of merchant platforms associated with the ISV's account. - PaginatedMerchants — Contains the pagination properties that you use to navigate through a list of results. - `limit` integer — Maximum number of results that we return for each page. - `count` integer — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query. - `hasMore` boolean — Indicates whether there is another page of results available. - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. - `data` MerchantPlatform[] — Array of merchantPlatform objects. - `merchantPlatformId` string — Unique identifier that we assigned to the merchant platform. - `createdDate` string, date-time — 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. - `lastModifiedDate` string, date-time — 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. - `business` Business, required — Object that contains information about the business. - `name` string, required — Legal name of the business. - `taxId` string, required — Tax ID of the business. - `organizationType` 'privateCorporation' | 'publicCorporation' | 'nonProfit' | 'privateLlc' | 'publicLlc' | 'privatePartnership' | 'publicPartnership' | 'soleProprietor', required — Type of organization. - `countryOfOperation` 'US' — Two-digit code for the country that the business operates in. The format follows the [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) standard. - `addresses` BusinessAddressesItems[], required — Array of polymorphic objects that contain address information for the business. - `type` 'legalAddress', required — Type of address. - `address1` string, required — Address line 1. - `address2` string — Address line 2. - `address3` string — Address line 3. - `city` string, required — City. - `state` string, required — Name of the state or state abbreviation. - `country` string, required — Two-digit country code for the country that the business operates in. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard. - `postalCode` string, required — Zip code or postal code. - `contactMethods` ContactMethod[], required — Array of polymorphic objects, which contain contact information. **Note:** You must provide an email address. The value of the type parameter determines which variant you should use: - `email` - Email address - `phone` - Phone number - `mobile` - Mobile number - `fax` - Fax number - union - object — email variant - `type` 'email', required — Discriminator value: email - `value` string, required — Email address. - object — phone variant - `type` 'phone', required — Discriminator value: phone - `value` string, required — Phone number. - object — mobile variant - `type` 'mobile', required — Discriminator value: mobile - `value` string, required — Mobile number. - object — fax variant - `type` 'fax', required — Discriminator value: fax - `value` string, required — Fax number. - `processingAccounts` MerchantPlatformProcessingAccountsItems[], required — Array of processingAccount objects. - `processingAccountId` string — Unique identifier that we assigned to the processing account. - `doingBusinessAs` string, required — Trading name of the business. - `processor` 'tsys' | 'fiserv', required — Processor that authorizes and settles transactions for the processing account. **Note:** We recommend that you include a value for the processor parameter and not rely on the default value. - `status` 'entered' | 'pending' | 'approved' | 'subjectTo' | 'dormant' | 'nonProcessing' | 'rejected' | 'terminated' | 'cancelled' | 'failed', required — Status of the processing account. - `entered` - We have received information about the account, but we have not yet reviewed it. - `pending` - We have reviewed the information about the account, but we have not yet approved it. - `approved` - We have approved the account for processing transactions and funding. - `subjectTo` - We have approved the account, but we are waiting on further information. - `dormant` - Account is closed for a period. - `nonProcessing` - We have approved the account, but the merchant has not yet run a transaction. - `rejected` - We rejected the application for the processing account. - `terminated` - Processing account is closed. - `cancelled` - Merchant withdrew the application for the processing account. - `failed` - An error occurred while we were setting up the processing account. **Note**: You can subscribe to our processingAccount.status.changed event to get notifications when we change the status of a processing account. For more information about how to subscribe to events, go to [Event Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions). - `link` MerchantPlatformProcessingAccountsItemsLink — Object that contains HATEOAS links for the processing account. - `rel` string — Relationship to the parent resource. - `href` string — Link to the resource. - `method` string — HTTP method you can use to retrieve the resource. - `signature` union — Polymorphic object that contains information about how we captured the owner's signature. The value of the type parameter determines which variant you should use: - `requestedViaDirectLink` - Request signature using a link. - `requestedViaEmail` - Request signature by email. - object — Object that contains signature information if we captured the merchant’s signature by direct link. - `type` 'requestedViaDirectLink', required — Discriminator value: requestedViaDirectLink - `link` Link — Object that contains HATEOAS links for the resource. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. - object — Object that contains signature information if we captured the merchant’s signature by email. - `type` 'requestedViaEmail', required — Discriminator value: requestedViaEmail - `addendums` AddendumEntry[], required — The addendum types that were accepted and appended to the Merchant Processing Agreement for this processing account. Returns an empty array when no addendums were requested. - union — Polymorphic object that indicates which form we should send to the merchant. The value of the type parameter determines which variant you should use. - object — Installment Payments, Loans, or Lease Questionnaire/Attestation for merchants that offer installment payments, loans, or leases. - `type` 'installmentPaymentsV1', required — Discriminator value: installmentPaymentsV1 - object — Money Services Business Questionnaire for merchants that offer money services, for example, traveler's checks. - `type` 'moneyServicesV1', required — Discriminator value: moneyServicesV1 - object — Telehealth Attestation for merchants that provide telehealth services. - `type` 'telehealthV1', required — Discriminator value: telehealthV1 - object — Firearms Due Diligence for merchants that sell firearms. - `type` 'firearmsV1', required — Discriminator value: firearmsV1 - object — Attestation of Compliance and Questionnaire for pharmaceutical merchants that accept CNP transactions. - `type` 'pharmacyCnpComplianceV1', required — Discriminator value: pharmacyCnpComplianceV1 - object — CBD Attestation for merchants that sell any of the following products: - CBD products - Synthetic THC or Cannabis - HHC - Kratom - Tianeptine - Delta 8/9/10/0 THC products - `type` 'cbdV1', required — Discriminator value: cbdV1 - object — CNP Tobacco Merchant Questionnaire for merchants that sell tobacco products and accept CNP transactions. - `type` 'tobaccoCnpV1', required — Discriminator value: tobaccoCnpV1 - object — Donations Addendum for merchants that accept donations. - `type` 'donationsV1', required — Discriminator value: donationsV1 - object — Clover Merchant Processing Amendment for merchants that order Clover equipment. - `type` 'cloverMerchantProcessingAmendmentV1', required — Discriminator value: cloverMerchantProcessingAmendmentV1 - `lineItems` AddendumEntryDiscriminatorMappingCloverMerchantProcessingAmendmentV1LineItems, required — Object that contains information about the Clover equipment and accessories that the merchant wants to order. - … - `metadata` object — Object that you can send to include custom metadata in the request. - `links` Link[] — Array of useful links related to your request. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. ## Other responses - `401` — Identity could not be verified - `403` — Do not have permissions to perform this action - `406` — Not acceptable - `500` — An error has occured --- [API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)