| Attribute |
Data Type |
Field Type |
Description |
| customer_id |
string |
R |
Unique identifier for a customer profile stored in your Customer Database(Vault). |
| transaction_id |
string |
R |
A unique identifier for each transaction in the PayTrace system. This unique identifier is returned in the transaction_id attribute of an API response. |
| billing_address |
object |
O |
Supporting attributes listed below. This object is only required if the "Require Billing Address" and/or "Require Billing Zip" fields are enabled on the Security Settings page of the PayTrace Virtual Terminal |
| billing_address.name |
string |
O |
Name that appears on the credit card. |
| billing_address.street_address |
string |
O C |
Street Billing Address that is on file for the cardholder's account. This attribute is only required if the "Require Billing Address"field is enabled on the Security Settings page of the PayTrace Virtual Terminal |
| billing_address.street_address2 |
string |
O |
Second line of the Street Billing Address that is on file for the cardholder's account. |
| billing_address.city |
string |
O |
City of the Billing Address that is on file for the cardholder's account. |
| billing_address.state |
string |
O |
State of the Billing Address that is on file for the cardholder's account. |
| billing_address.zip |
string |
O C |
Zipcode of the Billing Address that is on file for the cardholder's account. This attribute is only required if the "Require Billing Zip" field is enabled on the Security Settings page of the PayTrace Virtual Terminal. International Zipcodes require the country attribute. |
| billing_address.country |
string |
O C |
2-digit ISO-3166-2 Country Code of the Billing Address that is on file for the cardholder's account. International Zipcodes require the this attribute. |
| shipping_address |
string |
O |
Supporting attributes listed below. |
| shipping_address.name |
string |
O |
Name of the person where the product is delivered. |
| shipping_address.street_address |
string |
O |
Address where the product is delivered. |
| shipping_address.street_address2 |
string |
O |
Second line of the address where the product is delivered. |
| shipping_address.city |
string |
O |
City where the product is delivered. |
| shipping_address.state |
string |
O |
State where the product is delivered. |
| shipping_address.zip |
string |
O |
Zipcode where the product is delivered |
| shipping_address.country |
string |
O |
2-digit ISO-3166-2 Country Code of where the product is delivered. |
| email |
string |
O |
Customer's email address. |
| phone |
string |
O |
Customer's phone number (i.e. 555-555-5555, or 5555555555). |
| description |
string |
O |
Optional 255-character max text describing the transaction, products, customers, or other attributes of the transaction. |
| fax |
string |
O |
Customer's fax number (i.e. 555-555-5555, or 5555555555). |
| direct_deposit_account |
string |
O |
Checking account number for processing check transactions or managing customer profiles. |
| transit_routing_number |
string |
O |
Transit routing number for processing check transactions or managing customer profiles. |
| discretionary_data |
string |
O |
future enhancement coming soon |