SchemaFundingFunding Recipients

Create funding recipient

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.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

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
Address of the funding recipient.
contactMethodslist of objectsRequired
Array of contactMethod objects that you can use to add contact methods for the funding recipient. You must provide at least an email address.
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

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
Address of the funding recipient.
contactMethodslist of objects
Array of contactMethod objects for the funding recipient.
ownerslist of objects
Array of owner objects associated with the funding recipient.
fundingAccountslist of objects
Array of fundingAccount objects associated with the funding recipient.
recipientIdinteger or null
Unique identifier that we assigned to the funding recipient.
statusenum or null
Indicates if we have approved the funding recipient.
Allowed values:
createdDatedatetime or null
Date the funding recipient was created.
lastModifiedDatedatetime or null
Date the funding recipient was last modified.
charityIdstring or null
Government identifier of the charity.
metadatamap from strings to strings or null

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

Errors