GET Beneficiary users

Overview

Returns Beneficiary Users this user is linked to.

HTTP Request

GET /v1/realpay/{merchant_number}/general/beneficiary_users

Path Parameters

• merchant_number (string, required)

Query Parameters

• Version (string, required, default: v1)

Success Response (200)

Schema: BeneficiaryUserGetResponse

Example

{
  "BeneficiaryUserGetResponse": [
    {
      "BeneficiaryUser": 919191,
      "BeneficiaryUserDescription": "My Company Name"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• BeneficiaryUserGetResponse[].BeneficiaryUser (number, maxLength 6)
• BeneficiaryUserGetResponse[].BeneficiaryUserDescription (string, maxLength 40)

Error Responses

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