Skip to content
payrocdevelopers

Update funding recipient

Browse API reference

PUT/funding-recipients/{recipientId}updateFundingRecipient

Use this method to update the details of a funding recipient. If a request contains significant changes, we might need to re-approve the funding recipient.

To update a funding recipient, you need it's 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.

You can update the following details of a funding recipient:

  • Doing Business As (DBA) name
  • Tax ID and charity ID
  • Address and contact methods

Parameters

NameInTypeDescription
recipientIdRequiredpathinteger

Unique identifier that we assigned to the funding recipient.

Request body

application/json
Field Edit request inputs →
  • addressobjectrequired
    Polymorphic object that contains address information for a funding recipient.
    • addressobject
      Object that contains information about the address.
      • address1stringrequired
        Address line 1.≤ 150 chars
      • address2string
        Address line 2.≤ 150 chars
      • address3string
        Address line 3.≤ 150 chars
      • citystringrequired
        City.≤ 50 chars
      • countrystringrequired
        Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
      • postalCodestringrequired
        Zip code or postal code.≤ 10 chars
      • statestringrequired
        Name of the state or state abbreviation.≤ 50 chars
  • charityIdstring
    Government identifier of the charity.
  • contactMethodsobject[]required
    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≥ 1 items
    • emailobject
      • typestringrequired
        Type of contact method.email
      • valuestringrequired
        Email address.≤ 50 chars
    • phoneobject
      • typestringrequired
        Type of contact method.phone
      • valuestringrequired
        Phone number.≤ 15 chars
    • mobileobject
      • typestringrequired
        Type of contact method.mobile
      • valuestringrequired
        Mobile number.≤ 15 chars
    • faxobject
      • typestringrequired
        Type of contact method.fax
      • valuestringrequired
        Fax number.≤ 15 chars
  • doingBusinessAsstringrequired
    Legal name of the business or organization.
  • metadataobject
    Metadata object you can use to include custom data with your request.
  • recipientTypestringrequired
    Type or legal structure of the funding recipient.privateCorporationpublicCorporationnonProfitgovernmentprivateLlcpublicLlcprivatePartnershippublicPartnership+1 more
  • taxIdstringrequired
    Employer identification number (EIN) or Social Security number (SSN).

Responses

Successful request. We updated the funding recipient.

No response body — a 204 means the action took effect.

Used in workflows

update-a-funding-recipient

Search documentation

API reference169
Guides118
Knowledge38
legal1
Solutions32
Workflows74
↑↓highlight↵openView all search results

Menu

Theme

Sign out

Your saved plans remain in your organization. This browser’s private draft and account view will be cleared.

Talk to an engineer