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 Account API

This resource represents a Client's Account.

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

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

This API exposes 5 operations across 3 paths, and defines 27 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}.

5 operations 3 paths 27 schemas 1 DELETE1 GET1 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 Account 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 5

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

Account 5

This resource represents a Client's Account.

POST
/v1/clients/{ClientID}/accounts
Create Account
accountCreate 3 params body → 200207409
DELETE
/{Version}/clients/{ClientID}/accounts/{AccountID}
Delete Account
accountDelete 4 params → 200207
GET
/{Version}/clients/{ClientID}/accounts/{AccountID}
Retrieve Account
accountRetrieve 3 params → 200421
PUT
/{Version}/clients/{ClientID}/accounts/{AccountID}
Update Account
updateAccount 5 params body → 200207409
PUT
/v2/clients/{ClientID}/accounts/{AccountID}
Update Account V2
updateAccountV2 2 params body → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are retrieveAccountResponse (6 properties), name (5 properties), accountCreateResponse (5 properties), createAccount (4 properties). Each schema is shown below with its type and property counts.

name
object
Name Use Either: (1) company OR (2) first, middle, last, and suffix If choosing (2), first and last are required, middle and suffix are optional
5 properties
routingNumber
string
[ABA routing transit number](https://en.wikipedia.org/wiki/ABAroutingtransitnumber)
keyID
string
Required field of 22 character KeyID. Ensure the RSA key you're using to encrypt the card data is consistent with this keyID Compatible with data and nothing e…
owner
object
Owner Details
3 properties 1 required
referenceID
string
1-15 character unique [referenceID](https://developers.tabapay.com/docs/glossaryreference-id). Used for [Retrieve via ReferenceID](https://developers.tabapay.c…
retrieveAccountResponse
object
6 properties 2 required
apiResponseSCECEM
object
3 properties
city
string
City
accountCreateResponse
object
5 properties
line1
string
Address Line 1
accountID
string
22 characters assigned representing one card or bank account.
apiResponseSCEC
object
2 properties
createAccount
object
4 properties 2 required
blob
string
URL-safe, Base64 encoded card data
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
accountCreateResponseDuplicateCard
object
4 properties
updateAccount
object
2 properties 1 required
accountType
string
Bank Account Type. - S Savings - C Checking - A Business Savings - B Business Checking - L Loan
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…
updateAccountV2
object
2 properties
EM
string
Short description of the error if an error occurred.
EC
string
Internal Error Code. This is used to help TabaPay team members trace an error.
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
line2
string
Address Line 2 Optional
data
string
Required field of [RSA-encrypted card data](https://developers.tabapay.com/reference/pci-helper-rsa/what-data-do-i-encrypt) using RSA key with KeyID keyID. Com…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabapay-account-api-openapi.yml Raw ↑

Other APIs TabaPay publishes across the network.

TabaPay 3D Secure 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 SubClient API
TabaPay Tag API
TabaPay Transaction API