Retrieve Client

Retrieves the attributes of a Client.


URL:

https://<FQDN>/v1/clients/<ClientID>


Request:

No Request Data


Response:

Status Codes:

Status Codes
 
Status Code Description
200 OK The Client's Attributes are returned.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O
label String
(no whitespaces)
Client Label
networks object List of Available Networks
pull array
of Strings
For Pull Transactions
Array can be empty or is a List of Network Names
push array
of Strings
For Push Transactions
Array can be empty or is a List of Network Names
limits object
currency String
3-digit code
ISO 4217 Currency Number
pull object
transaction String
Amount
Pull Transaction Limit
daily String
Amount
Approximate Pull Daily Limit
networks array
of objects
List of Network Limits
Network is listed only if different from above Pull Limits
O
network String Network Name
transaction String
Amount
Network Pull Transaction Limit
daily String
Amount
Approximate Network Pull Daily Limit
push object
transaction String
Amount
Push Transaction Limit
daily String
Amount
Approximate Push Daily Limit
networks array
of objects
List of Network Limits
Network is listed only if different from above Push Limits
O
network String Network Name
transaction String
Amount
Network Push Transaction Limit
daily String
Amount
Approximate Network Push Daily Limit

Sample responses:

Client's Attributes returned:
{
  "SC": 200,
  "EC": "0",
  "label": "ClientLabel",
  "networks":
  {
    "pull":
    [
      "STAR",
      "Visa"
    ],
    "push":
    [
      "STAR",
      "CU24",
      "Visa"
    ]
  },
  "limits":
  {
    "currency": "840",
    "pull":
    {
      "transaction": "0.25",
      "daily": "1.00"
    },
    "push":
    {
      "transaction": "0.25",
      "daily": "1.00",
      "networks":
      [
        {
          "network": "CU24",
          "transaction": "0.20",
          "daily": "1.00"
        }
      ]
    }
  }
}

------------------------
Client not found:
{
  "SC": 404,
  "EC": "3A100000",
  "EM": "Not Found"
}

------------------------
Client locked:
{
  "SC": 423,
  "EC": "3A100000",
  "EM": "Locked"
}

Notes:

The Client Label is the human readable identifier used to identify you versus using your ClientID. It may be used:

  • in part of the file name for various Reports we generate for you, and
  • in part of the URL for access to the Client WebSite.