Sign in
latestOpenAPI 3.0.02026-08-0832102256.6 KB

6097bc689e41

Transactions

Refund a transaction

Called by the Independent Software Vendor. Makes a request to TB in order to get a refund amount for an ACH transaction.

post/transactions/refund/ach

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

Content-Typestring required
Example:application/x-www-form-urlencoded

The Content-Type entity header is used to indicate the media type of the resource.

Response

Success

amountstring

Passthrough of original transaction request amount

auth_amountstring

The authorized amount in case of a partial authorized transaction

gateway_auth_codestring

The authorization code received from the gateway

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.

created_atstring

The time the transaction was created.

gateway_identifier'usaepay' | 'payment_fusion'

Identifier of the gateway.

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.

merchant_idstring

The merchant identifier that will be used to connect to the gateway. Size range - 1..16

midstring

The merchant ID

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..256.

tidstring

The terminal ID

tip_amountstring

The tip amount in USD that was added to this transaction. Default value - 0

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", "Success", "Failure"

vstring

The API version that was used to handle the request.

Example response

{
  "amount": "string",
  "auth_amount": "string",
  "gateway_auth_code": "string",
  "card_type": "string",
  "created_at": "string",
  "gateway_identifier": "string",
  "gateway_reference_number": "string",
  "gateway_response_message": "string",
  "gateway_result_code": "string",
  "gateway_result_text": "string",
  "merchant_id": "string",
  "mid": "string",
  "remote_id": "string",
  "tid": "string",
  "tip_amount": "string",
  "transaction_status": "string",
  "v": "string"
}