Create funding recipient | Payroc

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Funding.FundingRecipients;
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.Funding.FundingRecipients.CreateAsync(
15	new CreateFundingRecipient {
16	IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
17	RecipientType = CreateFundingRecipientRecipientType.PrivateCorporation,
18	TaxId = "12-3456789",
19	DoingBusinessAs = "Pizza Doe",
20	Address = new Address {
21	Address1 = "1 Example Ave.",
22	Address2 = "Example Address Line 2",
23	Address3 = "Example Address Line 3",
24	City = "Chicago",
25	State = "Illinois",
26	Country = "US",
27	PostalCode = "60056"
28	},
29	ContactMethods = new List<ContactMethod>(){
30	new ContactMethod(
31	new ContactMethodEmail {
32	Value = "[email protected]"
33	}
34	),
35	new ContactMethod(
36	new ContactMethodPhone {
37	Value = "2025550164"
38	}
39	),
40	}
41	,
42	Owners = new List<Owner>(){
43	new Owner {
44	FirstName = "Jane",
45	LastName = "Doe",
46	DateOfBirth = DateOnly.Parse("1964-03-22"),
47	Address = new Address {
48	Address1 = "1 Example Ave.",
49	City = "Chicago",
50	State = "Illinois",
51	Country = "US",
52	PostalCode = "60056"
53	},
54	Identifiers = new List<Identifier>(){
55	new Identifier {
56	Type = IdentifierType.NationalId,
57	Value = "000-00-4320"
58	},
59	}
60	,
61	ContactMethods = new List<ContactMethod>(){
62	new ContactMethod(
63	new ContactMethodEmail {
64	Value = "[email protected]"
65	}
66	),
67	new ContactMethod(
68	new ContactMethodPhone {
69	Value = "2025550164"
70	}
71	),
72	}
73	,
74	Relationship = new OwnerRelationship {
75	IsControlProng = true,
76	EquityPercentage = 48.5f,
77	Title = "CFO",
78	IsAuthorizedSignatory = false
79	},
80	MiddleName = "Helen"
81	},
82	}
83	,
84	FundingAccounts = new List<FundingAccount>(){
85	new FundingAccount {
86	Type = FundingAccountType.Checking,
87	Use = FundingAccountUse.Credit,
88	NameOnAccount = "Jane Doe",
89	PaymentMethods = new List<PaymentMethodsItem>(){
90	new PaymentMethodsItem(
91	new PaymentMethodAch {
92	Value = new PaymentMethodAchValue {
93	RoutingNumber = "123456789",
94	AccountNumber = "1234567890"
95	}
96	}
97	),
98	}
99
100	},
101	}
102	,
103	Metadata = new Dictionary<string, string>(){
104	["yourCustomField"] = "abc123",
105	}
106
107	}
108	);
109	}
110
111	}

1	{
2	"recipientType": "privateCorporation",
3	"taxId": "123456789",
4	"doingBusinessAs": "string",
5	"address": {
6	"address1": "1 Example Ave.",
7	"address2": "Example Address Line 2",
8	"address3": "Example Address Line 3",
9	"city": "Chicago",
10	"state": "Illinois",
11	"country": "US",
12	"postalCode": "60056"
13	},
14	"contactMethods": [
15	{
16	"type": "email",
17	"value": "[email protected]"
18	}
19	],
20	"owners": [
21	{
22	"ownerId": 4564,
23	"link": {
24	"rel": "owner",
25	"href": "https://api.payroc.com/v1/owners/4564",
26	"method": "get"
27	}
28	}
29	],
30	"fundingAccounts": [
31	{
32	"fundingAccountId": 123,
33	"status": "approved",
34	"link": {
35	"rel": "fundingAccount",
36	"href": "https://api.payroc.com/v1/funding-accounts/123",
37	"method": "get"
38	}
39	},
40	{
41	"fundingAccountId": 124,
42	"status": "rejected",
43	"link": {
44	"rel": "fundingAccount",
45	"href": "https://api.payroc.com/v1/funding-accounts/124",
46	"method": "get"
47	}
48	}
49	],
50	"recipientId": 234,
51	"status": "approved",
52	"createdDate": "2024-07-02T15:30:00Z",
53	"lastModifiedDate": "2024-07-02T15:30:00Z",
54	"charityId": "string",
55	"metadata": {
56	"yourCustomField": "abc123"
57	}
58	}

Use this method to create a funding recipient.

A funding recipient is a business or organization that can receive funds but can’t run transactions, for example, a charity.

In the request, include the following information:

Legal information, including its tax ID, Doing Business As (DBA) name, and address.
Contact information, including the email address.
Owners’ details, including their contact details.
Funding account details.

Our gateway returns the recipientId of the funding recipient, which you can use to run follow-on actions.

Use this method to create a funding recipient. A funding recipient is a business or organization that can receive funds but can't run transactions, for example, a charity. In the request, include the following information: - Legal information, including its tax ID, Doing Business As (DBA) name, and address. - Contact information, including the email address. - Owners' details, including their contact details. - Funding account details. Our gateway returns the recipientId of the funding recipient, which you can use to run follow-on actions.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

recipientTypeenumRequired

Type or legal structure of the funding recipient.

taxIdstringRequired

Employer identification number (EIN) or Social Security number (SSN).

doingBusinessAsstringRequired

Trading name of the business or organization.

addressobjectRequired

Polymorphic object that contains address information for a funding recipient.

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

ownerslist of objectsRequired

Array of owner objects. Each object contains information about an individual who owns or manages the funding recipient.

fundingAccountslist of objectsRequired

Array of fundingAccount objects that you can use to add funding accounts to the funding recipient.

charityIdstringOptional

Government identifier of the charity.

metadatamap from strings to stringsOptional

Metadata object you can use to include custom data with your request.

Response headers

locationstring

URI reference to created resource.

Response

Successful request. We created the funding recipient.

recipientTypeenum

Type or legal structure of the funding recipient.

taxIdstring

Employer identification number (EIN) or Social Security number (SSN).

doingBusinessAsstring

Legal name of the business or organization.

addressobject

Polymorphic object that contains address information for a funding recipient.

contactMethodslist of objects

Array of polymorphic objects, which contain contact information.

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

email - Email address
phone - Phone number
mobile - Mobile number
fax - Fax number

ownerslist of objectsRead-only

Array of owner objects associated with the funding recipient.

fundingAccountslist of objectsRead-only

Array of fundingAccount objects associated with the funding recipient.

recipientIdintegerRead-only

Unique identifier that we assigned to the funding recipient.

statusenumRead-only

Indicates if we have approved the funding recipient.

Allowed values:

createdDatedatetimeRead-only

Date the funding recipient was created.

lastModifiedDatedatetimeRead-only

Date the funding recipient was last modified.

charityIdstring

Government identifier of the charity.

metadatamap from strings to strings

Metadata object you can use to include custom data with your request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

409

Conflict Error

500

Internal Server Error

Authentication

Headers

Request

Response headers

Response

Errors