Create processing account

POST

/merchant-platforms/:merchantPlatformId/processing-accounts

POST

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

1 using Payroc;
2 using System.Threading.Tasks;
3 using Payroc.Boarding.MerchantPlatforms;
4 using System.Collections.Generic;
5 using System;
6 
7 namespace Usage;
8 
9 public class Example
10 {
11     public async Task Do() {
12         var client = new PayrocClient();
13 
14         await client.Boarding.MerchantPlatforms.CreateProcessingAccountAsync(
15             new CreateProcessingAccountMerchantPlatformsRequest {
16                 MerchantPlatformId = "12345",
17                 IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
18                 Body = new CreateProcessingAccount {
19                     DoingBusinessAs = "Pizza Doe",
20                     Owners = new List<Owner>(){
21                         new Owner {
22                             FirstName = "Jane",
23                             LastName = "Doe",
24                             DateOfBirth = DateOnly.Parse("1964-03-22"),
25                             Address = new Address {
26                                 Address1 = "1 Example Ave.",
27                                 City = "Chicago",
28                                 State = "Illinois",
29                                 Country = "US",
30                                 PostalCode = "60056",
31                                 Address2 = "Example Address Line 2",
32                                 Address3 = "Example Address Line 3"
33                             },
34                             Identifiers = new List<Identifier>(){
35                                 new Identifier {
36                                     Type = IdentifierType.NationalId,
37                                     Value = "000-00-4320"
38                                 },
39                             }
40                             ,
41                             ContactMethods = new List<ContactMethod>(){
42                                 new ContactMethod(
43                                     new ContactMethodEmail {
44                                         Value = "[email protected]"
45                                     }
46                                 ),
47                             }
48                             ,
49                             Relationship = new OwnerRelationship {
50                                 IsControlProng = true,
51                                 EquityPercentage = 51.5f,
52                                 Title = "CFO",
53                                 IsAuthorizedSignatory = false
54                             },
55                             MiddleName = "Helen"
56                         },
57                     }
58                     ,
59                     BusinessType = CreateProcessingAccountBusinessType.Restaurant,
60                     CategoryCode = 5999,
61                     MerchandiseOrServiceSold = "Pizza",
62                     BusinessStartDate = DateOnly.Parse("2020-01-01"),
63                     Timezone = Timezone.AmericaChicago,
64                     Address = new Address {
65                         Address1 = "1 Example Ave.",
66                         Address2 = "Example Address Line 2",
67                         Address3 = "Example Address Line 3",
68                         City = "Chicago",
69                         State = "Illinois",
70                         Country = "US",
71                         PostalCode = "60056"
72                     },
73                     ContactMethods = new List<ContactMethod>(){
74                         new ContactMethod(
75                             new ContactMethodEmail {
76                                 Value = "[email protected]"
77                             }
78                         ),
79                     }
80                     ,
81                     Processing = new Processing {
82                         TransactionAmounts = new ProcessingTransactionAmounts {
83                             Average = 5000,
84                             Highest = 10000
85                         },
86                         MonthlyAmounts = new ProcessingMonthlyAmounts {
87                             Average = 50000,
88                             Highest = 100000
89                         },
90                         VolumeBreakdown = new ProcessingVolumeBreakdown {
91                             CardPresent = 77,
92                             MailOrTelephone = 3,
93                             Ecommerce = 20
94                         },
95                         IsSeasonal = true,
96                         MonthsOfOperation = new List<ProcessingMonthsOfOperationItem>(){
97                             ProcessingMonthsOfOperationItem.Jan,
98                             ProcessingMonthsOfOperationItem.Feb,
99                         }
100                         ,
101                         Ach = new ProcessingAch {
102                             Refunds = new ProcessingAchRefunds {
103                                 WrittenRefundPolicy = true,
104                                 RefundPolicyUrl = "www.example.com/refund-poilcy-url"
105                             },
106                             EstimatedMonthlyTransactions = 3000,
107                             Limits = new ProcessingAchLimits {
108                                 SingleTransaction = 10000,
109                                 DailyDeposit = 200000,
110                                 MonthlyDeposit = 6000000
111                             },
112                             Naics = "5812",
113                             PreviouslyTerminatedForAch = false,
114                             TransactionTypes = new List<ProcessingAchTransactionTypesItem>(){
115                                 ProcessingAchTransactionTypesItem.PrearrangedPayment,
116                                 ProcessingAchTransactionTypesItem.Other,
117                             }
118                             ,
119                             TransactionTypesOther = "anotherTransactionType"
120                         },
121                         CardAcceptance = new ProcessingCardAcceptance {
122                             DebitOnly = false,
123                             HsaFsa = false,
124                             CardsAccepted = new List<ProcessingCardAcceptanceCardsAcceptedItem>(){
125                                 ProcessingCardAcceptanceCardsAcceptedItem.Visa,
126                                 ProcessingCardAcceptanceCardsAcceptedItem.Mastercard,
127                             }
128                             ,
129                             SpecialityCards = new ProcessingCardAcceptanceSpecialityCards {
130                                 AmericanExpressDirect = new ProcessingCardAcceptanceSpecialityCardsAmericanExpressDirect {
131                                     Enabled = true,
132                                     MerchantNumber = "abc1234567"
133                                 },
134                                 ElectronicBenefitsTransfer = new ProcessingCardAcceptanceSpecialityCardsElectronicBenefitsTransfer {
135                                     Enabled = true,
136                                     FnsNumber = "6789012"
137                                 },
138                                 Other = new ProcessingCardAcceptanceSpecialityCardsOther {
139                                     WexMerchantNumber = "abc1234567",
140                                     VoyagerMerchantId = "abc1234567",
141                                     FleetMerchantId = "abc1234567"
142                                 }
143                             }
144                         }
145                     },
146                     Funding = new CreateFunding {
147                         FundingSchedule = CommonFundingFundingSchedule.Nextday,
148                         AcceleratedFundingFee = 1999,
149                         DailyDiscount = false,
150                         FundingAccounts = new List<FundingAccount>(){
151                             new FundingAccount {
152                                 Type = FundingAccountType.Checking,
153                                 Use = FundingAccountUse.CreditAndDebit,
154                                 NameOnAccount = "Jane Doe",
155                                 PaymentMethods = new List<PaymentMethodsItem>(){
156                                     new PaymentMethodsItem(
157                                         new PaymentMethodAch {
158                                             Value = new PaymentMethodAchValue {
159                                                 RoutingNumber = "123456789",
160                                                 AccountNumber = "1234567890"
161                                             }
162                                         }
163                                     ),
164                                 }
165                                 ,
166                                 Metadata = new Dictionary<string, string>(){
167                                     ["yourCustomField"] = "abc123",
168                                 }
169 
170                             },
171                         }
172 
173                     },
174                     Pricing = new Pricing(
175                         new PricingTemplate {
176                             PricingIntentId = "6123"
177                         }
178                     ),
179                     Signature = new Signature(
180                         new SignatureByDirectLink()
181                     ),
182                     Website = "www.example.com",
183                     Contacts = new List<Contact>(){
184                         new Contact {
185                             Type = ContactType.Manager,
186                             FirstName = "Jane",
187                             LastName = "Doe",
188                             Identifiers = new List<Identifier>(){
189                                 new Identifier {
190                                     Type = IdentifierType.NationalId,
191                                     Value = "000-00-4320"
192                                 },
193                             }
194                             ,
195                             ContactMethods = new List<ContactMethod>(){
196                                 new ContactMethod(
197                                     new ContactMethodEmail {
198                                         Value = "[email protected]"
199                                     }
200                                 ),
201                             }
202                             ,
203                             MiddleName = "Helen"
204                         },
205                     }
206                     ,
207                     Metadata = new Dictionary<string, string>(){
208                         ["customerId"] = "2345",
209                     }
210 
211                 }
212             }
213         );
214     }
215 
216 }

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

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

Authentication

AuthorizationBearer

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

Path parameters

merchantPlatformIdstringRequired

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

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.

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

Polymorphic object that contains address information for the processing account.

contactMethodslist of objectsRequired

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.

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

Polymorphic object that contains pricing information for the processing account.

The value of the type parameter determines which variant you should use:

intent - Use a pricing agreement template.
agreement - Create a new pricing agreement.

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.

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 headers

locationstring

URI reference to the resource.

Response

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

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.

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.

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.

linkslist of objects

Array of useful links related to your request.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response headers

Response

Errors