INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Note Use Cases  /  Retrieve Note Details

Retrieve Note Details

Overview

In this use case, we’ll walk through retrieving detailed information for a note. A note can be attached to Financial Account, Recipient Account, Team Member, or transaction.

API Operation

Steps

Send a request to the following endpoint:

GET ​/api​/external​/v1​/notes​/{id}

  • Use the {id} path parameter to specify the ID of the note you want to retrieve.
  • Request body is not required.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Response

The note details are returned.

				
					{
  "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
}
				
			
ON THIS PAGE