Unified API

All transactions go through the Unified API, which connects several networks, and banking partners to allow one API integration for Create Transaction with multiple use cases. All transaction use cases utilize the same API call, what changes are the body parameters you use.

Understanding Your Use Case

Before you fully integrate, it is important to know certain pre-transaction API calls are required for some use cases. Explore different use cases through the following links:

• Use Cases for Instant Payments: Discover your instant payment rail with your matched use case.
• Recipes: Find code snippets related to your use case.

🚧

Are these APIs enabled for you?

In order to use the following APIs please check with [email protected] to make sure they have been enabled on your account.

Query Bank API

Query Bank, or sometimes referred to as Bank Query, requests and returns attributes for the a specific bank account. For example a bank may or may not be enabled for RTP, and you want to confirm before sending an RTP transaction.

Note: To perform an RTP transaction, you will need enabled to use it on TabaPay, email [email protected].

Calling the Bank Query API before a transaction, allows you to see if a specific bank is enabled for RTP.

If the bank is enabled for RTP, you can use Create Transaction and specify R in achOptions along with the Account Number and Routing Number shown on RTP Overview , and 8. RTP Push Transaction.

Key API (For RSA encryption)

The Key API is used to generate, retrieve, or delete an RSA encryption key. This encryption key is generally used to encrypt card holder data when you send it to us. An example use case is implementing the TabaPay card entry application flow with the TabaPay RSA key support (“Mobile OS Support”).

TabaPay keys are valid for up to 1 year.

Query Card API

If you want to create a transaction using a card, you should use our Card API to see what options are available for that card. For example, is the card enabled for push and/or pull?

This is also the API you would use to run an Address Verification Service (AVS) check on a card. To learn more about AVS read our Address Verification Service (AVS) guide and/or our How to use AVS guide.

Example Response:

{
  "SC": 200,
  "EC": "0",
  "card": {
    "pull": {
      "enabled": true,
      "network": "Visa",
      "regulated": true,
      "currency": "840",
      "country": "840"
    },
    "push": {
      "enabled": true,
      "network": "Visa",
      "type": "Debit",
      "regulated": true,
      "currency": "840",
      "country": "840",
      "availability": "Immediate"
    }
  },
  "AVS": {
    "networkRC": "85",
    "resultText": "NOT DECLINED",
    "codeAVS": "Z",
    "codeSecurityCode": "M",
    "EC": "0"
  }
}

🚧

Card Query API is enabled by default on Sandbox

3DS API

For more information on how to use the 3DS API, please go to our How to use the 3DS APIs documentation.

OFAC API

Please use this link to learn more about our OFAC Screening | Watchdog API.

Account API

TabaPay stores and manages payment cards and bank accounts securely for you. We call this TabaPay Tokens (aka TabaPay Vault). Please follow the TabaPay Tokens guide for more information.

🚧

Account API is enabled by default on Sandbox