developers.paytrace.comPayTrace JSON API

JSON CURL RUBY CLASSIC ASP PHP CURLIntroduction Getting Started API Parameters Schema Sample Code Authentication Request Header Response Codes AVS and CSC Response API Errors API Error Codes Testing Information Status Updates and Communications ClientSide Encryption Library Protect.js Protect.js Styling EMV EMV Sale EMV Authorization EMV Refund Auth Fall Back Handling Keyed Sale Swiped Sale Sale By Transaction ID Vault Sale By Customer ID Protect Sale Protect Sale and Create Customer Keyed Authorization Swiped Authorization Authorization By Transaction ID Vault Authorization By Customer ID Protect Authorization Capture Transaction Void Transaction Adjust Transaction Keyed Refund Auth Swiped Refund Auth Refund Auth By Transaction ID Refund Auth by Customer ID Keyed Refund Swiped Refund Refund Transaction Vault Refund Email Receipt Create Customer Profile Create Customer Profile From Transaction Update Customer Profile Delete Customer Profile Export Customer Profile Create Customer Profile Using Protect.js Update Customer Profile using Protect.js About Level 3 Data With MasterCard With Visa Settle Transactions Export Batch Export Batches Export Settled Transactions Export Transaction Export Transactions Create Recurring Payment Update Recurring Payment Delete Recurring Payment Export Recurring Payments Export Recurring Payment Update Password Sale by account Vault Sale Hold by account Vault Hold Refund by account Vault Refund Refund Transaction Fund Check Void Check Email Receipt Export Check Transaction Export Check Transactions Export Transaction Surcharge Information Contact us JSON API Introduction Getting Started API Parameters Schema Sample Code Authentication Request Header Response Codes AVS and CSC Response API Errors API Error Codes Testing Information Status Updates and Communications Payment UIs ClientSide Encryption Library Protect.js Protect.js Styling EMV EMV EMV Sale EMV Authorization EMV Refund Auth Fall Back Handling Sale Transactions Keyed Sale Swiped Sale Sale By Transaction ID Vault Sale By Customer ID Protect Sale Protect Sale and Create Customer Authorizations Keyed Authorization Swiped Authorization Authorization By Transaction ID Vault Authorization By Customer ID Protect Authorization Capture Capture Transaction Void Void Transaction Adjust Adjust Transaction Refund Authorizations Keyed Refund Auth Swiped Refund Auth Refund Auth By Transaction ID Refund Auth by Customer ID Refunds Keyed Refund Swiped Refund Refund Transaction Vault Refund Email Receipt Email Receipt Customer Profile (Vault) Create Customer Profile Create Customer Profile From Transaction Update Customer Profile Delete Customer Profile Export Customer Profile Create Customer Profile Using Protect.js Update Customer Profile using Protect.js Level 3 Data About Level 3 Data With MasterCard With Visa Settlement Settle Transactions Reporting Export Batch Export Batches Export Settled Transactions Export Transaction Export Transactions Recurring Payment Create Recurring Payment Update Recurring Payment Delete Recurring Payment Export Recurring Payments Export Recurring Payment User Management Update Password ACH Processing ACH Sale Sale by account Vault Sale ACH Hold Hold by account Vault Hold ACH Refund Refund by account Vault Refund Refund Transaction Manage Check Fund Check Void Check Email Receipt ACH Reporting Export Check Transaction Export Check Transactions General Surcharge Export Transaction Surcharge Information JSON CURL RUBY CLASSIC ASP PHP CURLIntroduction The PayTrace API (Application Programming Interface) is a poroval code is generated by the credit card issuer and returned with a successful transaction. string Data Format 6 approval_message A response from the credit card issuer with a successful requested transaction. string Data Format 1-255 avs_response A unique string identifier returned by the AVS. Check out AVS Response for the possible values. string Data Format 1-255 csc_response A unique string identifier returned by the card issuer on CSC verification. Check out CSC Response for possible values. The card security code response is generated by the credit card issuer when a successful call to process any type of transaction is requested. The CSC provided with the request, is compared to the CSC assigned to the credit card. Check out possible AVS responses. string Data Format 1-255 emv_details An array containing details of the EMV transaction. For emv_details supported Schema, Click here emv_details Schema. array of an object/objects - transaction_id A unique identifier for each transaction in the PayTrace system. number 1-9 external_transaction_id A unique identifier of the request from your system that will be returned in the response. string Data Format 1-50 masked_card_number The credit card number with all digits masked and replaced with ’x’ except the last 4 digits. This parameter will be returned in the JSON response only when the Credit Card number is one of the request parameters. string Data Format 15, 16, 19 customer_id A unique identifier for each customer in the PayTrace system, the value will be the same as what is provided with the request. string Data Format 1-25 customers An array of customer profiles. For Customer profile supported Schema, Click here Customer_Record Schema. array of an object/objects - batch This object contains details about the batch. Note: For the supported Schema, Click here Batch_Record Schema object - batches An array of batch summary records. For the supported Schema, Click here Batch_Summary_Record Schema array of objects - recurrence For the supported Schema, Click here Recurrence_Record Schema. Note: Only the id will be returned on the successful creation of a recurring payment. object - recurrences An array of Recurrence Record objects. This parameter is used with the Export recurring transactions method. For supported Schema, Click here Export_Recurrence_Record Schema. Note: If the Request parameter is a recurrence id, you will get an array of single recurrence transaction records. If the Request parameter is a customer id, you will get an array of one or more transaction records. array of objects - transactions An array of transaction detail records within a batch report. Note: The transaction records will not include discretionary data. For supported Schema, Click here Transaction_Record Schema. An array of transaction detail record objects for the given date range or a single transaction. Note: These transaction details contains discretionary data. For supported Schema, Click here Transaction_Detail_Record Schema array of objects - created Transaction/Batch/Customer record creation details. For supported Schema, Click here Response_Creation_Record Schema. object - next_date The next date when a recurring transaction is scheduled to occur. The format will be MM/DD/YYYY. string 10 description Optional 255-character max text describing the transaction, products, customers, or other attributes of the transaction. string Data Format 1-255 amount The dollar amount of the transaction. This must be a positive number up to two decimal places. number 1-12 discretionary_data Discretionary_data details. For the supported Schema, Click here Discretionary_Data Schema. object - Data Format String with the combination of numbers and alphabets (including lower case and upper case). three content four content five content six content Schema Here are the Schemas, used by the JSON API Credit_Card Schema Attribute Description Type Attribute Requirement number or encrypted_number or masked_number* The customer’s credit card number must be a valid credit card number that your PayTrace account is set up to accept. Use the encrypted_number attribute when submitting encrypted credit card numbers by the PayTrace Client-Side Encryption JavaScript Library Note: masked_number* is a response attribute that is returned with the Export Customer Profile (Vault) and Reporting API methods. string Required expiration_month...