GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

List All Notes

Notes can be associated with a Business or Recipient Financial Account, Recipient Account, Team Member, or transaction.

Use the entityId query parameter to retrieve notes for a specific entity (such as a transaction), or use the entityType query parameter to retrieve notes for a type of entity (such as all transactions). Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /api/external/v1/notes

Authorization Header

Basic Auth REQUIRED

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

Query Parameters

entityId REQUIRED

string (UUID)

ID of the entity for which you want to retrieve notes. This can be a Financial Account, Recipient Account, Team Member, or transaction.

entityType REQUIRED

string, values: FINANCIAL_ACCOUNT, RECIPIENT, TEAM_MEMBER, TRANSACTION

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

sort

string

Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.

page

integer (int32)

Page number to return.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of note objects. The following fields are returned for each note.

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.

businessAccountId

string (UUID)

Business Account ID for the user that created the note.

entityType

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

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.

SAMPLE RESPONSE

				
					{
  "totalElements": 100,
  "totalPages": 50,
  "number": 1,
  "numberOfElements": 2,
  "hasNext": true,
  "content": [
    {
      "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
      "createdAt": "2021-09-20T22:09:31.947Z",
      "updatedAt": "2021-09-20T22:09:31.947Z",
      "createdBy": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
      "state": "ACTIVE",
      "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
      "entityType": "FINANCIAL_ACCOUNT",
      "entityId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
      "title": "USD",
      "contentText": "Account uses USD funds.",
      "contentType": "",
      "externalUrl": "",
      "sizeInBytes": 0
    },
    {
      "id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
      "createdAt": "2021-10-20T22:09:31.947Z",
      "updatedAt": "2021-01-20T22:09:31.947Z",
      "createdBy": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
      "state": "ACTIVE",
      "businessAccountId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
      "entityType": "FINANCIAL_ACCOUNT",
      "entityId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
      "title": "Joint Account",
      "contentText": "Joint account.",
      "contentType": "",
      "externalUrl": "",
      "sizeInBytes": 0
    }
  ]
}