SchemaFundingFunding Recipients

Create funding recipient

Create a funding recipient.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequired

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

This endpoint expects an object.
recipientTypeenumRequired
Type or legal structure of the funding recipient.
taxIdstringRequired

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

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 that you can use to add owners to 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.
doingBusinessAsstringOptional
Legal name that the business operates under.
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).

doingBuinessAsstring
Legal name that the business operates under.
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 of 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