Retrieve funding recipient

Use this method to retrieve information about a funding recipient. To retrieve a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. **Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. Our gateway returns the following information about the funding recipient: - Tax ID and Doing Business As (DBA) name. - Address and contact details. - Funding accounts linked to the funding recipient.

Authentication

AuthorizationBearer

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

Path Parameters

recipientIdintegerRequired
Unique identifier that we assigned to the funding recipient.

Response

Successful request. Returns the requested 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