fundingRecipients

Create funding recipient

Changed on

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.

post/funding-recipients

Request

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

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

recipientIdinteger
status'approved' | 'rejected' | 'pending'
createdDatestring date-time
lastModifiedDatestring date-time
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

Trading name of the business or organization.

metadataobject

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

Response

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