Create processing account

POST

/merchant-platforms/:merchantPlatformId/processing-accounts

POST

/v1/merchant-platforms/:merchantPlatformId/processing-accounts

1 import requests
2 
3 url = "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts"
4 
5 payload = {
6     "doingBusinessAs": "Pizza Doe",
7     "owners": [
8         {
9             "firstName": "Jane",
10             "lastName": "Doe",
11             "dateOfBirth": "1964-03-22",
12             "address": {
13                 "address1": "1 Example Ave.",
14                 "city": "Chicago",
15                 "state": "Illinois",
16                 "country": "US",
17                 "postalCode": "60056",
18                 "address2": "Example Address Line 2",
19                 "address3": "Example Address Line 3"
20             },
21             "identifiers": [
22                 {
23                     "type": "nationalId",
24                     "value": "000-00-4320"
25                 }
26             ],
27             "contactMethods": [
28                 {
29                     "type": "email",
30                     "value": "[email protected]"
31                 }
32             ],
33             "relationship": {
34                 "isControlProng": True,
35                 "equityPercentage": 51.5,
36                 "title": "CFO",
37                 "isAuthorizedSignatory": False
38             },
39             "middleName": "Helen"
40         }
41     ],
42     "businessType": "restaurant",
43     "categoryCode": 5999,
44     "merchandiseOrServiceSold": "Pizza",
45     "businessStartDate": "2020-01-01",
46     "timezone": "America/Chicago",
47     "address": {
48         "address1": "1 Example Ave.",
49         "address2": "Example Address Line 2",
50         "address3": "Example Address Line 3",
51         "city": "Chicago",
52         "state": "Illinois",
53         "country": "US",
54         "postalCode": "60056"
55     },
56     "contactMethods": [
57         {
58             "type": "email",
59             "value": "[email protected]"
60         }
61     ],
62     "processing": {
63         "transactionAmounts": {
64             "average": 5000,
65             "highest": 10000
66         },
67         "monthlyAmounts": {
68             "average": 50000,
69             "highest": 100000
70         },
71         "volumeBreakdown": {
72             "cardPresentKeyed": 47,
73             "cardPresentSwiped": 30,
74             "mailOrTelephone": 3,
75             "ecommerce": 20
76         },
77         "isSeasonal": True,
78         "monthsOfOperation": ["jan", "feb"],
79         "ach": {
80             "refunds": {
81                 "writtenRefundPolicy": True,
82                 "refundPolicyUrl": "www.example.com/refund-poilcy-url"
83             },
84             "estimatedMonthlyTransactions": 3000,
85             "limits": {
86                 "singleTransaction": 10000,
87                 "dailyDeposit": 200000,
88                 "monthlyDeposit": 6000000
89             },
90             "naics": "5812",
91             "previouslyTerminatedForAch": False,
92             "transactionTypes": ["prearrangedPayment", "other"],
93             "transactionTypesOther": "anotherTransactionType"
94         },
95         "cardAcceptance": {
96             "debitOnly": False,
97             "hsaFsa": False,
98             "cardsAccepted": ["visa", "mastercard"],
99             "specialityCards": {
100                 "americanExpressDirect": {
101                     "enabled": True,
102                     "merchantNumber": "abc1234567"
103                 },
104                 "electronicBenefitsTransfer": {
105                     "enabled": True,
106                     "fnsNumber": "6789012"
107                 },
108                 "other": {
109                     "wexMerchantNumber": "abc1234567",
110                     "voyagerMerchantId": "abc1234567",
111                     "fleetMerchantId": "abc1234567"
112                 }
113             }
114         }
115     },
116     "funding": {
117         "acceleratedFundingFee": 1999,
118         "dailyDiscount": False,
119         "fundingAccounts": [
120             {
121                 "type": "checking",
122                 "use": "creditAndDebit",
123                 "nameOnAccount": "Jane Doe",
124                 "paymentMethods": [
125                     {
126                         "type": "ach",
127                         "value": {
128                             "routingNumber": "123456789",
129                             "accountNumber": "1234567890"
130                         }
131                     }
132                 ],
133                 "metadata": { "yourCustomField": "abc123" }
134             }
135         ],
136         "fundingSchedule": "nextday"
137     },
138     "pricing": {
139         "type": "intent",
140         "pricingIntentId": "6123"
141     },
142     "signature": { "type": "requestedViaDirectLink" },
143     "website": "www.example.com",
144     "contacts": [
145         {
146             "type": "manager",
147             "firstName": "Jane",
148             "lastName": "Doe",
149             "identifiers": [
150                 {
151                     "type": "nationalId",
152                     "value": "000-00-4320"
153                 }
154             ],
155             "contactMethods": [
156                 {
157                     "type": "email",
158                     "value": "[email protected]"
159                 }
160             ],
161             "middleName": "Helen"
162         }
163     ],
164     "metadata": { "customerId": "2345" }
165 }
166 headers = {
167     "Idempotency-Key": "8e03978e-40d5-43e8-bc93-6894a57f9324",
168     "Authorization": "Bearer <token>",
169     "Content-Type": "application/json"
170 }
171 
172 response = requests.post(url, json=payload, headers=headers)
173 
174 print(response.json())

Try it

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/4564",
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     "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/12345/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": "entered",
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 }

Use this method to add an additional processing account to a merchant platform.

To add a processing account to a merchant platform, you need the merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the Create Merchant Platform method.

Note: If you don’t have the merchantPlatformId, use our List Merchant Platforms method to search for the merchant platform.

In the request, include the following information:

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

When you send a successful request, we review the information about the processing account. After we complete our review and approve the processing account, we assign a processingAccountId, which you need to perform follow-on actions.

Note: You can subscribe to our processingAccount.status.changed event to get notifications when we update the status of a processing account. For more information about how to subscribe to events, go to Events List.

Use this method to add an additional processing account to a merchant platform. To add a processing account to a merchant platform, you need the merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method. **Note**: If you don't have the merchantPlatformId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for the merchant platform. In the request, include the following information: - Business details, including its business type, time zone, and address. - Owners' details, including their contact details. - Funding, pricing, and processing information, including its pricing model and funding accounts. When you send a successful request, we review the information about the processing account. After we complete our review and approve the processing account, we assign a processingAccountId, which you need to perform follow-on actions. **Note**: You can subscribe to our processingAccount.status.changed event to get notifications when we update the status of a processing account. For more information about how to subscribe to events, go to [Events List](https://docs.payroc.com/knowledge/events/events-list).

Path parameters

merchantPlatformIdstringRequired

Unique identifier of the merchant platform that we sent to you when you created the merchant platform.

Headers

Request

This endpoint expects an object.

doingBusinessAsstringRequired<=100 characters

Trading name of the business.

ownerslist of objectsRequired

Collection of individuals that are responsible for a processing account. When you create a processing account, you must indicate at least one owner as either of the following:

Control prong - An individual who has a significant equity stake in the business and can make decisions for the processing account. You can add only one control prong to a processing account.
Authorized signatory - An individual who doesn’t have an equity stake in the business but can make decisions for the processing account.

Collection of individuals that are responsible for a processing account. When you create a processing account, you must indicate at least one owner as either of the following: - **Control prong** - An individual who has a significant equity stake in the business and can make decisions for the processing account. You can add only one control prong to a processing account. - **Authorized signatory** - An individual who doesn't have an equity stake in the business but can make decisions for the processing account.

businessTypeenumRequired

Type of business.

categoryCodeintegerRequired

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

merchandiseOrServiceSoldstringRequired<=125 characters

Description of the services or merchandise sold by the business.

businessStartDatedateRequired

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

timezoneenumRequired

Time zone for the processing account.

addressobjectRequired

contactMethodslist of objectsRequired

Array of contactMethod objects. One contact method must be an email address.

processingobjectRequired

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

fundingobjectRequired

Object that contains information about the funding schedule of the processing account.

pricingobjectRequired

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

signatureobjectRequired

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

websitestringOptional<=128 characters

Website address of the business.

contactslist of objectsOptional

Array of contact objects.

metadatamap from strings to stringsOptional

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

Response

Successful request. We created 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.

Path parameters

Headers

Request

Response

Errors