--- title: "Retrieve processing account" method: GET path: "/processing-accounts/{processingAccountId}" tags: ["processingAccounts"] --- # Retrieve processing account `GET /processing-accounts/{processingAccountId}` Use this method to retrieve information about a specific processing account. To retrieve a processing account, you need its processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. **Note:** If you don't have the processingAccountId, use our [List Merchant Platform's Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. Our gateway returns the following information about the processing account: - Business information, including the Merchant Category Code (MCC), status of the processing account, and address of the business. - Processing information, including the merchant’s refund policies and card types that the merchant accepts. - Funding information, including funding schedules, funding fees, and details for the merchant’s funding accounts. - Pricing information, including [HATEOAS](https://docs.payroc.com/knowledge/basic-concepts/hypermedia-as-the-engine-of-application-state-hateoas) links to retrieve the pricing program for the processing account. ## Path parameters - `processingAccountId` string, required ## Headers - `Authorization` string, required ## Response `200` Successful request. Returns the processing account. - ProcessingAccount - `processingAccountId` string — Unique identifier of the processing account. - `createdDate` string, date-time — Date and time that we received your request to create the processing account in our system. - `lastModifiedDate` string, date-time — Date and time that the processing account was last modified. - `status` 'entered' | 'pending' | 'approved' | 'subjectTo' | 'dormant' | 'nonProcessing' | 'rejected' | 'terminated' | 'cancelled' — 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](https://docs.payroc.com/guides/board-merchants/event-subscriptions). - `doingBusinessAs` string, required — Trading name of the business. - `owners` ProcessingAccountOwnersItems[], required — Object that contains information about the owners of the business. - `ownerId` integer — Unique identifier of the owner. - `firstName` string — Owner's first name. - `lastName` string — Owner's last name. - `link` ProcessingAccountOwnersItemsLink — HATEOAS links to the owners of the processing account. - `rel` string — Indicates the relationship between the current resource and the target resource. - `href` string — URL of the target resource. - `method` string — HTTP method that you need to use with the target resource. - `website` string — Website address of the business. - `businessType` 'retail' | 'restaurant' | 'internet' | 'moto' | 'lodging' | 'notForProfit' — Type of business. - `categoryCode` integer — Merchant Category Code (MCC) for the type of business. - `processor` 'tsys' | 'fiserv' — 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. - `merchandiseOrServiceSold` string, required — Description of the services or merchandise sold by the business. - `businessStartDate` string, date — Date that the business was established. The format of the value is **YYYY-MM-DD**. - `timezone` 'Pacific/Midway' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Phoenix' | 'America/Chicago' | 'America/Indiana/Indianapolis' | 'America/New_York', required — Time zone for the processing account. - `address` ProcessingAccountAddress, required — Object that contains information about the 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. - `processing` Processing, required — Object that contains information about how we process transactions for the account. - `merchantId` string — Unique identifier that the acquiring platform assigns to the merchant. - `transactionAmounts` ProcessingTransactionAmounts, required — Object that contains information about transaction amounts for the processing account. - `average` integer, required — Estimated average transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero. - `highest` integer, required — Estimated maximum transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero. - `monthlyAmounts` ProcessingMonthlyAmounts, required — Object that contains information about the monthly processing amounts for the processing account. - `average` integer, required — Estimated average transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero. - `highest` integer, required — Estimated maximum transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero. - `volumeBreakdown` ProcessingVolumeBreakdown, required — Object that contains information about the types of transactions ran by the processing account. The percentages for transaction types must total 100%. - `cardPresent` integer, required — Estimated percentage of card-present transactions. - `mailOrTelephone` integer, required — Estimated percentage of mail order or telephone transactions. - `ecommerce` integer, required — Estimated percentage of e-Commerce transactions. - `isSeasonal` boolean — 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`. - `monthsOfOperation` ProcessingMonthsOfOperationItems[] — Months of the year that the processing account runs transactions. - `ach` ProcessingAch — Object that contains information about Automated Clearing House (ACH) transactions. - `naics` string — North American Industry Classification System (NAICS) code. - `previouslyTerminatedForAch` boolean — Indicates if the business or its principals were previously turned down for ACH processing. - `refunds` ProcessingAchRefunds, required — Object that contains information about the ACH refund policy for the processing account. - `writtenRefundPolicy` boolean, required — Indicates if the business has a written refund policy. - `refundPolicyUrl` string — URL of the written refund policy. - `estimatedMonthlyTransactions` integer, required — Estimated maximum number of transactions that the merchant will process in a month. - `limits` ProcessingAchLimits, required — Object that contains information about transaction limits for the processing account. - `singleTransaction` integer, required — Maximum amount allowed for a single debit or credit transaction. The value is in the currency's lowest denomination, for example, cents. - `dailyDeposit` integer, required — Maximum amount of total transactions allowed per day. The value is in the currency's lowest denomination, for example, cents. - `monthlyDeposit` integer, required — Maximum amount of total transactions allowed per month. The value is in the currency's lowest denomination, for example, cents. - `transactionTypes` ProcessingAchTransactionTypesItems[] — List of transaction types that the processing account supports. - `transactionTypesOther` string — If you send a value of `other` for transactionTypes, provide a list of the supported transaction types. - `cardAcceptance` ProcessingCardAcceptance — Object that contains information about the types of cards that the processing account accepts. - `debitOnly` boolean — Indicates if the merchant accepts only debit cards. - `hsaFsa` boolean — Indicates if the merchant accepts health savings account (HSA) and flexible spending account (FSA) cards. - `cardsAccepted` ProcessingCardAcceptanceCardsAcceptedItems[] — List of card types the merchant accepts. - `specialityCards` ProcessingCardAcceptanceSpecialityCards — Information about the speciality cards that the merchant accepts. - `americanExpressDirect` ProcessingCardAcceptanceSpecialityCardsAmericanExpressDirect — Object that indicates if the merchant accepts American Express Direct cards and contains the merchant’s American Express merchant number. - `enabled` boolean — Indicates if the merchant accepts American Express Direct. - `merchantNumber` string — If the merchant accepts American Express Direct, provide their American Express merchant number. - `electronicBenefitsTransfer` ProcessingCardAcceptanceSpecialityCardsElectronicBenefitsTransfer — Object that indicates if the merchant accepts Electronic Benefits Transfer (EBT) cards and contains the merchant’s Food and Nutrition Services (FNS) number. - `enabled` boolean — Indicates if the merchant accepts EBT. - `fnsNumber` string — If the merchant accepts EBT, provide their FNS number. - `other` ProcessingCardAcceptanceSpecialityCardsOther — Object that contains information about other speciality cards that the merchant accepts. - `wexMerchantNumber` string — If the merchant accepts WEX, provide their WEX merchant number. - `voyagerMerchantId` string — If the merchant accepts Voyager, provide their Voyager merchant ID. - `fleetMerchantId` string — If the merchant accepts Fleet, provide their Fleet merchant ID. - `funding` Funding, required — Object that contains funding information for the processing account, including funding schedules, funding fees, and details of funding accounts. - `status` 'enabled' | 'disabled' — Indicates if the processing account can receive funds. - `fundingSchedule` 'standard' | 'nextday' | 'sameday' — 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. - `acceleratedFundingFee` integer — 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`. - `dailyDiscount` boolean — Indicates if we collect fees from the merchant's account each day. - `fundingAccounts` FundingAccountSummary[] — Object that contains funding accounts associated with the processing account. - `fundingAccountId` integer — Unique identifier that we assigned to the funding account. - `status` 'approved' | 'rejected' | 'pending' — Status of the funding account. - `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. - `pricing` ProcessingAccountPricing, required — Object that HATEOAS links to the pricing information that we apply to the processing account. - `link` ProcessingAccountPricingLink — Object that contains HATEOAS links to the pricing information for the processing account. - `rel` string — Indicates the relationship between the current resource and the target resource. - `href` string — URL of the target resource. - `method` string — HTTP method that you need to use with the target resource. - `contacts` ProcessingAccountContactsItems[] — Array of contact objects. - `contactId` integer — Unique identifier of the contact. - `firstName` string — Contact's first name. - `lastName` string — Contact's last name. - `link` ProcessingAccountContactsItemsLink — Object that contains HATEOAS links for the contact. - `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, required — 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 — 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. - 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. - `cloverCompact` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverFlex4thGen` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverFlexPocket` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverMiniLte3rdGen` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverSoloPosSystem` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverStationDuoGen2PosSystem` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverCompactTetherCable` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverCashDrawer` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverKitchenPrinter` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverKitchenPrinterThermal` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverWeightScale` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverHandsFreeScanner` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverBarCodeScanner` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverKds24` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `cloverKds14` CloverLineItem — Object that contains information about the cost of each item and the number of items that the merchant wants to order. - `quantity` integer, required — Number of units. - `totalPrice` integer, required — Total cost for all devices in this line item, in cents (USD). - `metadata` object — Object that you can send to include custom data in the request. For more information about how to use metadata, go to [Metadata](https://docs.payroc.com/api/metadata). - `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 - `400` — Invalid request - `401` — Identity could not be verified - `403` — Do not have permissions to perform this action - `404` — Resource not found - `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)