Coming Soon
Retrieves a Client's SubClient Registration.
For ISOs (Independent Sales Organization) only.
URL:
https://<FQDN>/v4/clients/<ClientID>/subclients/<SubClientID>
Request:
No Request Data
Response:
Status Codes:
Status Code | Description | |
---|---|---|
200 | OK | The Transaction is retrieved. |
404 | Not Found | SubClient Registration not found. |
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 | |||
name | String | Company Name | ✔ | |||
tin | String 9 digits |
Taxpayer Identification Number (EIN or SSN) | ✔ | |||
type | String | Company Type | ✔ | |||
url | String | URL | O | |||
String | ✔ | |||||
address | object | Address | ✔ | |||
line1 | String | Address Line 1 | ✔ | |||
line2 | String | Address Line 2 | O | |||
city | String | City | ✔ | |||
state | String 2-character code |
State Code | ✔ | |||
zipcode | String | Zip Code | ✔ | |||
country | String 3-digit code |
ISO 3166-1 Country Code | O | |||
phone | object | Phone Number (E.164 Numbering) | ✔ | |||
countryCode | String 1-3 digits |
Country Calling Code | O | |||
number | String Min: 4 digits Max: 12-14 digits |
Phone Number | ✔ | |||
mcc | String 4 digits |
Merchant Category Code | ✔ | |||
mvv | String 6 digits |
Visa Merchant Verification Code | O | |||
maid | String 6 digits |
MasterCard Identification | O | |||
settlement | object | Settlement Accounts | O | |||
purchase | object | Purchase | ✔ | |||
routingNumber | String 9 digits |
Routing Number | ✔ | |||
accountNumber | String 4-17 digits |
Account Number | ✔ | |||
disbursement | object | Disbursement | ✔ | |||
routingNumber | String 9 digits |
Routing Number | ✔ | |||
accountNumber | String 4-17 digits |
Account Number | ✔ | |||
fee | object | Fee | ✔ | |||
routingNumber | String 9 digits |
Routing Number | ✔ | |||
accountNumber | String 4-17 digits |
Account Number | ✔ | |||
exception | object | Exception | ✔ | |||
routingNumber | String 9 digits |
Routing Number | ✔ | |||
accountNumber | String 4-17 digits |
Account Number | ✔ |
Sample Response:
Client's SubClient:
{
"SC": 200,
"EC": "0",
"name": "TabaPay",
"tin": "123456789",
"type": "Corp",
"url": "www.tabapay.com",
"email": "[email protected]",
"address":
{
"line1": "605 Ellis Street",
"line2": "Suite 110",
"city": "Mountain View",
"state": "CA",
"zipcode": "94043"
},
"phone":
{
"number": "4159808222"
},
"mcc": 1234,
"mvv": 1234,
"maid": 1234,
"settlement":
{
"purchase":
{
"routingNumber": 121140399,
"accountNumber": 12345
},
"disbursement":
{
"routingNumber": 121140399,
"accountNumber": 12345
},
"fee":
{
"routingNumber": 121140399,
"accountNumber": 12345
},
"exception":
{
"routingNumber": 121140399,
"accountNumber": 12345
}
}
}
Notes:
Only for Clients who are ISO (Independent Sales Organization) where:
- ClientID is your unique 22-character string and
- SubClientID is an assigned 4, 6 or 8-digit value.