Overview
Configuration is provided for establishing connections with PayTrace service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
This guide provides a step-by-step walkthrough for creating a connection to the PayTrace REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your PayTrace instance.
This guide demonstrates how to read data from the PayTrace service resource using the COZYROC REST Source component.
This guide explains how to write data to the PayTrace service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.paytrace.com/v3
.
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify your PayTrace API username..
- client_secret: Required. Specify your PayTrace API password.
- IntegratorID: Required. Specify assigned Integrator ID.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.paytrace.com/support/home#14000041395.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customer
.
The result is extracted from:{{=response.data}}
.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Customer-Profile-(Vault)/operation/get_customers_v3_customer_get.
- [Read single] action
-
Endpoint URL address:
/customer/{{=parameters.id}}
.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Customer-Profile-(Vault)/operation/get_customer_detail_v3_customer__customer_id__get.
- [Read export] action
-
Endpoint URL address:
/customer/export
.
The result is extracted from:{{=response.data}}
.
The result is paginated.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Customer-Profile-(Vault)/operation/get_customer_export_v3_customer_export_get.
- [Create] action
-
Endpoint URL address:
/customer/create
.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ integrator_id: connection.user.IntegratorID }, item)}}
Documentation: https://developers.paytrace.com/support/home#14000045010.
-
application/json:
- [Update] action
-
Endpoint URL address:
/customer/update
.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ integrator_id: connection.user.IntegratorID }, item)}}
Documentation: https://developers.paytrace.com/support/home#14000045184.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/customer/delete
.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ integrator_id: connection.user.IntegratorID }, item)}}
Documentation: https://developers.paytrace.com/support/home#14000045268.
-
application/json:
- customer_id
A key field. Data type: DT_I4
- merchant_id
Data type: DT_I4
- customer_label
Template: ShortText.
- name
Template: ShortText.
- first_name
Template: ShortText.
- middle_name
Template: ShortText.
- last_name
Template: ShortText.
Template: ShortText.
- phone
Template: ShortText.
- card_masked
Template: ShortText.
- address
Template: ShortText.
- address2
Template: ShortText.
- country
Template: ShortText.
- zip_code
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- shipping_name
Template: ShortText.
- shippingAddress
Template: ShortText. The gathered value is processed with
{{=item.shipping_address}}
expression.- shipping_address2
Template: ShortText.
- shipping_county
Template: ShortText.
- shipping_country
Template: ShortText.
- shipping_zip_code
Template: ShortText.
- shipping_city
Template: ShortText.
- shipping_state
Template: ShortText.
- exp_month
Template: ShortText.
- exp_year
Template: ShortText.
- cid
Data type: DT_I4
- custid
Template: ShortText.
- id
Data type: DT_I4
- customer_tax_id
Template: ShortText.
- note
Template: ShortText.
- credit_card
Template: CreditCard.
- billing_address
Template: Address.
- shipping_address
Template: Address.
- check
Template: Check.
- created
Template: Created.
- discretionary_data
Template: DiscretionaryDataT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/recurrence/export/by-customer/{{=parameters.customerId}}
.
The result is extracted from:{{=response.data}}
.The action has the following user-defined parameters:
- customerId: Specify the customer identifier to find all recurrence payments for a customer.
- [Read approved] action
-
Endpoint URL address:
/recurrence/export/approved/by-customer/{{=parameters.customerId}}
.
The result is extracted from:{{=[response.data]}}
.The action has the following user-defined parameters:
- customerId: Required. Specify the customer identifier to most recurring approved transaction.
- [Create] action
-
Endpoint URL address:
/recurrence/create
.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Recurring-Payment/operation/recurrence_create_v3_recurrence_create_post.
- [Update] action
-
Endpoint URL address:
/recurrence
.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Recurring-Payment/operation/recurrence_update_v3_recurrence_patch.
- [Delete] action
-
Endpoint URL address:
/recurrence
.Documentation: https://developers.paytrace.com/support/home#14000046299.
- id
A key field. Data type: DT_I4
- success
Data type: DT_BOOL
- response_code
Data type: DT_I4
- customer_label
Template: ShortText.
- status_message
Template: LongText.
- created
Template: Created.
- approval_code
Template: ShortText.
- amount
Data type: DT_R8
- surcharge_amount
Data type: DT_R8
- surcharge_rate
Data type: DT_R8
- next_date
Template: Date.
- discretionary_data
Template: DiscretionaryDataT.
- description
Template: LongText.
- recurrence
Field components:
-
Uses template:
Date
. - Contains the following components: id, amount, customer_receipt, frequency, start_date, total_count, transaction_type, description, customer_id, next_date, current_count, repeat_count, sec_code.
-
Uses template:
- customer_id
Template: ShortText.
- total_count
Data type: DT_R8
- current_count
Data type: DT_R8
- repeat_count
Data type: DT_I4
- discretionary_data
Template: DiscretionaryDataT.
- apply_surcharge
Data type: DT_BOOL
- include_surcharge_info
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/checks/transactions
.
The result is extracted from:{{=response.items}}
.The action has the following user-defined parameters:
- merchant_id: Required. Specify to filter ACH transaction records based on the merchant's unique ID.
- start_date: Required. Specify the start date to indicate the beginning in format MM/DD/YYYY.
- end_date: Required. Specify the end date to indicate the ending in format MM/DD/YYYY.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/ACH-Transaction-Records/operation/get_transaction_by_criteria_v3_checks_transactions_get.
- [Read single] action
-
Endpoint URL address:
/checks/transactions/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/ACH-Transaction-Records/operation/get_transaction_v3_checks_transactions__ach_transaction_id__get.
- [Read idempotency] action
-
Endpoint URL address:
/checks/transactions/idempotency-keys/{{=parameters.idempotency_key}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- idempotency_key: Required. Specify a unique idempotency_key.
The resource includes the fields from the AchTransaction template.
- receipt
Template: Receipt. The value is gathered from
/checks/receipt/{{=item.transaction_id}}
address.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/checks/payments
.
The action uses POST method.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/ACH-Check-Processing/operation/run_check_payment_v3_checks_payment_post.
- merchant_id
Data type: DT_I4
- idempotency_key
Data type: DT_GUID
- is_aof
Data type: DT_BOOL
- customer_id
Data type: DT_I4
- std_entry_class
Template: ShortText.
- bank_account
Field components:
-
Uses template:
ShortText
. - Contains the following components: account_number, routing_number, account_type.
-
Uses template:
- invoice_number
Template: ShortText.
- description
Template: ShortText.
- billing_address
Template: Address.
- billing_name
Template: ShortText.
- billing_email
Template: ShortText.
- shipping_address
Template: Address.
- shipping_name
Template: ShortText.
- amount
Data type: DT_R8
- action
Template: ActionT. Field components:
- Contains the following components: void_transaction, refund.
Based on resource template Base.
- [Read self] action
-
Endpoint URL address:
/user/self
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- merchant_id: Required. Specify to filter ACH transaction records based on the merchant's unique ID.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/User-Management/operation/get_from_token_v3_user_self_get.
- [Read merchant id] action
-
Endpoint URL address:
/users/by-merchant-id/{{=parameters.merchant_id}}
.
The result is extracted from:{{=response}}
.
The result is paginated.The action has the following user-defined parameters:
- merchant_id: Required. Specify merchant's unique ID.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/User-Management/operation/get_users_by_merchant_id_v3_users_by_merchant_id__merchant_id__get.
- [Update] action
-
Endpoint URL address:
/password/change
.
The action uses POST method.Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/User-Management/operation/update_user_password_v3_password_change_post.
- user_id
A key field. Data type: DT_UI8
- username
Template: ShortText.
- contact
Template: ShortText.
Template: ShortText.
- account_id
Template: ShortText.
- paytrace_id
Template: ShortText.
- is_admin
Data type: DT_BOOL
- is_api_user
Data type: DT_BOOL
- is_reseller
Data type: DT_BOOL
- is_reseller_2
Data type: DT_BOOL
- can_delete_customers
Data type: DT_BOOL
- can_manage_api
Data type: DT_BOOL
- can_manage_cart
Data type: DT_BOOL
- can_manage_cart_design
Data type: DT_BOOL
- can_manage_customer
Data type: DT_BOOL
- can_manage_design
Data type: DT_BOOL
- can_manage_discretionary
Data type: DT_BOOL
- can_manage_products
Data type: DT_BOOL
- can_manage_recurring_payments
Data type: DT_BOOL
- can_manage_security
Data type: DT_BOOL
- can_manage_users
Data type: DT_BOOL
- can_only_view_own_ach_transactions
Data type: DT_BOOL
- can_only_view_own_transactions
Data type: DT_BOOL
- can_process_ach_referenced_refunds
Data type: DT_BOOL
- can_process_ach_sales
Data type: DT_BOOL
- can_process_ach_settlement
Data type: DT_BOOL
- can_process_ach_unreferenced_refunds
Data type: DT_BOOL
- can_process_ach_voids
Data type: DT_BOOL
- can_process_captures
Data type: DT_BOOL
- can_process_forced_sales
Data type: DT_BOOL
- can_process_referenced_refunds
Data type: DT_BOOL
- can_process_sales
Data type: DT_BOOL
- can_process_settlement
Data type: DT_BOOL
- can_process_unreferenced_refunds
Data type: DT_BOOL
- can_process_voids
Data type: DT_BOOL
- can_view_ach_transactions
Data type: DT_BOOL
- can_view_reseller_statements
Data type: DT_BOOL
- can_view_transactions
Data type: DT_BOOL
- can_manage_ach_admin
Data type: DT_BOOL
- can_manage_contacts_admin
Data type: DT_BOOL
- can_manage_help_admin
Data type: DT_BOOL
- can_manage_statements_admin
Data type: DT_BOOL
- can_create_merchants_reseller
Data type: DT_BOOL
- can_manage_merchant_users_reseller
Data type: DT_BOOL
- can_manage_merchants_reseller
Data type: DT_BOOL
- can_manage_reseller_users_reseller
Data type: DT_BOOL
- can_modify_merchants_reseller
Data type: DT_BOOL
- has_read_only_merchant_access_reseller
Data type: DT_BOOL
- has_read_only_reseller_access_reseller
Data type: DT_BOOL
- sale_ceiling
Data type: DT_R8
- refund_ceiling
Data type: DT_R8
- new_password
Template: ShortText.
- password
Template: ShortText.
Based on resource template General.
- [Read date range] action
-
Endpoint URL address:
/transactions/export/by-date
.
The result is extracted from:{{=response.data.transactions || [response.data.transaction]}}
.The action has the following user-defined parameters:
- start_date: Required. Specify the start date to indicate the beginning in format MM/DD/YYYY.
- end_date: Required. Specify the end date to indicate the ending in format MM/DD/YYYY.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Reporting-Transactions/operation/transaction_export_by_date_v3_transactions_export_by_date_post.
- [Read id] action
-
Endpoint URL address:
/transaction/export/{{=parameters.transaction_id}}
.
The result is extracted from:{{=response.data.transactions || [response.data.transaction]}}
.The action has the following user-defined parameters:
- transaction_id: Required. Specify a unique identifier for check transaction.
The resource includes the fields from the Transaction template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/batch/export/by-date
.
The result is extracted from:{{=response.batches}}
.The action has the following user-defined parameters:
- start_date: Required. Specify the start date to indicate the beginning in format MM/DD/YYYY.
- end_date: Required. Specify the end date to indicate the ending in format MM/DD/YYYY.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Reporting-Batches/operation/batch_export_by_date_v3_batch_export_by_date_post.
- [Read number] action
-
Endpoint URL address:
/batches/export
.
The result is extracted from:{{=[response.batch]}}
.The action has the following user-defined parameters:
- batch_number: Required. Specify a batch number to find specific batch details.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Reporting-Batches/operation/batch_export_v3_batch_export_post.
- number
A key field. Data type: DT_I4
- visa
Template: BatchRecord.
- master_card
Template: BatchRecord.
- diners_club
Template: BatchRecord.
- american_express
Template: BatchRecord.
- discover
Template: BatchRecord.
- private_label
Template: BatchRecord.
- settled
Template: ShortText.
- created
Template: Created.
- transaction_count
Data type: DT_I4
- net_amount
Data type: DT_R8
- sale_count
Data type: DT_I4
- sales_amount
Data type: DT_R8
- refund_count
Data type: DT_I4
- refund_amount
Data type: DT_R8
- settled_transactions
The value is gathered from
/batch/export/transactions
address. The gathered value is processed with{{=response.transactions}}
expression. Field components:- An array.
-
Uses template:
Transaction
.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/batch/export/transactions
.
The result is extracted from:{{=response.transactions}}
.The action has the following user-defined parameters:
- batch_number: Required. Specify a batch number to find specific batch details.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Reporting-Batches/operation/batch_export_settled_transactions_v3_batch_export_transactions_post.
The resource includes the fields from the Transaction template.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/card/transaction/{{=parameters.id}}
.The action has the following user-defined parameters:
- merchantId: Required. Specify the merchant identifier.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Transaction-Records/operation/get_transaction_by_id_v3_card_transaction__transaction_id__get.
- [Read capturable] action
-
Endpoint URL address:
/card/transactions/capturable/{{=parameters.merchantId}}
.
The result is extracted from:{{=response.data}}
.The action has the following user-defined parameters:
- merchantId: Required. Specify the merchant identifier.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Transaction-Records/operation/get_capturable_v3_card_transactions_capturable__merchant_id__get.
- [Read voidable] action
-
Endpoint URL address:
/card/transactions/capturable/{{=parameters.merchantId}}
.
The result is extracted from:{{=response.data}}
.The action has the following user-defined parameters:
- merchantId: Required. Specify the merchant identifier.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Transaction-Records/operation/get_voidable_v3_card_transactions_voidable__merchant_id__get.
- [Read refundable] action
-
Endpoint URL address:
/card/transactions/capturable/{{=parameters.merchantId}}
.
The result is extracted from:{{=response.data}}
.The action has the following user-defined parameters:
- merchantId: Required. Specify the merchant identifier.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Transaction-Records/operation/get_refundable_v3_card_transactions_refundable__merchant_id__get.
- transaction_id
A key field. Data type: DT_UI8
- card_first6
Data type: DT_I4
- card_last4
Data type: DT_I4
- requested_amount
Data type: DT_R8
- legacy_record_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- invoice_number
Template: ShortText.
- approval_message
Template: LongText.
- paytrace_user
Template: ShortText.
- merchant_id
Data type: DT_I4
- status_changed_at
Template: ShortText.
- customer_id
Data type: DT_I4
- description
Template: ShortText.
- shipping_name
Template: ShortText.
- billing_name
Template: ShortText.
- billing_email
Template: ShortText.
- billing_phone
Template: ShortText.
- card_expiration_year
Data type: DT_I4
- card_expiration_month
Data type: DT_I4
- tax_amount
Data type: DT_R8
- customer_reference
Template: ShortText.
- billing_address
Template: Address.
- shipping_address
Template: Address.
- authorization_result_message
Template: ShortText.
- surcharge_was_applied
Data type: DT_BOOL
- action
Template: ShortText.
- card_brand
Template: ShortText.
- surcharge_amount
Data type: DT_R8
- custom_dba
Template: ShortText.
- entry_method
Template: ShortText.
- card_masked
Template: ShortText.
- processor
Template: ShortText.
- status
Template: ShortText.
- settle_amount
Data type: DT_R8
- auth_method
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
X-Integrator-Id:
{{=connection.user.IntegratorID}}
-
X-Permalinks:
{{=parameters.get('X-Permalinks')}}
-
offset:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
X-Integrator-Id:
- [Read single] action
-
The result is extracted from:{{=[response.data]}}
.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify the record identifier.
Documentation: https://api.sandbox.paytrace.com/v3/redoc#tag/Customer-Profile-(Vault)/operation/get_customer_detail_v3_customer__customer_id__get.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
Based on resource template Base.
- [Read] action
-
The action uses POST method.
The result is paginated.The following request parameters will be automatically processed:
-
X-Integrator-Id:
{{=connection.user.IntegratorID}}
-
X-Permalinks:
{{=parameters.get('X-Permalinks')}}
-
application/json:
{{=PayTrace.parseParameters(parameters)}}
-
_includeUserParameters:
{{=undefined}}
-
X-Integrator-Id:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Address
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, street_address, street_address2, city, state, county, zip, country, shipping_address.
-
Uses template:
- Created
Field components:
-
Uses template:
ShortText
. - Contains the following components: through, at, by, from_ip.
-
Uses template:
- Check
Field components:
-
Uses template:
ShortText
. - Contains the following components: account_number, routing_number, masked_account_number, masked_routing_number.
-
Uses template:
- CreditCard
Field components:
-
Uses template:
ShortText
. - Contains the following components: masked_number, number, expiration_month, expiration_year, encrypted_number.
-
Uses template:
- Refund
Field components:
-
Uses template:
ShortText
. - Contains the following components: customer_id, amount, check, billing_address, shipping_address, invoice_id, tax_amount, email, description, customer_reference_id, discretionary_data.
-
Uses template:
- BatchRecord
Field components:
- Contains the following components: sales, collected, refunds, refunded.
- AchTransaction
Field components:
-
Uses template:
ShortText
. - Contains the following components: transaction_id, idempotency_key, tran_type, invoice_number, amount, std_entry_class, payment_descriptor, merchant_id, customer_id, billing_name, billing_email, shipping_name, entry_method, account_number_trunc, routing_number_trunc, account_type, check_number, transaction_status, tran_date, settled_at, original_ach_transaction_uuid, reversal_status, reversal_amount, reversible_amount, created_by, billing_address, shipping_address, tran_client_ip, error_code, error_message, return_code, return_message.
-
Uses template:
- Transaction
Field components:
-
Uses template:
CreditCard
. - Contains the following components: transaction_id, credit_card, transaction_type, description, amount, invoice_id, shipping_address, billing_address, receipt_emailed_to, tax_amount, customer_reference_id, approval_code, approval_message, avs_response, csc_response, status_code, status_message, created, settled, customer_id, discretionary_data, surcharge_amount, is_surcharge_applied, total_amount.
-
Uses template:
- Receipt
Field components:
-
Uses template:
ShortText
. - Contains the following components: magtek_enabled, merchant_id, reseller_id, merchant_name, merchant_identification, metis_enabled, processor, zip_code, state, recurring, basic, professional, cash_advance, ach, card_type_1, card_type_2, card_type_3, card_type_4, card_type_5, card_type_6, viewbits_dict, billed_by_paytrace, is_merchant, is_reseller, has_recurring, has_integration, has_shopping_cart, is_basic, is_professional, is_cash_advance, processor_network, can_handle_level_3, is_ngt_metis_merchant, has_check_ach, accepted_card_types, industry, security_timeout, security_force_address, security_force_zip, security_force_csc, security_force_invoice, security_transaction_threshold, enforce_for_card_present, time, address, address2, city, phone, fax, email, email2, web, bg_color, fg_color, border, font, error_font, ok_font, header_font, hyper_font, table_background, banner_image, banner_color, footer_color, footer_font, footer_text, header_text, image, custom_statement_description, free_text, receipt_header_1, receipt_header_2, receipt_header_3, receipt_header_4, receipt_footer_1, receipt_footer_2, display_drop_down, server, tax_present_on_receipt, user_name_present_on_receipt, receipt_email_address, phone_present_on_receipt, theme_id, print_receipt, cart, is_surcharge_monthly_product, ach_transaction_details.
-
Uses template:
- DiscretionaryDataT
Field components:
- An array.
- Contains the following components: disc_id, value.
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.