Starter Guide
TabaPay enables clients to send, receive, and manage instant payments across cards, bank accounts, and networks through a Unified API.
1. Understanding TabaPay
Payments Concepts
Money Movement Transaction Types
Money movement transaction Type, or simply "transaction type" refers to the direction funds move between accounts in a payment system.
Pull (Payment Acceptance)
In pull transactions, funds are pulled from a payer's account into a receiver’s account. The receiver (e.g. a merchant) initiates the transaction to pull the funds into their account.
Push (Payout Funds)
In push transactions, funds are pushed from the sender’s account to a recipient. The sender (e.g. a provider of wage advances) initiates the transaction.
Debit and Credit
Authorization and Capture
Authorization
Authorization is the process of when a merchant confirming whether a customer has sufficient funds to complete any card transaction. When funds are captured, the transaction proceeds to settlement, transferring funds from the customer's account to the merchant's account.
Authorization Hold
An authorization hold is a temporary hold placed on a cardholder’s funds, set aside for a pending transaction, which reduces the available balance until the transaction is completed (captured) or the hold is released (voided).
Capture
Capture follows an authorization hold, and involves the client initiating the process of claiming the held funds. Following an authorization hold, capture entails completing and recording an authorized financial transaction to secure the funds from the customer's account and ensure the payment is successfully processed.
At TabaPay, once a payment has an authorization hold, you can initate to capture the payment with Capture Transaction API.
Clearing and Settlement
Clearing and settlement happens after authorization and capturing, and are collectively the final step.
Clearing
Clearing is the process of reconciling and confirming a payment transaction between financial institutions. It involves exchanging transaction details, calculating fees, and preparing for fund movement.
Settlement
Settlement is the actual movement of funds between banks or parties involved, typically resulting in a net transfer.
Single vs. Dual Message Transaction Flows
Single Message
A payment message sent to the network where authorization, capturing, and clearing happen at the same time in one transaction flow. As a result, authorization and capturing happen at the same time, in a single step. For settlement times, of single message see Daily Settlement Operations.
Dual Message
A payment message sent to the network that includes only authorization. Capturing, clearing and settlement occur later in a second message, or step. For related resources, see Single Message , or Authorize & Capture. For settlement times associated with Dual Message, see Daily Settlement Operations.
Refund, Reversal, or Void
Refund
A refund returns the funds back to the payer, similar to a reversal however some refunds happen after a payment has been complated, or settled.
To return some transactions like ACH or RTP, TabaPay may require a push transaction with the original transaction id instead of Delete Transaction API.
Reversal
A reversal, as the name suggests reverses all or part of a transaction, notifying the issuer to return funds and adjust the available balance.
Void
A void cancels an authorized transaction before it is settled, preventing funds from being withdrawn and removing any authorization hold on the cardholder’s account.
At TabaPay, you can intiate a void by using Delete Transaction with query parameter ?void.
Network Concepts
Networks refer to the systems that systems that connect to the banks to process electronic transactions. Networks facilitate the routing, authorization, clearing, and settlement of card payments.
Card Networks
Card Networks receive all processed card payments and oversee network regulations. Refer to the following links for more information on the card networks and their operations.
Bank and Real-Time Networks
Bank networks move money between financial institutions using traditional rails including Automated Clearing House (ACH), or real-time networks: Real-Time Payments (RTP) and FedNow.
Network Fees & Rules
Networks enforce fees through rule-based programs designed to promote safe behavior and integrity across the payments ecosystem. For more information see Network Integrity or Bulletins.
BIN/IIN Structure
Bank Identification Number (BIN) or Issuer Identification Number (IIN) is a unique set of four to eight digits on a payment card. It identifies the institution that issued the card and plays a key role in routing transactions. See BIN Files.
Compliance
It's critical that anyone involved card processing understands PCI-DSS (Payment Card Industry Data Security Standard) requirements. These standards help ensure that cardholder data is protected and that your business maintains the security practices expected across the payment ecosystem. Refer to the following links for critical resources:
2. Get Your IPs Whitelisted
Contact TabaPay to get started on your integration and boarding process.
As part of the compliance procedures associated with onboarding and integration, you’ll need to get your IPs whitelisted, as you receive your Sandbox credentials.
Note: You may be confirming your use case(s) in parallel as you are getting access to Sandbox in step 3.
3. Getting Access to TabaPay Sandbox
Receive your Credentials
Once you connect with TabaPay to get started on your integration and get whitelisted, you will receive your credentials and access to Sandbox in parallel.
Fully Qualified Domain Name (FQDN)
In Sandbox, replace FQDN name with the appropriate domain. Ensure the domain you're using is consistent with the environment you're testing in (e.g. sandbox, production, etc.).
Example: You replace FQDN https://{FQDN}:{PORT}/v1/clients/{ClientID}/transactions with your own domain as follows
https://securesite:{PORT}/v1/clients/{ClientID}/transactions
Note: PORT will be a specified variable given to you.
Client ID
Your Client ID is the unique 22-character string issued to you during onboarding. This value is used in your URLs for TabaPay APIs. For questions on what string to use, ask TabaPay support.
For example, replace the initial ClientID value as follows:
Initial: You replace ClientID value https://{FQDN}:{PORT}/v1/clients/{ClientID}/transactions
After adding your ClientID: https://{FQDN}:{PORT}/v1/clients/22_TabaPay_Characters1/transactions
Note: SubclientID (if applicable) is attached to ClientID with an underscore in the following format: ClientID_SubClientID
Bearer Token
A bearer token is needed for a header in every API request. Fill in your credential for authorization in making a successful API request.
For example, replace the initial token value as follows:
Initial: Bearer Token After adding bearer token: Bearer 1234567890
Set Up your API Environment
Implement your environment using Make your first API Call, Recipes (Coded Snippets) or by employing Postman as described in the following section.
Download and Use Postman
Download here, and follow the Postman Guide to begin testing in Sandbox.
Make Your First API Call
If you haven't yet, follow the the instructions to make your first API call in cURL, Javascript, Python, or your desired language.
4. Verify Compliance Before Production
You must complete all milestones before going live. This includes any Network Compliance Requirements.
As part of the compliance procedures associated with onboarding, you’ll need to confirm that your use case(s) aligns with one or more of the use cases described on the following pages, and corresponds to one or more BAIs as provided by Visa.
Note: You may be confirming your use case(s) in parallel as you are testing in Sandbox in step 3.
5. Reporting and Monitoring
Configure your TabaPay Reports, and opt-in for any additional reports.
Updated about 18 hours ago