Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TabaPay SubClient API

This resource represents a Client's SubClient.

TabaPay SubClient API is one of 16 APIs that TabaPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SubClient. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 2 paths, and defines 38 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://{FQDN}:{PORT}.

8 operations 2 paths 38 schemas 2 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.tabapay.com
Authentication
HTTP Bearer, API Key
License
All rights reserved
Resource Areas
1

Authentication & Security 2

TabaPay SubClient API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 8

Across 2 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

SubClient 8

This resource represents a Client's SubClient.

POST
/v4/clients/{ClientID}/subclients/{SubClientID}
Create SubClient
createsubclient 2 params body → 200207
DELETE
/v4/clients/{ClientID}/subclients/{SubClientID}
Delete SubClient
deletesubclient 2 params → 200404
GET
/v4/clients/{ClientID}/subclients/{SubClientID}
Retrieve SubClient
retrievesubclient 2 params → 200404
PUT
/v4/clients/{ClientID}/subclients/{SubClientID}
Update SubClient
updatesubclient 2 params body → 200
POST
/v2/clients/{ClientID}/subclients/{SubClientID}
Create SubClient
createsubclient2 2 params body → 200207
DELETE
/v2/clients/{ClientID}/subclients/{SubClientID}
Delete SubClient
deletesubclient2 2 params → 200404
GET
/v2/clients/{ClientID}/subclients/{SubClientID}
Retrieve SubClient
retrievesubclient2 2 params → 200404
PUT
/v2/clients/{ClientID}/subclients/{SubClientID}
Update SubClient
updatesubclient2 2 params body → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are retrieveSubClient2Response (30 properties), subclient2Create (27 properties), subclient2Update (27 properties), fees (26 properties). Each schema is shown below with its type and property counts.

businessOwner
object
Additional individuals that own at least 25% of the entity.
4 properties 3 required
retrieveSubClientResponse
object
16 properties
businessOwners
object
Individuals that own at least 25% of the entity, or the largest owner if no one owns at least 25%. Note: If you plan to add/remove/modify any owner information…
4 properties 1 required
routingNumber
string
[ABA routing transit number](https://en.wikipedia.org/wiki/ABAroutingtransitnumber)
subclient2Update
object
Partial update; only supplied fields are updated.
27 properties
cardTypeFee
object
Card Type Fee
8 properties
subclient2SettlementAccount
object
3 properties
subclient2NetworkConfig
object
2 properties
address
object
Address
6 properties 4 required
apiResponseSCECEM
object
3 properties
city
string
City
subclient2CardTypes
object
2 properties
line1
string
Address Line 1
subclient2TransactionTypes
object
2 properties
apiResponseSCEC
object
2 properties
fees
object
Set fees for this subclient. For more information refer to: [Fees for Sub-Clients during Boarding](https://developers.tabapay.com/docs/fees-for-sub-clients-dur…
26 properties 1 required
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
subclient2Identification
object
3 properties
email
string
Valid Email Address
retrieveSubClient2Response
object
30 properties
tpISO4217Numeric
string
ISO-4217 numeric currency code
tpLedgerID
string
TabaPay ledger identifier
subclient2Create
object
27 properties 2 required
subclient2Settlement
object
5 properties
zipcode
string
Zip Code If country is 840, zipcode must be 5 or 9 digits. If country is 124, zipcode must be in the A1A 1A1 format. Zip codes from other countries will not be…
EM
string
Short description of the error if an error occurred.
createSubClientResponse
object
3 properties
tpUserID
string
TabaPay user identifier
state
string
State Code [State Code](https://developers.tabapay.com/reference/us-state-codes/) must be a valid 2-character code if country is [840](https://developers.tabap…
phone
object
Phone object
2 properties 1 required
country
string
[Country Code](https://developers.tabapay.com/reference/country-codes/) Optional. Default is 840
EC
string
Internal Error Code. This is used to help TabaPay team members trace an error.
subclient2NetworkDirection
object
2 properties
line2
string
Address Line 2 Optional
subclientCreate
object
14 properties 7 required
subclientUpdate
object
14 properties
reserveAccount
object
Set reserve account for this subclient. If you add a reserve account, you will need a routing number and an account number.
6 properties 2 required
subclient2CardTypesDirection
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabapay-subclient-api-openapi.yml Raw ↑

Other APIs TabaPay publishes across the network.

TabaPay 3D Secure API
TabaPay Account API
TabaPay Bank API
TabaPay Card API
TabaPay Client API
TabaPay FXRate API
TabaPay Health API
TabaPay Key API
TabaPay Ledger API
TabaPay OFAC API
TabaPay Tag API
TabaPay Transaction API