Skip to content

Maintain Account verification

Overview

Account Verification (AVSR) requests and retrieval.

Path

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

Path Parameters

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

Common Query Parameters

  • Version (string, required, default: v1)

POST Submit Account Verification

Submit an AVSR (Account Verification) request.

Request Body Schema (POST)

AVSRPostRequest (array of AVSR)

Request Example (POST)

{
  "AVSRPostRequest": [
    {
      "BankCode": 4,
      "BranchCode": 250655,
      "AccountType": 1,
      "AccountNumber": 18720129622,
      "IDNumber": "8813053807087",
      "Initials": "JS",
      "ClientName": "John Smith",
      "EMail": "jsmith@ourcompany.com",
      "CellphoneNumber": "+27823748818"
    }
  ]
}

Success Response (200) Schema (POST)

AVSRPostResponse

Response Example (POST)

{
  "AVSRPostResponse": [
    {
      "Successful": [
        {
          "AVSRReferenceNumber": "AV123456",
          "BankCode": 4,
          "BranchCode": 250655,
          "AccountType": 1,
          "AccountNumber": 18720129622,
          "IDNumber": "8813053807087",
          "ClientName": "John Smith"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

GET Retrieve Account Verification

Retrieve AVSR result by AVSRReferenceNumber.

Additional Required Query Parameters (GET)

  • AVSRReferenceNumber (string)

Success Response (200) Schema (GET)

AVSRGetResponse

Response Example (GET)

{
  "AVSRGetResponse": [
    {
      "AVSRReferenceNumber": "AV123456",
      "BankCode": 4,
      "BranchCode": 250655,
      "AccountType": 1,
      "AccountNumber": 18720129622,
      "IDNumber": "8813053807087",
      "ClientName": "John Smith",
      "MatchYN": "Y"
    }
  ],
  "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