Maintain Clients

Overview

Maintain Client records (Add, Edit, Retrieve).

Path

/v1/realpay/{merchant_number}/maintain/clients/{product}

Path Parameters

• merchant_number (string, required)
• product (string, required)

Common Query Parameters

• Version (string, required, default: v1)

---

POST Add Client

Add a client record to the specified product.

Additional Query Parameters

(None beyond common)

Request Body Schema (POST)

ClientPostRequest (array of Client)

Request Example (POST)

{
  "ClientPostRequest": [
    {
      "ClientNumber": "L00012",
      "ClientName": "John Smith",
      "IDType": "I",
      "IDNumber": "8813053807087",
      "CellphoneNumber": "+27823748818",
      "EMail": "jsmith@ourcompany.com",
      "BankCode": 4,
      "BranchCode": 250655,
      "AccountType": 1,
      "AccountNumber": 18720129622,
      "AccountHolderName": "J Smith"
    }
  ]
}

Success Response (200) Schema (POST)

ClientPostResponse

Response Example (POST)

{
  "ClientPostResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ClientName": "John Smith",
          "IDType": "I",
          "IDNumber": "8813053807087",
          "CellphoneNumber": "+27823748818",
          "EMail": "jsmith@ourcompany.com",
          "BankCode": 4,
          "BranchCode": 250655,
          "AccountType": 1,
          "AccountNumber": 18720129622,
          "AccountHolderName": "J Smith"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
  "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit Client

Edit a client record for the specified product.

Request Body Schema (PUT)

ClientPutRequest (array of Client)

Request Example (PUT)

{
  "ClientPutRequest": [
    {
      "ClientNumber": "L00012",
      "ClientName": "John Smith",
      "IDType": "I",
      "IDNumber": "8813053807087",
      "CellphoneNumber": "+27823748818",
      "EMail": "jsmith@ourcompany.com",
      "BankCode": 4,
      "BranchCode": 250655,
      "AccountType": 1,
      "AccountNumber": 18720129622,
      "AccountHolderName": "J Smith"
    }
  ]
}

Success Response (200) Schema (PUT)

ClientPutResponse

Response Example (PUT)

{
  "ClientPutResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ClientName": "John Smith",
          "IDType": "I",
          "IDNumber": "8813053807087",
          "CellphoneNumber": "+27823748818",
          "EMail": "jsmith@ourcompany.com",
          "BankCode": 4,
          "BranchCode": 250655,
          "AccountType": 1,
          "AccountNumber": 18720129622,
          "AccountHolderName": "J Smith"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
  "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve Client Record

Retrieve a client record for the specified product.

Additional Query Parameters (GET)

• ClientNumber (string, optional): The Client Number to retrieve.

Success Response (200) Schema (GET)

ClientGetResponse

Response Example (GET)

{
  "ClientGetResponse": [
    {
      "ClientNumber": "L00012",
      "ClientName": "John Smith",
      "IDType": "I",
      "IDNumber": "8813053807087",
      "CellphoneNumber": "+27823748818",
      "EMail": "jsmith@ourcompany.com",
      "BankCode": 4,
      "BranchCode": 250655,
      "AccountType": 1,
      "AccountNumber": 18720129622,
      "AccountHolderName": "J Smith"
    }
  ],
  "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