fundingRecipients

Retrieve funding recipient

Changed on

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

Note: If you don't have the recipientId, use our List Funding Recipients 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.
get/funding-recipients/{recipientId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/funding-recipients/{recipientId}
  • Auth
    HTTP bearer

Path parameters

recipientIdinteger required

Unique identifier that we assigned to the funding recipient.

Response

Successful request. Returns the requested funding recipient.

recipientIdinteger

Unique identifier that we assigned to the funding recipient.

status'approved' | 'rejected' | 'pending'

Indicates if we have approved the funding recipient.

createdDatestring date-time

Date the funding recipient was created.

lastModifiedDatestring date-time

Date the funding recipient was last modified.

recipientType'privateCorporation' | 'publicCorporation' | 'nonProfit' | 'government' | 'privateLlc' | 'publicLlc' | 'privatePartnership' | 'publicPartnership' | 'soleProprietor' required

Type or legal structure of the funding recipient.

taxIdstring required

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

charityIdstring

Government identifier of the charity.

doingBusinessAsstring required

Legal name of the business or organization.

metadataobject

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

Changes