TabaPay Transaction API is one of 16 APIs that TabaPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transaction. 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 55 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://{FQDN}:{PORT}.
The identity and technical contract details declared by the specification.
deleteRTPTransaction
object
5 properties
card
object
Payment Card Data. Choose exactly ONE of the following: - - - token - device object - mobilePay object - processor object Incompatible with bank. Exclusively u…
9 properties
createTransactionResponsePending
object
8 properties
level3
object
15 properties
15 required
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
EC
string
Internal Error Code. This is used to help TabaPay team members trace an error.
EM
string
Short description of the error if an error occurred.
line2
string
Address Line 2 Optional
achOptions
string
ACH Options - R - N Next Day - S Same Day Required for or , else optional. Request to enable ACH or RTP at [TabaPay Support](https://tabapay.zendesk.com/hc/en-…
correspondingID
string
Optional Incompatible with corresponding object.
transactionRTPDeleteResponse
object
6 properties
transactionReversed
object
4 properties
destinationAccount
object
Information. Exclusively use destinationAccount or destinationAccountID. Can only be used on push transactions. Incompatible with destinationAccountID.
5 properties
1 required
transactionRTPDeleteRequest
object
5 properties
owner
object
Owner Details
3 properties
1 required
sourceAccountID
string
22 characters TabaPay AccountID. Use your here on all push transactions.
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…
pullOptions
object
Additional Pull Options Optional
9 properties
country
string
[Country Code](https://developers.tabapay.com/reference/country-codes/) Optional. Default is 840
achEntryType
string
Three Options - CCD Corporate Credit or Debit - PPD Prearranged Payment and Deposit - WEB Website, App, or Mobile Initiated Entry Required for ACH, else option…
location
object
Location of Origination of Transaction Optional
2 properties
2 required
networkRC
string
2-3 character [Network Response Code](https://developers.tabapay.com/reference/iso-network-codes/)
sourceAccount
object
Information. Exclusively use sourceAccount or sourceAccountID. Can only be used on pull transactions. Incompatible with sourceAccountID.
4 properties
1 required
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…
referenceID
string
1-15 character unique [referenceID](https://developers.tabapay.com/docs/glossaryreference-id). Used for [Retrieve via ReferenceID](https://developers.tabapay.c…
apiResponseSCECEM
object
3 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…
apiResponseSCECTxnIDStatus
object
4 properties
amount
string
See how to [properly format an amount](/reference/datahow-to-specify-an-amount-value).
transactionRetrieveResponse
object
12 properties
blob
string
URL-safe, Base64 encoded card data
line1
string
Address Line 1
mobilePay
object
A Decrypted [Apple Pay](https://developers.tabapay.com/docs/apple-pay) Token
7 properties
6 required
networkID
string
Network TransactionID. Not returned by every network.
device
object
Card Data - From a [Secure Device](https://developers.tabapay.com/docs/card-present-transactions) - From a [GooglePay PaymentMethodToken](https://developers.ta…
2 properties
2 required
transactionCaptureResponse
object
3 properties
processor
object
Tokenized Card Payment Data From an Issuing Processor Incompatible with all other card objects and fields
3 properties
2 required
createTransactionResponse
object
15 properties
corresponding
object
Corresponding Transaction Information For a transaction, this would be the corresponding pull transaction. For a transaction, this would be the corresponding p…
7 properties
1 required
apiResponseSCECStatus
object
3 properties
createTransaction
object
16 properties
4 required
softDescriptor
object
Soft Descriptor. Card Network Mandates for Soft Descriptor: To avoid fines or to avoid declines, when providing zipCode and state, please ensure they match i.e…
5 properties
2 required
purposeOfPayment
string
[Code](https://developers.tabapay.com/docs/purpose-of-payment/) describing the purpose of payment Conditional. May be required, dependent on the country of the…
memo
string
1-32 character Memo Optional. For ACH transactions, the first 10 characters of the memo will be used as the ACH entry description. To set convenience fees on a…
destinationAccountID
string
22 characters TabaPay AccountID. Use your here on all pull transactions.
tokeniFrame
string
Card Token (from the [PCI-compliant iFrame](https://developers.tabapay.com/reference/browser-sdk/basic-custom-iframe)) Incompatible with any other card field.
deleteTransaction
object
2 properties
apiResponseSCEC
object
2 properties
expirationDateMobilePay
string
Expiration Date in YYYYMM. Note: Convert YYMMDD format to YYYYMM.
currency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) 3-Digit [Currency Code](https://developers.tabapay.com/reference/currency-numbers/). Optional. Default is 840
ofacValue
string
OFAC Value from [Query OFAC](https://developers.tabapay.com/reference/ofacquery/) Optional
transactionID
string
22 character Transaction ID
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…
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs TabaPay publishes across the network.