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 objectsRead-only

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

Polymorphic object that contains address information for the processing account.

contactMethodslist of objects

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

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

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

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.

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.

processingAccountIdstringRead-only

Unique identifier of the processing account.

createdDatedatetimeRead-only

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

lastModifiedDatedatetimeRead-only

Date and time that the processing account was last modified.

statusenumRead-only

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

websitestring<=128 characters

Website address of the business.

businessStartDatedate

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

contactslist of objectsRead-only

Array of contact objects.

metadatamap from strings to strings

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

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

linkslist of objects

Array of useful links related to your request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error

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	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Boarding.ProcessingAccounts;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new PayrocClient();
11
12	await client.Boarding.ProcessingAccounts.RetrieveAsync(
13	new RetrieveProcessingAccountsRequest {
14	ProcessingAccountId = "38765"
15	}
16	);
17	}
18
19	}

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	"cardPresent": 77,
45	"mailOrTelephone": 3,
46	"ecommerce": 20
47	},
48	"merchantId": "444412365478965",
49	"isSeasonal": true,
50	"monthsOfOperation": [
51	"jan",
52	"feb"
53	],
54	"ach": {
55	"refunds": {
56	"writtenRefundPolicy": true,
57	"refundPolicyUrl": "www.example.com/refund-poilcy-url"
58	},
59	"estimatedMonthlyTransactions": 3000,
60	"limits": {
61	"singleTransaction": 10000,
62	"dailyDeposit": 200000,
63	"monthlyDeposit": 6000000
64	},
65	"naics": "5812",
66	"previouslyTerminatedForAch": false,
67	"transactionTypes": [
68	"prearrangedPayment",
69	"other"
70	],
71	"transactionTypesOther": "anotherTransactionType"
72	},
73	"cardAcceptance": {
74	"debitOnly": false,
75	"hsaFsa": false,
76	"cardsAccepted": [
77	"visa",
78	"mastercard"
79	],
80	"specialityCards": {
81	"americanExpressDirect": {
82	"enabled": true,
83	"merchantNumber": "abc1234567"
84	},
85	"electronicBenefitsTransfer": {
86	"enabled": true,
87	"fnsNumber": "6789012"
88	},
89	"other": {
90	"wexMerchantNumber": "abc1234567",
91	"voyagerMerchantId": "abc1234567",
92	"fleetMerchantId": "abc1234567"
93	}
94	}
95	}
96	},
97	"funding": {
98	"acceleratedFundingFee": 1999,
99	"dailyDiscount": false,
100	"fundingAccounts": [
101	{
102	"fundingAccountId": 123,
103	"status": "pending",
104	"link": {
105	"rel": "fundingAccount",
106	"method": "get",
107	"href": "https://api.payroc.com/v1/funding-accounts/123"
108	}
109	}
110	],
111	"fundingSchedule": "nextday",
112	"status": "enabled"
113	},
114	"pricing": {
115	"link": {
116	"rel": "pricing",
117	"href": "https://api.payroc.com/v1/processing-accounts/38765/pricing",
118	"method": "get"
119	}
120	},
121	"signature": {
122	"type": "requestedViaDirectLink",
123	"link": {
124	"rel": "agreement",
125	"method": "get",
126	"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000"
127	}
128	},
129	"processingAccountId": "38765",
130	"createdDate": "2024-07-02T12:00:00.000Z",
131	"lastModifiedDate": "2024-07-02T12:00:00.000Z",
132	"status": "approved",
133	"website": "www.example.com",
134	"businessStartDate": "2020-01-01",
135	"contacts": [
136	{
137	"contactId": 1543,
138	"firstName": "Jane",
139	"lastName": "Doe",
140	"link": {
141	"rel": "contact",
142	"href": "https://api.payroc.com/v1/contacts/1543",
143	"method": "get"
144	}
145	}
146	],
147	"metadata": {
148	"customerId": "2345"
149	}
150	}