/api/v1/banking/notes/{profileId}

API Method: GET /api/v1/banking/notes/{profileId}

Description:

This API endpoint is used to retrieve notes or comments associated with a merchant's submitted banking services application. The notes may include feedback, clarifications, or status updates added by the payment processor or administrative staff. These notes help track the progress of the application and provide insights into any required follow-ups or additional actions.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/banking/notes/{profileId}

Path Parameters:

• profileId (required):
  A unique identifier for the specific profile or banking services application for which the notes are being requested.
  • Type: String
  • Example: /api/v1/banking/notes/12345

Response:

• Status Code:

  • 200 OK: If the notes for the application are successfully retrieved.
  • 400 Bad Request: If the profileId is invalid or missing.
  • 404 Not Found: If no notes are found for the given profileId.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response will include a JSON array of notes related to the specified profileId. Each note contains details such as the date the note was added, the author of the note, and the content.

Response Fields:

• profileId: The unique identifier for the profile or banking application.

  • Type: String
  • Example: "profileId": "12345"

• notes: An array of note objects. Each object contains the following fields:

  • noteId: A unique identifier for the note.

    • Type: String
    • Example: "noteId": "note-123"

  • author: The person or system that added the note (e.g., admin, reviewer).

    • Type: String
    • Example: "author": "Jane Smith"

  • dateAdded: The timestamp when the note was added.

    • Type: String (ISO 8601 format)
    • Example: "dateAdded": "2024-10-01T14:25:00Z"

  • content: The actual text of the note.

    • Type: String
    • Example: "content": "Additional verification required for tax documents."

Example Request:

GET /api/v1/banking/notes/67890XYZ

Example Response:

{
  "notes": [
    {
      "noteId": "note-123",
      "author": "Jane Smith",
      "dateAdded": "2024-10-01T14:25:00Z",
      "content": "Additional verification required for tax documents."
    },
    {
      "noteId": "note-124",
      "author": "John Doe",
      "dateAdded": "2024-10-03T09:15:00Z",
      "content": "Banking details have been verified. Awaiting final approval."
    }
  ]
}

Use Case:

This API method is particularly useful for ISO/ISV or administrative teams to monitor the progress of their submitted banking services application. By retrieving notes, they can stay informed about any additional requirements, delays, or approvals needed during the application process.