BAbankofamerica
Transactions

Send ACH transaction to be processed.

Called by the Independent Software Vendor. Sends a transaction directly to the gateway for processing. This can be used with check data.

post/transactions/process/ach

Request

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.

Request body application/x-www-form-urlencoded

merchant_idstring required

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

amountstring required

The amount in USD up to 6 decimals that will be charged, must be a number greater than 0 and its last 4 digits must be 0. (e.g. "1", "1.00", "1.01", "1.2", "1.230000").

invoicestring

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

softwarestring

ISV software identifier.

ip_addressstring

IP address of the client requesting the transaction.

clerkstring

Sales Clerk. Optional value indicating the clerk/person processing transaction, for reporting purposes.

billing_streetstring

Billing street address for credit cards.

billing_citystring

Billing city for credit cards.

billing_statestring

Billing state for credit cards.

billing_zipstring

Billing zip code for credit cards.

commentsstring

Transaction comments.

descriptionstring

Transaction description.

commandstring

The operation that will be performed. "sale" makes the transaction right away while "independent_return" makes a refund of the transaction. “save” returns a token for the check data (Payment Fusion Gateway only).

Allowed values - "sale","independent_return","save".

force_duplicateboolean

Specifies if this transaction can bypass duplicate error. Applies to payment_fusion gateway only. Allowed values - true,false

allow_partial_authboolean

Sets the flag for allowing partial payment

zip_codestring

5 digit ZIP code. Optional value indicating the cardholder's zip code.

name_on_checkstring required

The check name on check. Please provide one of 'name_on_check' and 'acount_number' and 'routing_number' or 'ach_token' or 'micr'.

routing_numberstring required

The check routing number. Please provide one of 'name_on_check' and 'acount_number' and 'routing_number' or 'ach_token' or 'micr'.

account_numberstring required

The check account number. Please provide one of 'name_on_check' and 'acount_number' and 'routing_number' or 'ach_token' or 'micr'.

check_numberstring

Check number.

ach_tokenstring required

The check token. Please provide one of 'name_on_check' and 'acount_number' and 'routing_number' or 'ach_token' or 'micr'.

micrstring required

The check MICR. Please provide one of 'name_on_check' and 'acount_number' and 'routing_number' or 'ach_token' or 'micr'.

drivers_licensestring

Check owner's driver's license number.

statestring

Check owner's two-character state code.

ssnstring

Check owner's social security number.

check_typestring

Optional parameter that identifies the type of check used in the transaction.

check_account_typestring

Optional parameter that identifies the type of account used as a source of funds.

email_addressstring

Check owner's email address.

phone_numberstring

Check owner's phone number.

street_1string

Check owner's address street(1).

street_2string

Check owner's address street(2).

street_3string

Check owner's address street(3).

citystring

Check owner's address city.

state_or_province_codestring

Check owner's address state or province code.

postal_codestring

Check owner's address postal code.

country_codestring

Check owner's address country code.

street_addressstring

Optional value indicating the cardholder's street address.

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.

client_idstring

Used to track the workstation associated with the transaction.

sec_codestring

Optional value indicating the processor SEC Code. Allowed values - "WEB", "PPD", "CCD", "TEL", "ARC"

callback_url_1string

One of the three URLs where Transaction Broker will POST to when a HPP request is completed. This eliminates the need for polling for the request's status. Only HTTPS URLs are allowed. The callback will retry if the host is unresponsive. The response received from the callback url must have the response code 2xx. Basic auth credentials may be added in to url ie. 'https://username:password@address.com' or as an url param 'https://address.com?token=secret'. Size range - 0..2000.

callback_url_2string

One of the three URLs where Transaction Broker will POST to when a HPP request is completed. This eliminates the need for polling for the request's status. Only HTTPS URLs are allowed. The callback will retry if the host is unresponsive. The response received from the callback url must have the response code 2xx. Basic auth credentials may be added in to url ie. 'https://username:password@address.com' or as an url param 'https://address.com?token=secret'. Size range - 0..2000.

callback_url_3string

One of the three URLs where Transaction Broker will POST to when a HPP request is completed. This eliminates the need for polling for the request's status. Only HTTPS URLs are allowed. The callback will retry if the host is unresponsive. The response received from the callback url must have the response code 2xx. Basic auth credentials may be added in to url ie. 'https://username:password@address.com' or as an url param 'https://address.com?token=secret'. Size range - 0..2000.

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_responseGatewayResponse

The response comming from 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

tokenstring

The check token used when processing the transaction.

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"

ach_tokenstring

The check token used when processing the transaction.

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",
  "token": "string",
  "tip_amount": "string",
  "transaction_status": "string",
  "ach_token": "string",
  "v": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.