API Reference
Start typing to search…

Create Transaction

post https://{FQDN}/v1/clients//transactions

Creates a Transaction.

In circumstances where you fail to receive a transactionID from us, you can do a retrieve via referenceID. (Allowed only up to 24 hours after original request)

API examples are shown in a human-readable format for clarity. Actual API request bodies must use compact JSON.

Path Params
string
required

22-character ClientID. Ask TabaPay Support if you need to specify a SubClientID.

Query Params
string
length between 0 and 0

Note the query string, ?authorize, will create an authorization only. To settle the transaction, you must call CaptureTransaction.

Body Params
string
required

1-15 character unique referenceID. Used for Retrieve via ReferenceID in case of an HTTP timeout, or any scenario where you fail to get a response body.

string

Optional Corresponding Transaction ID

Incompatible with corresponding object.

corresponding
object

Corresponding Transaction Information

For a push transaction, this would be the corresponding pull transaction.
For a pull transaction, this would be the corresponding push transaction.

Optional. Incompatible with correspondingID.

string
required

4-character Transaction Type

push and pull are the only valid values. This is used to verify that your Source and Destination Accounts are valid

accounts
object
required

Accounts

string

ISO 4217 3-Digit Currency Code.

Optional. Default is 840

string
required

See how to properly format an amount.

string

OFAC Value from Query OFAC

Optional

string

22-character avsID
Received in the response of QueryCard + AVS/ANI.

Optional

string

Code describing the purpose of payment

Conditional. May be required, dependent on the country of the issuing BIN

string

1-32 character Memo

Optional. Refer to the convenience fee guide if you need to set fees per transaction.

string

ACH Options

  • R RTP
  • N Next Day
  • S Same Day

Required for RTP or ACH, else optional.

string

Three Options

  • CCD Corporate Credit or Debit
  • PPD Prearranged Payment and Deposit
  • WEB Website, App, or Mobile Initiated Entry

Required for ACH, else optional.

pullOptions
object

Additional Pull Options

Optional

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. zipCode must correspond to the state values.

Optional

location
object

Location of Origination of Transaction

Optional

Responses

Response body
object
integer

HTTP Status Code

string

Internal Error Code. This is used to help TabaPay team members trace an error.

string

22 character Transaction ID

string
string

2-3 character Network Response Code

string

Network TransactionID.

Not returned by every network.

string

Resource Status

string

6-digit Approval Code

string

Partially Approved Amount. May be returned when pullOptions.partial is set to true, and the authorization can only be partially approved.

errors
array of strings
errors
AVS
object

AVS Results

string

AVS Response Code

string

Security Code Response Code

fees
object

Estimated Fees

string
required

Interchange Fees

string
required

Network Fees

string
required

TabaPay Fees

card
object

Card Details

string

Issuer Name

Note:

  1. Not present if no issuer name found.
  2. TabaPay will Include (CashApp) in nameFI if it is a CashApp BIN.
string
required

Last 4 of Card Account Number (PAN)

string

Expiration Date

YYYYMM Format

Optional.

additional
object

Enriched TP Shield Attributes

string

UCAF Response Info. Value depends on the network of the transaction.
Visa - CAVV results code. Expected Values:
- 0: No-Match. No Liability Shift
- 1: No-Match. No Liability Shift
- 2: Match
MasterCard/MasterCardDual - UCAF Downgrade Reason:
- 0: Missing UCAF
- 1: Invalid UCAF

string

Result of CPS Evaluation (Visa Only)

string

Network Response of ECI (Note: This is subject to change until the transaction clears successfully)

string

Merchant Advice Code. Expected Values:

  • 01: New account information available
  • 02: Cannot approve at this time, try again later
  • 03: Do not try again
  • 04: Token requirements not fulfilled for this token type
  • 05: Negotiated value not approved
  • 21: Payment Cancellation (MasterCard use only)
  • 22: Merchant does not qualify for product code
  • 24: Retry after 1 hour (Mastercard use only)
  • 25: Retry after 24 hours (Mastercard use only)
  • 26: Retry after 2 days (Mastercard use only)
  • 27: Retry after 4 days (Mastercard use only)
  • 28: Retry after 6 days (Mastercard use only)
  • 29: Retry after 8 days (Mastercard use only)
  • 30: Retry after 10 days (Mastercard use only)
  • 40: Consumer non-reloadable prepaid card
  • 41: Consumer single-use virtual card number
string

Payment Account Reference

Updated 3 months ago

What’s Next

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character (_) to separate the two values: <ClientID>_<SubClientID>

One of the accounts in the Request, Source Account or Destination Account, must be your Settlement Account. If disbursing funds (push) the Source Account should be your Settlement Account. If collecting funds (pull) the Destination Account should be your Settlement Account.

On a Pull Transaction, specifying at least the Owner Address Line 1 and/or Owner Zip Code will result in an automatic AVS check which may result in lower fees. However, a bad AVS will not stop the Transaction. You should have previously done a Query Card with AVS to check the Card.

A Timeout does not STOP the Transaction from continuing to be processed. It does mean that the Transaction Status will be temporarily in an UNKNOWN status. The SC (Status Code) in the Response will be 207.

Once the Transaction finished processing, the Actual Status of the Transaction will be reflected. You can do a Retrieve Transaction to check on the actual Transaction Status. However, do not poll, otherwise you will get SC=429.

After 90 seconds, the Transaction Status will NOT change. We have given up waiting for a response. Most likely, the Transaction Status will remain in an UNKNOWN status. Contact TabaPay Support if you need us to investigate what really happened with this Transaction.

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

Did this page help you?
Language
Credentials
URL

Updated 3 months ago

What’s Next

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character (_) to separate the two values: <ClientID>_<SubClientID>

One of the accounts in the Request, Source Account or Destination Account, must be your Settlement Account. If disbursing funds (push) the Source Account should be your Settlement Account. If collecting funds (pull) the Destination Account should be your Settlement Account.

On a Pull Transaction, specifying at least the Owner Address Line 1 and/or Owner Zip Code will result in an automatic AVS check which may result in lower fees. However, a bad AVS will not stop the Transaction. You should have previously done a Query Card with AVS to check the Card.

A Timeout does not STOP the Transaction from continuing to be processed. It does mean that the Transaction Status will be temporarily in an UNKNOWN status. The SC (Status Code) in the Response will be 207.

Once the Transaction finished processing, the Actual Status of the Transaction will be reflected. You can do a Retrieve Transaction to check on the actual Transaction Status. However, do not poll, otherwise you will get SC=429.

After 90 seconds, the Transaction Status will NOT change. We have given up waiting for a response. Most likely, the Transaction Status will remain in an UNKNOWN status. Contact TabaPay Support if you need us to investigate what really happened with this Transaction.

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

Did this page help you?

Questions? Contact Sales or make a post