fundingRecipients

Create funding recipient owner

Changed on

Use this method to add an additional owner to a funding recipient.

To add an owner to a funding recipient, you need the 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.

In the request, include the following information about the owner:

  • Name, date of birth, and address.
  • Contact details, including their email address.
  • Relationship to the funding recipient, including whether they are a control prong.

In the response, our gateway returns the ownerId, which you can use to run follow-on actions.

post/funding-recipients/{recipientId}/owners

Request

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

Path parameters

recipientIdinteger required

Unique identifier that we assigned to the funding recipient.

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

ownerIdinteger

Unique identifier that we assigned to the owner.

firstNamestring required

Owner's first name.

middleNamestring

Owner's middle name.

lastNamestring required

Owner's last name.

dateOfBirthstring date required

Owner's date of birth. The format of this value is YYYY-MM-DD.

Response

Successful request. We created the owner and added it to the funding recipient.

ownerIdinteger

Unique identifier that we assigned to the owner.

firstNamestring required

Owner's first name.

middleNamestring

Owner's middle name.

lastNamestring required

Owner's last name.

dateOfBirthstring date required

Owner's date of birth. The format of this value is YYYY-MM-DD.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id createOwner removed and replaced with fundingRecipients_createOwner