Bank Transfers Search

POST /api/v1/BankTransfers/search

Description

This endpoint is used to search for bank transfers based on a search string.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain
• application/json
• text/json

Query Parameters:

• version: string, required
• PageNumber: integer, optional, default is 1
• PageSize: integer, optional, default is 10
• searchText: string, optional, nullable

Request Body:

• No request body is required

URL:
{{baseUrl API url}}/api/v1/BankTransfers/search?PageNumber=1&PageSize=10&searchText=ABC

Response:

• A BankTransferResponseListPagedResponse object.

Error Codes:

• 400: Bad Request
• 404: Resource not found
• 500: Internal server error

Example:

GET /api/v1/BankTransfers/search?PageNumber=1&PageSize=10&searchText=ABC

Response:

HTTP/1.1 200 OK
{
  "BankTransfers": [
    {
      "transactionId": "1234567890",
      "amount": 1000
    },
    {
      "transactionId": "1234567891",
      "amount": 500
    }
  ],
  "TotalCount": 2
}

Method: GET

/api/v1/BankTransfers/search?PageNumber=<integer>&PageSize=<integer>&searchText=<string>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PageNumber	<integer>
PageSize	<integer>
searchText	<string>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "reference": "<string>",
      "amount": "<double>",
      "account": {
        "accountName": "<string>",
        "accountNumber": "<string>",
        "bankName": "<string>"
      },
      "beneficiary": {
        "accountName": "<string>",
        "accountNumber": "<string>",
        "bankName": "<string>"
      },
      "status": "<string>",
      "date": "<dateTime>",
      "tenantId": "<uuid>",
      "email": "<string>",
      "currency": "<string>"
    },
    {
      "id": "<uuid>",
      "reference": "<string>",
      "amount": "<double>",
      "account": {
        "accountName": "<string>",
        "accountNumber": "<string>",
        "bankName": "<string>"
      },
      "beneficiary": {
        "accountName": "<string>",
        "accountNumber": "<string>",
        "bankName": "<string>"
      },
      "status": "<string>",
      "date": "<dateTime>",
      "tenantId": "<uuid>",
      "email": "<string>",
      "currency": "<string>"
    }
  ]
}