List merchant platform's processing accounts

Browse API reference

GET/merchant-platforms/{merchantPlatformId}/processing-accountslistMerchantLocations

Use this method to return a paginated list of processing accounts linked to a merchant platform.

Note: If you want to view the details of a specific processing account and you have its processingAccountId, use our Retrieve Processing Account method.

Use the query parameters to filter the list of results that we return, for example, to search for only closed processing accounts.

To list the processing accounts for a merchant platform, you need its merchantPlatformId. 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 eahc processing account in the list:

Business details, including its status, time zone, and address.
Owners' details, including their contact details.
Funding, pricing, and processing information, including its pricing model and funding accounts.

For each processing account, we also return its processingAccountId, which you can use to perform follow-on actions.

Parameters

Name	In	Type	Description
`merchantPlatformId`Required	path	`string`	Unique identifier of the merchant platform that we sent to you when you created the merchant platform.
`before`	query	`string`	Return the previous page of results before the value that you specify. You can’t send the before parameter in the same request as the after parameter.
`after`	query	`string`	Return the next page of results after the value that you specify. You can’t send the after parameter in the same request as the before parameter.
`limit`	query	`integer`	Limit the maximum number of results that we return for each page.
`includeClosed`	query	`boolean`	Indicates if you want to return closed processing accounts. This includes processing accounts that have a status of `terminated`, `cancelled`, or `rejected`. Note: By default, we return only open processing accounts.

Responses

Successful request. Returns a list of processing accounts associated with the merchant platform.

200 OK · application/json

{
  "count": 2,
  "data": [
    {
      "addendums": [],
      "address": {
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "country": "US",
        "postalCode": "60056",
        "state": "Illinois"
      },
      "businessStartDate": "2020-01-01",
      "businessType": "restaurant",
      "categoryCode": 5999,
      "contactMethods": [
        {
          "type": "email",
          "value": "example-corp@example.com"
        },
        {
          "type": "phone",
          "value": "123 456 7890"
        }
      ],
      "contacts": [
        {
          "contactId": 1543,
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "href": "https://api.payroc.com/v1/contacts/1543",
            "method": "get",
            "rel": "owner"
          }
        }
      ],
      "createdDate": "2024-07-02T12:00:00.000+00:00",
      "doingBusinessAs": "Pizza Doe",
      "funding": {
        "acceleratedFundingFee": 1999,
        "fundingAccounts": [
          {
            "fundingAccountId": 123,
            "link": {
              "href": "https://api.payroc.com/v1/funding-accounts/123",
              "method": "get",
              "rel": "fundingAccount"
            },
            "status": "pending"
          }
        ],
        "fundingSchedule": "nextday",
        "status": "enabled"
      },
      "lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
      "merchandiseOrServiceSold": "Food",
      "owners": [
        {
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "href": "https://api.payroc.com/v1/owners/4564",
            "method": "get",
            "rel": "owner"
          },
          "ownerId": 4564
        }
      ],
      "pricing": {
        "link": {
          "href": "https://api.payroc.com/v1/processing-accounts/12345/pricing",
          "method": "get",
          "rel": "pricing"
        }
      },
      "processing": {
        "ach": {
          "estimatedMonthlyTransactions": 1000,
          "limits": {
            "dailyDeposit": 1000,
            "monthlyDeposit": 2000,
            "singleTransaction": 10000000
          },
          "naics": "5812",
          "previouslyTerminatedForAch": false,
          "refunds": {
            "refundPolicyUrl": "http://www.example.com/refunds",
            "writtenRefundPolicy": true
          },
          "transactionTypes": [
            "telephoneInitiatedPayment",
            "webInitiatedPayment"
          ]
        },
        "cardAcceptance": {
          "cardsAccepted": [
            "visa",
            "mastercard"
          ],
          "debitOnly": false,
          "hsaFsa": false,
          "specialityCards": {
            "americanExpressDirect": {
              "enabled": true,
              "merchantNumber": "1234567890"
            },
            "electronicBenefitsTransfer": {
              "enabled": true,
              "fnsNumber": "1234567"
            },
            "other": {
              "fleetMerchantId": "1234567890",
              "voyagerMerchantId": "1234567890",
              "wexMerchantNumber": "1234567890"
            }
          }
        },
        "isSeasonal": true,
        "merchantId": "444412365478965",
        "monthlyAmounts": {
          "average": 1000000,
          "highest": 200000000
        },
        "monthsOfOperation": [
          "jan",
          "feb",
          "mar",
          "nov",
          "dec"
        ],
        "transactionAmounts": {
          "average": 1000,
          "highest": 200000
        },
        "volumeBreakdown": {
          "cardPresent": 77,
          "ecommerce": 20,
          "mailOrTelephone": 3
        }
      },
      "processingAccountId": "38765",
      "processor": "tsys",
      "signature": {
        "type": "requestedViaEmail"
      },
      "status": "approved",
      "timezone": "America/Chicago",
      "website": "www.example.com"
    },
    {
      "addendums": [],
      "address": {
        "address1": "3 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "country": "US",
        "postalCode": "60056",
        "state": "Illinois"
      },
      "businessStartDate": "2020-01-01",
      "businessType": "internet",
      "categoryCode": 5999,
      "contactMethods": [
        {
          "type": "email",
          "value": "jane.doe@example.com"
        },
        {
          "type": "phone",
          "value": "555 555 3456"
        }
      ],
      "contacts": [
        {
          "contactId": 1543,
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "href": "https://api.payroc.com/v1/contacts/1543",
            "method": "get",
            "rel": "owner"
          }
        }
      ],
      "createdDate": "2024-07-02T12:00:00.000+00:00",
      "doingBusinessAs": "Doe Hot Dogs",
      "funding": {
        "acceleratedFundingFee": 1999,
        "fundingAccounts": [
          {
            "fundingAccountId": 124,
            "link": {
              "href": "https://api.payroc.com/v1/funding-accounts/124",
              "method": "get",
              "rel": "fundingAccount"
            },
            "status": "pending"
          }
        ],
        "fundingSchedule": "nextday",
        "status": "enabled"
      },
      "lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
      "merchandiseOrServiceSold": "Food",
      "owners": [
        {
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "href": "https://api.payroc.com/v1/owners/4564",
            "method": "get",
            "rel": "owner"
          },
          "ownerId": 4564
        }
      ],
      "pricing": {
        "link": {
          "href": "https://api.payroc.com/v1/processing-accounts/12346/pricing",
          "method": "get",
          "rel": "pricing"
        }
      },
      "processing": {
        "isSeasonal": true,
        "merchantId": "444412365478966",
        "monthlyAmounts": {
          "average": 2000000,
          "highest": 300000000
        },
        "transactionAmounts": {
          "average": 2000,
          "highest": 300000
        },
        "volumeBreakdown": {
          "cardPresent": 0,
          "ecommerce": 100,
          "mailOrTelephone": 0
        }
      },
      "processingAccountId": "38766",
      "processor": "tsys",
      "signature": {
        "type": "requestedViaEmail"
      },
      "status": "approved",
      "timezone": "America/Chicago",
      "website": "www.example.com"
    }
  ],
  "hasMore": true,
  "limit": 2,
  "links": [
    {
      "href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?before=38765&limit=2",
      "method": "get",
      "rel": "previous"
    },
    {
      "href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?after=38766&limit=2",
      "method": "get",
      "rel": "next"
    }
  ]
}

Response schema · 73 of 206 fields

countinteger
Number of results we returned on this page. Note: This might not be the total number of results that match your query.
hasMoreboolean
Indicates whether there is another page of results available.
limitinteger
Maximum number of results that we return for each page.
linksobject[]
Reference links to navigate to the previous page of results or to the next page of results.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
dataobject[]
Array of processingAccount objects.
- addendumsobject[]required
  Array of polymorphic addendumEntry objects. Each object indicates the additional form that we sent to the merchant with the Merchant Processing Agreement (MPA). The value of the type parameter determines which variant you should use.
  - option 1object
    Installment Payments, Loans, or Lease Questionnaire/Attestation for merchants that offer installment payments, loans, or leases.+1 more fields at deeper levels — see the full spec
  - option 2object
    Money Services Business Questionnaire for merchants that offer money services, for example, traveler's checks.+1 more fields at deeper levels — see the full spec
  - option 3object
    Telehealth Attestation for merchants that provide telehealth services.+1 more fields at deeper levels — see the full spec
  - option 4object
    Firearms Due Diligence for merchants that sell firearms.+1 more fields at deeper levels — see the full spec
  - option 5object
    Attestation of Compliance and Questionnaire for pharmaceutical merchants that accept CNP transactions.+1 more fields at deeper levels — see the full spec
  - option 6object
    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+1 more fields at deeper levels — see the full spec
  - option 7object
    CNP Tobacco Merchant Questionnaire for merchants that sell tobacco products and accept CNP transactions.+1 more fields at deeper levels — see the full spec
  - option 8object
    Donations Addendum for merchants that accept donations.+1 more fields at deeper levels — see the full spec
  - option 9object
    Clover Merchant Processing Amendment for merchants that order Clover equipment.+47 more fields at deeper levels — see the full spec
  - option 10object
    Roc Giving Addendum for merchants that use Roc Giving.+9 more fields at deeper levels — see the full spec
- addressobjectrequired
  Polymorphic object that contains address information for the processing account.
  - addressobject
    Object that contains information about the address.+7 more fields at deeper levels — see the full spec
- businessStartDatestringdate
  Date that the business was established. The format of the value is YYYY-MM-DD.
- businessTypestring
  Type of business.retailrestaurantinternetmotolodgingnotForProfit
- categoryCodeintegerint32
  Merchant Category Code (MCC) for the type of business.≤ 4 chars
- contactMethodsobject[]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≥ 1 items
  - emailobject
    +2 more fields at deeper levels — see the full spec
  - phoneobject
    +2 more fields at deeper levels — see the full spec
  - mobileobject
    +2 more fields at deeper levels — see the full spec
  - faxobject
    +2 more fields at deeper levels — see the full spec
- contactsobject[]
  Array of contact objects.
  - contactIdinteger
    Unique identifier of the contact.
  - firstNamestring
    Contact's first name.
  - lastNamestring
    Contact's last name.
  - linkobject
    Object that contains HATEOAS links for the contact.+3 more fields at deeper levels — see the full spec
- createdDatestringdate-time
  Date and time that we received your request to create the processing account in our system.
- doingBusinessAsstringrequired
  Trading name of the business.≤ 100 chars
- fundingobjectrequired
  Object that contains funding information for the processing account, including funding schedules, funding fees, and details of funding accounts.
  - acceleratedFundingFeeinteger
    Monthly fee in cents for accelerated funding. The value is in the currency's lowest denomination, for example, cents. We apply this fee if the value for fundingSchedule is sameday or nextday.
  - dailyDiscountboolean
    Indicates if we collect fees from the merchant's account each day.
  - fundingSchedulestring
    Indicates when funds are sent to the funding account. If you send a value of sameDay or nextDay, provide a value for acceleratedFundingFee. Note: If you send a value of sameday, funding includes all transactions the merchant ran before the ACH cut-off time.standardnextdaysameday
  - statusstring
    Indicates if the processing account can receive funds.enableddisabled
  - fundingAccountsobject[]
    Object that contains funding accounts associated with the processing account.1–2 items+6 more fields at deeper levels — see the full spec
- lastModifiedDatestringdate-time
  Date and time that the processing account was last modified.
- linksobject[]
  Array of useful links related to your request.
  - hrefstringrequired
    URL of the target resource.
  - methodstringrequired
    HTTP method that you need to use with the target resource.
  - relstringrequired
    Indicates the relationship between the current resource and the target resource.
- merchandiseOrServiceSoldstringrequired
  Description of the services or merchandise sold by the business.≤ 125 chars
- metadataobject
  Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.
- ownersobject[]required
  Object that contains information about the owners of the business.
  - firstNamestring
    Owner's first name.
  - lastNamestring
    Owner's last name.
  - linkobject
    HATEOAS links to the owners of the processing account.+3 more fields at deeper levels — see the full spec
  - ownerIdinteger
    Unique identifier of the owner.
- pricingobjectrequired
  Object that HATEOAS links to the pricing information that we apply to the processing account.
  - linkobject
    Object that contains HATEOAS links to the pricing information for the processing account.+3 more fields at deeper levels — see the full spec
- processingobjectrequired
  Object that contains information about how we process transactions for the account.
  - achobject
    Object that contains information about Automated Clearing House (ACH) transactions.+12 more fields at deeper levels — see the full spec
  - cardAcceptanceobject
    Object that contains information about the types of cards that the processing account accepts.+14 more fields at deeper levels — see the full spec
  - isSeasonalboolean
    Indicates if the processing account runs transactions on a seasonal basis. For example, if the processing account runs transactions during only the winter months, send a value of true.
  - merchantIdstring
    Unique identifier that the acquiring platform assigns to the merchant.≤ 15 chars
  - monthlyAmountsobjectrequired
    Object that contains information about the monthly processing amounts for the processing account.+2 more fields at deeper levels — see the full spec
  - monthsOfOperationstring[]
    Months of the year that the processing account runs transactions.≤ 12 items
  - transactionAmountsobjectrequired
    Object that contains information about transaction amounts for the processing account.+2 more fields at deeper levels — see the full spec
  - volumeBreakdownobjectrequired
    Object that contains information about the types of transactions ran by the processing account. The percentages for transaction types must total 100%.+3 more fields at deeper levels — see the full spec
- processingAccountIdstring
  Unique identifier of the processing account.
- processorstring
  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.tsysfiserv
- signatureobjectrequired
  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.
  - requestedViaDirectLinkobject
    Object that contains signature information if we captured the merchant’s signature by direct link.+5 more fields at deeper levels — see the full spec
  - requestedViaEmailobject
    Object that contains signature information if we captured the merchant’s signature by email.+1 more fields at deeper levels — see the full spec
- statusstring
  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. 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.enteredpendingapprovedsubjectTodormantnonProcessingrejectedterminated+1 more
- timezonestringrequired
  Time zone for the processing account.≤ 28 charsPacific/MidwayPacific/HonoluluAmerica/AnchorageAmerica/Los_AngelesAmerica/DenverAmerica/PhoenixAmerica/ChicagoAmerica/Indiana/Indianapolis+1 more
- websitestring
  Website address of the business.≤ 128 chars

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

review-merchant-hierarchy