Skip to content

Reports Search clients

Overview

Retrieve client details using flexible search options.

Path

/v1/realpay/{merchant_number}/reports/search_clients

Path Parameters

  • merchant_number (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Search Query Parameters (at least one required)

  • ClientNumber (string)
  • ClientIDNumber (string)
  • ClientName (string)
  • ClientSurname (string)
  • ClientCellNumber (string)
  • ClientEmailAddress (string)

GET Search Clients

Search for clients.

Success Response (200) Schema

SearchClientsGetResponse

Response Example (200)

{
  "SearchClientsGetResponse": [
    {
      "ClientNumber": "L11306666",
      "IDNumber": "8106125027097",
      "ClientStatus": "ACTIVE",
      "ClientStatusDate": "2024-05-01 10:15",
      "ClientName": "Jane",
      "ClientSurname": "Doe",
      "CellNumber": "0821234567",
      "EmailAddress": "jane.doe@example.com"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

  • 400 BadRequest
  • 401 Unauthorized
  • 404 NotFound
  • 500 InternalError
  • 503 ServiceUnavailable