Notices and Versions

• Notices
• Environments' Status and SLA / Outages
• Versions

Between November and January is time for our Annual PCI Tasks and Audit.

Between March and June is time for our Annual SOC Audits.

Doing a lot (or constant API Call) of Retrieves, either:

• RetrieveAccount
• RetrieveTransaction

We have enabled Rate Limiting on the Sandbox Environment. Sandbox is a Shared Environment used by many Clients and meant only for Development purposes...

● SSO Token will Expire after 5-10 minutes and will therefore be rendered invalid.

● CreateKey will be deprecating soon. When the CreateKey replacement becomes available, CreateKey will be disabled...

● RetrieveAccount by ReferenceID is deprecated and should only be used in the case of a HTTP Communications Error where an AccountID was not returned back.

● RetrieveTransaction by ReferenceID is deprecated and should only be used in the case of a HTTP Communications Error where a TransactionID was not returned back.

    If you continue to use Retrieve by ReferenceID, the API will return a Status Code of 421 Misdirected Request:

• For RetrieveAccount by ReferenceID, if the Account was created over 24 hours ago
• For RetrieveTransaction by ReferenceID, if the Transaction was created over 24 hours ago

ReferenceID Change:

ReferenceID will no longer be required to be UNIQUE on a CreateAccount. If you do a Retrieve by ReferenceID, you will get the last one (the most recently added).

• RetrieveAccount - Changed on 06/02/2019

See the Anti-Pattern FAQ...

Anti-Pattern or incorrect use of TabaPay’s API is not permitted on Sandbox, UAT, or Production Environments as they can impact the overall Environment. Examples of incorrect use of TabaPay’s API:

• Probe, Client is sending a probe to see if our system is up, types of probes we have seen (so far):
  • Query Card with a fake card number every so often but at a consistent interval
  • Retrieve Client, comment was that it shouldn't be an expensive request (but it adds up and if everyone does it, it becomes overwhelming)
  • HTTP GET / every second
• Logic Errors (Bugs):
  • Repetitive doing the following sequence: Query Card -> Add Account -> Delete Account
  • RetrieveAccount by ReferenceID multiple times (a lot)
  • RetrieveTransaction by ReferenceID multiple times (a lot)
  • CreateKey multiple times (a lot)
  • CreateKey -> DeleteKey multiple times (a lot)
• Design Errors (Bugs):
  • Using Retrieve by ReferenceID because you don't know if you Created the Transaction (Account) or not

• Also see the Anti-Pattern FAQ for more examples...

We will only keep transactions accessible to the TabaPay API for approximately 120 days. This means that Delete Transaction will only work for transactions within approximately 120 days. However, we archive transactions for many years (as legally required).

Inactive IP Addresses will be disabled in the Sandbox Environment. Contact TabaPay Support if you need to reenable a disabled IP Address. If you need more IP Addresses whitelisted, consider using a Proxy (or our Proxy).

Creating too many Keys in the Sandbox and/or Production Environment will cause your CreateKey to be disabled.

Inactive and Duplicate Accounts, created with the Account Create API in the Sandbox, UAT, or Production Environment, may result in these inactive and duplicate accounts being deleted and/or additional charges will be charged for these accounts.

Please inform us of possible Volume Spikes.
If you do not inform us of unexpected Volume Spikes, our systems may detect it as abnormal and our systems may block all IP Addresses causing this unexpected Volume Spikes. Volume Spikes that are all (or mostly) Errors, like:

• SC=404 coming from Retrieve Transactions
• Network RC of 51 or 14 from Create Transactions
• SC=409 coming from Create Accounts or Create Transactions

There should be no expectations on the Sandbox or UAT Environments, see the FAQ for the Sandbox Environment and see the FAQ for the UAT Environment. The Sandbox and UAT Environments use Simulators, so the accuracy of these Simulators may not be exactly the same as you will see in Production. For example, AVS calls will most likely always return a Network Response Code of 85, we will change the Simulator in the near future to reflect this.

Ready for Production? Please read the Production FAQ.

We have multiple Environments:

• Production USE1 (Active-Active DR)
• Production USE2 (Active-Active DR)
• UAT
• Sandbox
• QA
• Dev

We will try not to update this WebSite before the corresponding Code Release to the Sandbox Environment. However, this WebSite might be slightly ahead of the Code Release to the Sandbox and Production Environments. So some things that are described on this WebSite may not yet be available and working in the Environment you are using.

On Sandbox and UAT Environments, your Client will now be limited to the IPs Whitelisted for that Client. If you have more than one Client, you will need to specify the IPs to be Whitelisted for each Client separately. This will also be implemented on the Production Environment soon...

• These Accounts incurring an extra charge (fee)
• These Accounts being automatically deleted

The Fees are only an estimation. The actual Fees will be shown on your daily settlement reports.

If you need help, please contact support@TabaPay.com with the following:

• Date and Time of the Request and Time Zone (we have many Clients in many different parts of the world)
• URL
• Request Data
• HTTP Status Code
• Response Data (if any, JSON or HTML)

SLA / Outages

WebSite Updates

Sandbox/UAT Maintenance

* There should be no expectations on the Sandbox or UAT Environments.
   Nothing is unlimited, this includes the database, so the database was cleaned up.

Versions

Developers WebSite

• the Back button will not work as expected, navigation will require the use of the links on:
  • the top right hand side of the page
  • and the left hand side of the page
• the complete WebSite can be used when you are offline (not connected to the internet)

Terms and Conditions

This WebSite is preliminary and is subject to change.

TabaPay makes no representation or warranties, expressed or implied, as to the truth or accuracy of any information contain herein. This WebSite may include typographical errors and technical inaccuracies. This WebSite is provided "as is" and all expressed or implied conditions, representations and warranties, including any implied warranty of merchantability, fitness for a particular purpose, or non-infringement, are disclaimed; except to the extent that such disclaimers are held to be legally invalid.

The URLs and ResourceIDs specified on this WebSite are only used for illustrative purposes (temporary place holders and/or samples) and does not reflect the actual URLs and ResourceIDs to be used (in Sandbox or Production). Please contact TabaPay Support for the actual URLs and ResourceIDs to be used for your situation.

Overview

• connect
• send request
• receive response
• disconnect

HTTP Header

HTTP Cookies

IP Whitelisting

You will need to reverify your IP Addresses every year, otherwise they will be removed.

Client Certificate

API Descriptions Notations

Response:

Resources

• Client
• Retrieve (Get)


• Key
• Create (Post)
• Retrieve (Get)
• Delete (Delete)


• Card
• Query (Post)


• Bank
• Query (Post)


• OFAC
• Query (Post)


• Account
• Create (Post)
• Retrieve (Get)
• Update (Put)
• Delete (Delete)


• Transaction
• Create (Post)
• Retrieve (Get)
• Delete (Delete)


• TransactionRequest (OTPP)
• Create (Post)


• SubClient
• Create (Post)
• Retrieve (Get)
• Update (Update)
• Delete (Delete)

• A Resource cannot be shared across Clients
• A Resource is identified by a ResourceID
• A Resource can be identified by multiple different ResourceIDs

Resource IDs

• A ResourceID identifies a Resource
• A ResourceID can expire (by the number of days since creation)
• A ResourceID is 22 characters in length
• A ResourceID is made up of only Base64 URL-Safe characters:
  ●   A-Z

  Uppercase alphabetic characters

  ●   a-z

  Lowercase alphabetic characters

  ●   0-9

  Digits

  ●   -

  Minus Sign

  ●   _

  Underscore

Services

• 3D Secure
• Initialize
• Lookup
• Authenticate


• FXRate
• Query (Post)

Client

The only operation available for this resource is:

Only TabaPay can:

Retrieve Client

{
  "SC": 200,
  "EC": "0",
  "label": "ClientLabel",
  "networks":
  {
    "pull":
    [
      "STAR",
      "Visa"
    ],
    "push":
    [
      "STAR",
      "CU24",
      "Visa"
    ]
  },
  "limits":
  {
    "currency": "840",
    "pull":
    {
      "transaction": "0.25",
      "daily": "1.00"
    },
    "push":
    {
      "transaction": "0.25",
      "daily": "1.00",
      "networks":
      [
        {
          "network": "CU24",
          "transaction": "0.20",
          "daily": "1.00"
        }
      ]
    }
  }
}

{
  "SC": 404,
  "EC": "3A100000",
  "EM": "Not Found"
}

{
  "SC": 423,
  "EC": "3A100000",
  "EM": "Locked"
}

Key

The operations that are available for this resource are:

Retrieve Key

{
  "SC": 200,
  "EC": "0",
  "keyID": "TabaPay_KeyID_22-chars",
  "key": "Base64_Encoded_Key",
  "expiration": "2017-04-03T00:00:00Z"
}

{
  "SC": 200,
  "EC": "0",
  "keyID": "TabaPay_KeyID_22-chars",
  "keyModulus": "Base64_Encoded_Modulus",
  "keyExponent": "Base64_Encoded_Exponent",
  "expiration": "2017-04-03T00:00:00Z"
}

Delete Key

{
  "SC": 200,
  "EC": "0"
}

{
  "SC": 404,
  "EC": "10000000"
}

{
  "SC": 410,
  "EC": "50000000"
}

Card

The only operation available for this resource is:

Query Card

• AVS Check (Address Verification)
• Fees Check
• Verify Name with Phone Number

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "card":
  {
    "accountNumber": "9999999999999999"
  }
}

{
  "card":
  {
    "keyID": "TabaPay_KeyID_22-chars",
    "data": "Base64_Encoded_Encrypted_Data"
  }
}

{
  "account":
  {
    "accountID": "TabaPay_AccountID_22ch"
  }
}

{
  "card":
  {
    "accountNumber": "9999999999999999"
  },
  "amount": "0.50"
}

1111111111111111||

where

Card Number:     1111111111111111
Expiration Date: None
Security Code:   None

1111111111111111|203001|

where

Card Number:     1111111111111111
Expiration Date: January 2030
Security Code:   None

1111111111111111|203001|333

where

Card Number:     1111111111111111
Expiration Date: January 2030
Security Code:   333

1111111111111111||333

where

Card Number:     1111111111111111
Expiration Date: None
Security Code:   333

{
  "SC": 200,
  "EC": "0",
  "card":
  {
    "pull":
    {
      "enabled": true,
      "network": "Visa",
      "type": "Debit",
      "regulated": true,
      "currency": "840",
      "country": "840"
    },
    "push":
    {
      "enabled": true,
      "network": "Visa",
      "type": "Debit",
      "regulated": true,
      "currency": "840",
      "country": "840",
      "availability": "Immediate"
    }
  }
}

{
  "SC": 200,
  "EC": "0",
  "card":
  {
    "pull":
    {
      "enabled": false
    },
    "push":
    {
      "enabled": true,
      "network": "Visa",
      "type": "Debit",
      "regulated": true,
      "currency": "840",
      "country": "840",
      "availability": "Immediate"
    }
  }
}

{
  "SC": 200,
  "EC": "0",
  "card":
  {
    "pull":
    {
      "enabled": true,
      "network": "Visa",
      "type": "Debit",
      "regulated": true,
      "currency": "840",
      "country": "840"
    },
    "push":
    {
      "enabled": false
    }
  }
}

{
  "SC": 200,
  "EC": "0",
  "card":
  {
    "pull":
    {
      "enabled": false
    },
    "push":
    {
      "enabled": false
    }
  }
}

Bank

The only operation available for this resource is:

Query Bank

{
  "routingNumber": "999999999"
}

{
  "SC": 200,
  "EC": "0",
  "RTP": true
}

OFAC

The only operation available for this resource is:

Query OFAC

{
  "name":
  {
    "first": "John",
    "last": "Smith"
  }
}

{
  "name":
  {
    "first": "John",
    "last": "Smith"
  },
  "requestID": "ABC123"
}

{
  "SC": 200,
  "EC": "0",
  "ofacMatchCodes": "LN",
  "ofacValue": "7nGfHHedKNe1aw"
}

{
  "SC": 200,
  "EC": "0",
  "ofacMatchCodes": "H",
  "ofacValue": "8oHgIIfeLOf2bx"
}

Account

The operations that are available for this resource are:

Create Account

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "referenceID": "1",
  "card":
  {
    "accountNumber": "9999999999999999",
    "expirationDate": "202012"
  },
  "owner":
  {
    "name":
    {
      "first": "John",
      "last": "Customer"
    },
    "address":
    {
      "line1": "465 Fairchild Drive",
      "line2": "Suite #222",
      "city": "Mountain View",
      "state": "CA",
      "zipcode": "94043"
    },
    "phone":
    {
      "number": "4159808222"
    }
  }
}

1111111111111111|203001|

where

Card Number:     1111111111111111
Expiration Date: January 2030

{
  "SC": 200,
  "EC": "0",
  "accountID": "TabaPay_AccountID_22ch"
}

Update Account

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "card":
  {
    "accountNumber": "9999999999999999",
    "expirationDate": "202012"
  },
  "owner":
  {
    "name":
    {
      "first": "John",
      "last": "Customer"
    },
    "address":
    {
      "line1": "465 Fairchild Drive",
      "line2": "Suite #222",
      "city": "Mountain View",
      "state": "CA",
      "zipcode": "94043"
    },
    "phone":
    {
      "number": "4159808222"
    }
  }
}

1111111111111111|203001|

where

Card Number:     1111111111111111
Expiration Date: January 2030

{
  "SC": 200,
  "EC": "0"
}

Update Account v2

Update specific fields in the Account. Currently does not work with DuplicateCardCheck. Currently only works with Unencrypted Cards (Card in the Clear) and/or Bank Accounts.

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

  {
    "owner":
    {
      "name":
      {
        "first": "Jane"
      }
    }
  }
   

  {
    "owner":
    {
      "address":
      {
        "line1": "605 Ellis St",
        "line2": "Suite #110",
      }
    }
  }
   

  {
    "SC": 200,
    "EC": "0"
  }
   

Delete Account

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "SC": 200,
  "EC": "0"
}

Transaction

The operations that are available for this resource are:

Create Transaction

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "referenceID": "1",
  "type": "push",
  "accounts":
  {
    "sourceAccountID": "TabaPay_AccountID_22-c",
    "destinationAccountID": "TabaPay_AccountID_22-c"
  },
  "amount": "1.00"
}

{
  "referenceID": "1",
  "type": "pull",
  "accounts":
  {
    "sourceAccount":
    {
      "card":
      {
        "accountNumber": "9999999999999999",
        "expirationDate": "202012"
      },
      "owner":
      {
        "name":
        {
          "first": "John",
          "last": "Benson"
        },
        "address":
        {
          "line1": "465 Fairchild Drive",
          "line2": "Suite #222",
          "city": "Mountain View",
          "state": "CA",
          "zipcode": "94043"
        },
        "phone":
        {
          "number": "4159808222"
        }
      }
    },
    "destinationAccountID": "TabaPay_AccountID_22-c"
  },
  "amount": "0.10"
}

{
  "referenceID": "1",
  "type": "push",
  "accounts":
  {
    "sourceAccountID": "TabaPay_AccountID_22-c",
    "destinationAccount":
    {
      "card":
      {
        "accountNumber": "9999999999999999",
        "expirationDate": "202012"
      },
      "owner":
      {
        "name":
        {
          "first": "John",
          "last": "Benson"
        },
        "address":
        {
          "line1": "465 Fairchild Drive",
          "line2": "Suite #222",
          "city": "Mountain View",
          "state": "CA",
          "zipcode": "94043"
        },
        "phone":
        {
          "number": "4159808222"
        }
      }
    }
  },
  "amount": "0.10"
}

1111111111111111|203001|

where

Card Number:     1111111111111111
Expiration Date: January 2030
Security Code:   None

1111111111111111|203001|333

where

Card Number:     1111111111111111
Expiration Date: January 2030
Security Code:   333

{
  "SC": 200,
  "EC": "0",
  "transactionID": "TabaPay_TransactionID_",
  "network": "Visa",
  "networkRC": "00",
  "status": "COMPLETED",
  "approvalCode": "000000"
}

{
  "SC": 201,
  "EC": "0",
  "transactionID": "TabaPay_TransactionID_",
  "network": "CreditCards",
  "status": "PENDING"
}

Delete Transaction

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID.

{
  "amount": "1.00"
}