GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Create a Note

Create a note for a Business or Recipient Financial Account, Recipient Account, Team Member, or transaction. A note includes a title (title) and body (contentText).

Endpoint

POST /api/external/v1/notes

Authorization Header

Basic Auth  REQUIRED

username is your API key ID and password is your API key secret.

Request Body

businessAccountId  REQUIRED

string (UUID)

Business Account ID for the user that created the note.

entityType  REQUIRED

string enum, values: FINANCIAL_ACCOUNT, RECIPIENT, TEAM_MEMBER, TRANSACTION

Type of entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

entityId  REQUIRED

string (UUID)

ID of the entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

title

string

Note title.

contentText

string, max length: 1000, min length: 0

Note content.

contentType

string

Reserved for future use.

externalUrl

string

Reserved for future use.

sizeInBytes

integer (int64)

Reserved for future use.

Returns

Returns the note details, including a unique ID for the note. The request body and the following fields are returned.

id

string (UUID)

Unique ID assigned to the note.

createdAt

string (date-time)

Date and time the note was created.

updatedAt

string (date-time)

Date and time the note was last updated.

createdBy

string (UUID)

ID of the user that created the note.

state

string enum, value: ACTIVE

Note state (ACTIVE). The ACTIVE state is assigned when the note is created.

SAMPLE REQUEST

				
					{
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account."
}
				
			

SAMPLE RESPONSE

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedAt": "2021-09-20T22:09:31.947Z",
  "createdBy": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
  "state": "ACTIVE",
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account.",
  "contentType": "",
  "externalUrl": "",
  "sizeInBytes": 0
}