Sign in

v1

latestOpenAPI 3.0.0All rights reserved2026-07-2439128156.3 KB
Client

Retrieve Client

Retrieves the attributes and status of a Client.

get/v1/clients/{ClientID}

Path parameters

ClientIDstring required

22-character ClientID. Present in your credential file.

Response

Client's attributes are returned.

SCinteger

HTTP Status Code

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

labelstring

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]](/docs/reporting) TabaPay generates for you, and
  • in part of the URL for access to the Client WebSite.

Example response

{
  "label": "ClientLabel",
  "limits": {
    "currency": "840",
    "pull": {
      "transaction": "0.25",
      "daily": "1.00"
    },
    "push": {
      "transaction": "0.25",
      "daily": "1.00"
    }
  }
}
All 39 operations