Transactions Beneficiaries

GET /api/v1/Transactions/beneficiaries

Description

This endpoint allows retrieving a list of beneficiaries for transactions.

Headers:

• No specific headers are required.

Query Parameters:

• pageNumber: The page number to retrieve, defaults to 1 if not provided.

• pageSize: The number of beneficiaries to retrieve per page, defaults to 10 if not provided.

• version: The version of the API.

URL:

• GET: /api/v1/Transactions/beneficiaries?pageNumber={pageNumber}&pageSize={pageSize}

Response:

• 200: Success, returns a list of beneficiary responses.

Error Codes:

• 400: Bad request, the request is not valid.

• 500: Internal server error, something went wrong while processing the request.

Example Response:

HTTP/1.1 200 OK
[
  {
    "id": "123",
    "name": "Beneficiary1",
    "accountNumber": "1234567890",
    "bankCode": "123",
    "createdAt": "2024-02-16T12:00:00Z",
    "updatedAt": "2024-02-17T12:00:00Z"
  },
  {
    "id": "456",
    "name": "Beneficiary2",
    "accountNumber": "0987654321",
    "bankCode": "456",
    "createdAt": "2024-02-16T12:00:00Z",
    "updatedAt": "2024-02-17T12:00:00Z"
  },
  ...
]

Method: GET

/api/v1/Transactions/beneficiaries?pageNumber=<integer>&pageSize=<integer>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
pageNumber	<integer>
pageSize	<integer>

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "accountName": "<string>",
      "accountNumber": "<string>",
      "bankName": "<string>",
      "bankCode": "<string>",
      "ownerId": "<string>",
      "id": "<uuid>"
    },
    {
      "accountName": "<string>",
      "accountNumber": "<string>",
      "bankName": "<string>",
      "bankCode": "<string>",
      "ownerId": "<string>",
      "id": "<uuid>"
    }
  ]
}