Retrieve processing account | Payroc

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 method or the Create Processing Account method.

Note: If you don’t have the processingAccountId, use our List Merchant Platform’s 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 links to retrieve the pricing program for the processing account.

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.

Authentication

AuthorizationBearer

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

Path parameters

processingAccountIdstringRequired

Unique identifier that we assigned to the processing account.

Response

Successful request. Returns the processing account.

doingBusinessAsstring<=100 characters

Trading name of the business.

ownerslist of objects

Object that contains information about the owners of the business.

businessTypeenum

Type of business.

categoryCodeinteger

Merchant Category Code (MCC) for the type of business.

merchandiseOrServiceSoldstring<=125 characters

Description of the services or merchandise sold by the business.

timezoneenum

Time zone for the processing account.

addressobject

contactMethodslist of objects

Array of contactMethods objects for the processing account. At least one contactMethod must be an email address.

processingobject

Object that contains information about how we process transactions for the account.

fundingobject

Object that contains funding information for the processing account, including funding schedules, funding fees, and details of funding accounts.

pricingobject

Object that HATEOAS links to the pricing information that we apply to the processing account.

signatureobject

Object that includes information about how we captured the owner's signature.

processingAccountIdstring or null

Unique identifier of the processing account.

createdDatedatetime or null

Date and time that we received your request to create the processing account in our system.

lastModifiedDatedatetime or null

Date and time that the processing account was last modified.

statusenum or null

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.

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/integrate/event-subscriptions).

websitestring or null<=128 characters

Website address of the business.

businessStartDatedate or null

Date that the business was established. The format of the value is YYYY-MM-DD.

contactslist of objects or null

Array of contact objects.

metadatamap from strings to strings or null

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

linkslist of objects or null

Array of useful links related to your request.

Errors

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.

1	import requests
2
3	url = "https://api.payroc.com/v1/processing-accounts/38765"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"doingBusinessAs": "Pizza Doe",
3	"owners": [
4	{
5	"ownerId": 4564,
6	"firstName": "Jane",
7	"lastName": "Doe",
8	"link": {
9	"rel": "owner",
10	"href": "https://api.payroc.com/v1/owners/1543",
11	"method": "get"
12	}
13	}
14	],
15	"businessType": "restaurant",
16	"categoryCode": 5999,
17	"merchandiseOrServiceSold": "Pizza",
18	"timezone": "America/Chicago",
19	"address": {
20	"address1": "1 Example Ave.",
21	"address2": "Example Address Line 2",
22	"address3": "Example Address Line 3",
23	"city": "Chicago",
24	"state": "Illinois",
25	"country": "US",
26	"postalCode": "60056"
27	},
28	"contactMethods": [
29	{
30	"type": "email",
31	"value": "[email protected]"
32	}
33	],
34	"processing": {
35	"transactionAmounts": {
36	"average": 5000,
37	"highest": 10000
38	},
39	"monthlyAmounts": {
40	"average": 50000,
41	"highest": 100000
42	},
43	"volumeBreakdown": {
44	"cardPresentKeyed": 47,
45	"cardPresentSwiped": 30,
46	"mailOrTelephone": 3,
47	"ecommerce": 20
48	},
49	"merchantId": "444412365478965",
50	"isSeasonal": true,
51	"monthsOfOperation": [
52	"jan",
53	"feb"
54	],
55	"ach": {
56	"refunds": {
57	"writtenRefundPolicy": true,
58	"refundPolicyUrl": "www.example.com/refund-poilcy-url"
59	},
60	"estimatedMonthlyTransactions": 3000,
61	"limits": {
62	"singleTransaction": 10000,
63	"dailyDeposit": 200000,
64	"monthlyDeposit": 6000000
65	},
66	"naics": "5812",
67	"previouslyTerminatedForAch": false,
68	"transactionTypes": [
69	"prearrangedPayment",
70	"other"
71	],
72	"transactionTypesOther": "anotherTransactionType"
73	},
74	"cardAcceptance": {
75	"debitOnly": false,
76	"hsaFsa": false,
77	"cardsAccepted": [
78	"visa",
79	"mastercard"
80	],
81	"specialityCards": {
82	"americanExpressDirect": {
83	"enabled": true,
84	"merchantNumber": "abc1234567"
85	},
86	"electronicBenefitsTransfer": {
87	"enabled": true,
88	"fnsNumber": "6789012"
89	},
90	"other": {
91	"wexMerchantNumber": "abc1234567",
92	"voyagerMerchantId": "abc1234567",
93	"fleetMerchantId": "abc1234567"
94	}
95	}
96	}
97	},
98	"funding": {
99	"acceleratedFundingFee": 1999,
100	"dailyDiscount": false,
101	"fundingAccounts": [
102	{
103	"fundingAccountId": 123,
104	"status": "pending",
105	"link": {
106	"rel": "fundingAccount",
107	"method": "get",
108	"href": "https://api.payroc.com/v1/funding-accounts/123"
109	}
110	}
111	],
112	"fundingSchedule": "nextday",
113	"status": "enabled"
114	},
115	"pricing": {
116	"link": {
117	"rel": "pricing",
118	"href": "https://api.payroc.com/v1/processing-accounts/38765/pricing",
119	"method": "get"
120	}
121	},
122	"signature": {
123	"type": "requestedViaDirectLink",
124	"link": {
125	"rel": "agreement",
126	"method": "get",
127	"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000"
128	}
129	},
130	"processingAccountId": "38765",
131	"createdDate": "2024-07-02T12:00:00.000Z",
132	"lastModifiedDate": "2024-07-02T12:00:00.000Z",
133	"status": "approved",
134	"website": "www.example.com",
135	"businessStartDate": "2020-01-01",
136	"contacts": [
137	{
138	"contactId": 1543,
139	"firstName": "Jane",
140	"lastName": "Doe",
141	"link": {
142	"rel": "contact",
143	"href": "https://api.payroc.com/v1/contacts/1543",
144	"method": "get"
145	}
146	}
147	],
148	"metadata": {
149	"customerId": "2345"
150	}
151	}