TabaPay Transaction API
This resource represents a Client's Transaction.
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.0.0, at version 1.0.0.
Requests are made against a single base URL, https://{FQDN}:{PORT}.
5 operations
3 paths
55 schemas
2 DELETE1 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
TabaPay Transaction 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 — 2 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Transaction 5
This resource represents a Client's Transaction.
PATCH
/v1/clients/{ClientID}/transactions/{TransactionID}
Capture Transaction
DELETE
/v1/clients/{ClientID}/transactions/{TransactionID}
Delete Transaction
GET
/v1/clients/{ClientID}/transactions/{TransactionID}
Retrieve Transaction
POST
/v1/clients/{ClientID}/transactions
Create Transaction
DELETE
/v2/clients/{ClientID}/transactions/rtp/{RTPNetworkID}
Delete RTP Transaction
Schemas 55
The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are createTransaction (16 properties), level3 (15 properties), createTransactionResponse (15 properties), transactionRetrieveResponse (12 properties). Each schema is shown below with its type and property counts.
transactionRetrieveResponse
object
12 properties
deleteRTPTransaction
object
5 properties
createTransactionResponsePending
object
8 properties
pullOptions
object
Additional Pull Options Optional
9 properties
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
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
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…
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…
mobilePay
object
A Decrypted [Apple Pay](https://developers.tabapay.com/docs/apple-pay) Token
7 properties
6 required
referenceID
string
1-15 character unique [referenceID](https://developers.tabapay.com/docs/glossaryreference-id). Used for [Retrieve via ReferenceID](https://developers.tabapay.c…
owner
object
Owner Details
3 properties
1 required
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.
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
apiResponseSCECEM
object
3 properties
city
string
City
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
line1
string
Address Line 1
networkID
string
Network TransactionID. Not returned by every network.
networkRC
string
2-3 character [Network Response Code](https://developers.tabapay.com/reference/iso-network-codes/)
processor
object
Tokenized Card Payment Data From an Issuing Processor Incompatible with all other card objects and fields
3 properties
2 required
apiResponseSCECTxnIDStatus
object
4 properties
apiResponseSCEC
object
2 properties
blob
string
URL-safe, Base64 encoded card data
destinationAccount
object
Information. Exclusively use destinationAccount or destinationAccountID. Can only be used on push transactions. Incompatible with destinationAccountID.
5 properties
1 required
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
transactionCaptureResponse
object
3 properties
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
transactionRTPDeleteRequest
object
5 properties
transactionID
string
22 character Transaction ID
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
amount
string
See how to [properly format an amount](/reference/datahow-to-specify-an-amount-value).
level3
object
15 properties
15 required
deleteTransaction
object
2 properties
sourceAccountID
string
22 characters TabaPay AccountID. Use your here on all push transactions.
transactionRTPDeleteResponse
object
6 properties
createTransaction
object
16 properties
4 required
createTransactionResponse
object
15 properties
ofacValue
string
OFAC Value from [Query OFAC](https://developers.tabapay.com/reference/ofacquery/) Optional
transactionReversed
object
4 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…
expirationDateMobilePay
string
Expiration Date in YYYYMM. Note: Convert YYMMDD format to YYYYMM.
location
object
Location of Origination of Transaction Optional
2 properties
2 required
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…
apiResponseSCECStatus
object
3 properties
country
string
[Country Code](https://developers.tabapay.com/reference/country-codes/) Optional. Default is 840
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…
EM
string
Short description of the error if an error occurred.
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-…
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…
sourceAccount
object
Information. Exclusively use sourceAccount or sourceAccountID. Can only be used on pull transactions. Incompatible with sourceAccountID.
4 properties
1 required
correspondingID
string
Optional Incompatible with corresponding object.
line2
string
Address Line 2 Optional
destinationAccountID
string
22 characters TabaPay AccountID. Use your here on all pull transactions.
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
More from TabaPay 12
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 SubClient API
TabaPay Tag API
#Transaction