Sign in
latestOpenAPI 3.0.02026-08-0832102256.6 KB

6097bc689e41

Transactions

Get Transaction

Called by the Independent Software Vendor. The ISV issues a request to TB to check the transaction status (ex card was swiped response). This URL is accessed repeatedly by the ISV (polling). If the transaction is approved then the read_at field with be updated with the current timestamp.

get/transactions/{id}

Path parameters

idinteger required

Specifies the transaction to read.

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required
Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Response

Success

idinteger

The id of the transaction.

amountstring

The amount in USD with 2 decimals that will be charged, must be a number greater than 0. (e.g. "1", "1.00", "1.01", "1.2").

serial_numberstring

The serial number of the terminal that was selected for this transaction. Size range - 256

client_idstring

The id of the client for wich a transaction was initiated. Size range - 256

invoicestring

Number of the invoice. If this field is not sent then the invoice will be given a unique identifier. Size range - 1..10

ip_addressstring

IP address of the client requesting the transaction.

user_namestring

The user name of the user that requested the transaction.

customer_namestring

The name of the customer for this transaction.

software_namestring

ISV software identifier.

clerk_numberstring

Identifies the clerk or person executing the transaction for reporting purposes.

transaction_statusstring

Confirmation from the payment gateway regarding the CC credentials and payment finalization. Allowed values - "approved", "awaiting_amount", "awaiting_confirmation", "canceled", "declined", "emv_needing_reversal", "error", "in progress", "internal error", "timeout", "verification"

credit_card_tokenstring

Token issued by the gateway and that can be used for future transactions. Size range - 19

card_typestring

The type of the card that was submitted. Allowed values - "Discover", "DISCOVER", "UnionPay", "AmEx", "AMERICAN EXPRESS", "AMEX", "American express", "Master", "MASTERCARD", "Mastercard", "MASTERCARD/Mastercard", "JCB", "Jcb", "Visa", "VISA","Visa Traditional", "Visa Classic", "Visa Health", "Visa Prefered", "Mastercard/Eurocard", "DINERS", "CareCredit", "Unknown Code", "OTHER", "null", "N/A" The values are subject to change.

card_expiration_datestring

The card expiration date. Format 'MMYY' (e.g. '0922').

masked_card_numberstring

The masked out card number including the last 4 digits (e.g. ************1234).

um_commandstring

The command that will be passed to the gateway.

created_atstring

The time the transaction was created.

tip_amountstring

The tip amount in USD that was added to this transaction.

tip_methodstring

The method in which the tip amount is entered in the system. "specified" is when it comes from the ISV, "typed" is when the customer types the tip amount on the terminal and "written" is when the customer writes the tip amount on the receipt and later an employee enters the tip on the ISV. When this param is not present, then it defaults to "specified".

cancel_requestedstring

If the transaction was canceled or not.

cancel_requested_atstring

The time when the transaciton was canceled.

gateway_identifierstring

The identifier of the gateway. Allowed values - "payment_fusion", "usaepay"

gateway_reference_numberstring

Transaction reference number from gateway.

gateway_response_messagestring

The message returned from the gateway.

gateway_result_codestring

Result code (or error code) as returned by the gateway.

gateway_result_textstring

The result text as returned by the gateway.

gateway_auth_codestring

The authorization code received from the gateway

return_card_databoolean

Flag that specifies if the masked_card_number and the card_type should be extracted by the terminal and returned.

save_cardboolean

If the card is saved or not on the gateway

merchant_idstring

The merchant identifier that will be used to connect to the gateway.

billing_streetstring

Billing street address for credit cards.

billing_citystring

Billing city for credit cards.

billing_zipstring

Billing zip code for credit cards.

billing_statestring

Billing state for credit cards.

commentsstring

Transaction comments.

descriptionstring

Transaction description.

recurringboolean

Specifies if this transaction is recurring or not. If set to false, omitted or filled with wrong data, the recurring billing fields will be ignored - "schedule", "num_left", "start_date", "bill_amount". Allowed values - true,false

schedulestring

Frequency of recurring billing schedule. Will be ignored if recurring is not sent as "true". Allowed values - "disabled","daily","weekly","bi-weekly","monthly","bi-monthly","quarterly","bi-annually","annually".

num_leftstring

Number of transactions remaining in recurring billing cycle. Will be ignored if recurring is not sent as "true".

start_datestring

Must be entered in YYYYMMDD format. If set to "next" the date of the next billing cycle will be used. For example if today is 1/10/2009 and schedule=monthly then start_date will be set to 2/10/2009. Can also be entered as "first of month" or "last day of month" Will be ignored if recurring is not sent as "true".

bill_amountstring

Sets the monetary amount to charge on each cycle. Specified in USD. If this field is left blank the amount will be used instead. This is NOT the "initial" charge or "setup" charge, this is only the "recurring" charge.

customer_idstring

Customer identifier associated to the transaction.

card_holderstring

The name on the card.

gateway_ipstring

The IP of the server that processed this transaction.

signaturestring

The encoded signature.

card_hashstring

The hashed version of the card number. This can be used to determine if the same card was used for multiple transactions without knowing the actual card number. Size range - 40

auth_amountstring

The authorized amount in case of a partial authorized transaction.

remaining_balancestring

The remaining balance in case of a partial authorized transaction.

remote_idstring

Used for keeping track of a 3rd party identifier alongside the transaction object. This is typically used by the ISV to assign its own identifier to the transaction for easy matching in case any network issues appear. This is not validated for uniqueness. Size range - 0..100

street_addressstring

Optional value indicating the street address of the card holder.

zip_codestring

Optional value indicating the zip code of the card holder.

input_methodstring

The input method used for the card associated with the transaction. Allowed values - "swipe","keyed","dip","contactless","fallback","chip_read","swiped","tap" The values are subject to change.

midstring

The merchant ID

tidstring

The terminal ID

is_healthcareboolean

Indicates if card's BIN is included in the healthcare BIN table.

card_is_presentboolean

Indicates the presence of the card.

order_method'mail_order' | 'phone_order' | 'null'

The type of order.

allow_partial_authboolean

Indicates that the transaction was created to allow partial payment. allow_partial_auth is null if it was not set when the transaction was created.

is_partial_authboolean

Partial authorization indicator that reflects whether the processor provided a partial authorization, or not. Will be null if the gateway didn't return any partial authorization status.

vstring

The API version that was used to handle the request.

Example response

{
  "amount": "string",
  "serial_number": "string",
  "client_id": "string",
  "invoice": "string",
  "ip_address": "string",
  "user_name": "string",
  "customer_name": "string",
  "software_name": "string",
  "clerk_number": "string",
  "transaction_status": "string",
  "credit_card_token": "string",
  "card_type": "string",
  "card_expiration_date": "string",
  "masked_card_number": "string",
  "um_command": "string",
  "created_at": "string",
  "tip_amount": "string",
  "tip_method": "string",
  "cancel_requested": "string",
  "cancel_requested_at": "string",
  "gateway_identifier": "string",
  "gateway_reference_number": "string",
  "gateway_response_message": "string",
  "gateway_result_code": "string",
  "gateway_result_text": "string",
  "gateway_auth_code": "string",
  "merchant_id": "string",
  "billing_street": "string",
  "billing_city": "string",
  "billing_zip": "string",
  "billing_state": "string",
  "comments": "string",
  "description": "string",
  "customer_id": "string",
  "card_holder": "string",
  "gateway_ip": "string",
  "signature": "string",
  "card_hash": "string",
  "auth_amount": "string",
  "remaining_balance": "string",
  "emv_data": {
    "receipt": "string",
    "customer_verification_method": "string"
  },
  "remote_id": "string",
  "street_address": "string",
  "zip_code": "string",
  "input_method": "string",
  "bin_data": {
    "card_brand": "string",
    "issuing_org": "string",
    "card_type": "string",
    "card_category": "string",
    "issuing_country": "string",
    "issuing_country_code_a2": "string",
    "issuing_country_code_a3": "string",
    "issuing_phone": "string",
    "issuing_website": "string",
    "pan_length": "string",
    "issued_entity": "string",
    "is_regulated": "string"
  },
  "mid": "string",
  "tid": "string",
  "healthcare": {
    "iias_verified": "string",
    "healthcare_amount": "string",
    "prescription_amount": "string",
    "copay_amount": "string",
    "vision_amount": "string",
    "clinic_other_amount": "string",
    "dental_amount": "string",
    "transit_amount": "string",
    "cumulative_amount": "string"
  },
  "v": "string"
}