$transactionsReadController = $client->getTransactionsReadController();TransactionsReadController
Get BIN info record associated with a transaction
function getBINInfo(string $transactionId): ResponseTransactionBinInfo| Parameter | Type | Tags | Description |
|---|---|---|---|
transactionId |
string |
Template, Required | Transaction ID Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
$transactionId = '11e95f8ec39de8fbdb0a4f1a';
$result = $transactionsReadController->getBINInfo($transactionId);{
"type": "TransactionBinInfo",
"data": {
"issuer_bank_name": "Cartasi S.P.A.",
"country_code": "US",
"detail_card_product": "V",
"detail_card_indicator": "X",
"fsa_indicator": "F",
"prepaid_indicator": "P",
"product_id": "G",
"regulator_indicator": "N",
"visa_product_sub_type": null,
"visa_large_ticket_indicator": null,
"account_fund_source": "C",
"card_class": "B",
"token_ind": null,
"issuing_network": null
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
Get single transaction record
function getTransaction(string $transactionId, ?array $expand = null): ResponseTransaction| Parameter | Type | Tags | Description |
|---|---|---|---|
transactionId |
string |
Template, Required | Transaction ID Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
expand |
?(string[]) (Expand47Enum) |
Query, Optional | Most endpoints in the API have a way to retrieve extra data related to the current record being retrieved. For example, if the API request is for the accountvaults endpoint, and the end user also needs to know which contact the token belongs to, this data can be returned in the accountvaults endpoint request. Constraints: Unique Items Required, Pattern: ^[\w]+$ |
$transactionId = '11e95f8ec39de8fbdb0a4f1a';
$result = $transactionsReadController->getTransaction($transactionId);{
"type": "Transaction",
"data": {
"additional_amounts": [
{
"type": "cashback",
"amount": 10,
"account_type": "credit",
"currency": 840
}
],
"billing_address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"street": "43155 Main Street STE 2310-C",
"phone": "3339998822"
},
"checkin_date": "2021-12-01",
"checkout_date": "2021-12-01",
"clerk_number": "AE1234",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"custom_data": {},
"customer_id": "customerid",
"description": "some description",
"identity_verification": {
"dl_state": "MI",
"dl_number": "1235567",
"dob_year": "1980"
},
"iias_ind": 1,
"image_front": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"image_back": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"installment": true,
"installment_number": 1,
"installment_count": 1,
"location_api_id": "location-api-id-florida-2",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"advance_deposit": false,
"no_show": false,
"notification_email_address": "johnsmith@smiths.com",
"order_number": "433659378839",
"po_number": "555555553123",
"quick_invoice_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring": {
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"description": "Description",
"end_date": "2021-12-01",
"installment_total_count": 20,
"interval": 1,
"interval_type": "d",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"notification_days": 2,
"payment_method": "cc",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring_api_id": "recurring1234abcd",
"start_date": "2021-12-01",
"status": "active",
"transaction_amount": 3,
"terms_agree": true,
"terms_agree_ip": "192.168.0.10",
"recurring_c1": "recurring custom data 1",
"recurring_c2": "recurring custom data 2",
"recurring_c3": "recurring custom data 3",
"send_to_proc_as_recur": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"next_run_date": "2021-12-01",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"recurring_type_id": "i"
},
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
{
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"tax": 0,
"tip_amount": 0,
"transaction_amount": 0,
"secondary_amount": 0,
"transaction_api_id": "transaction-payment-abcd123",
"transaction_c1": "custom-data-1",
"transaction_c2": "custom-data-2",
"transaction_c3": "custom-data-3",
"bank_funded_only_override": false,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"terminal_id": "11e95f8ec39de8fbdb0a4f1a",
"account_holder_name": "smith",
"account_type": "checking",
"token_id": "11e95f8ec39de8fbdb0a4f1a",
"ach_identifier": "P",
"ach_sec_code": "C21",
"auth_amount": 1,
"auth_code": "BR349K",
"avs": "BAD",
"avs_enhanced": "N",
"cardholder_present": true,
"card_present": true,
"check_number": "8520748520963",
"customer_ip": "192.168.0.10",
"cvv_response": "N",
"entry_mode_id": "C",
"emv_receipt_data": {
"AID": "a0000000042203",
"APPLAB": "US Maestro",
"APPN": "US Maestro",
"CVM": "Pin Verified",
"TSI": "e800",
"TVR": "0800008000"
},
"first_six": "545454",
"last_four": "5454",
"payment_method": "cc",
"terminal_serial_number": "1234567890",
"transaction_settlement_status": null,
"charge_back_date": "2021-12-01",
"is_recurring": true,
"notification_email_sent": "true",
"par": "Q1J4Z28RKA1EBL470G9XYG90R5D3E",
"reason_code_id": 1000,
"recurring_id": "11e95f8ec39de8fbdb0a4f1a",
"settle_date": "2021-12-01",
"status_code": 101,
"transaction_batch_id": "11e95f8ec39de8fbdb0a4f1a",
"verbiage": "APPROVED",
"void_date": "2021-12-01",
"batch": "2",
"terms_agree": true,
"response_message": null,
"return_date": "2021-12-01",
"trx_source_id": 8,
"account_vault": {
"account_holder_name": "John Smith",
"account_number": "545454545454545",
"account_vault_api_id": "accountvaultabcd",
"accountvault_c1": "accountvault custom 1",
"accountvault_c2": "accountvault custom 2",
"accountvault_c3": "accountvault custom 3",
"ach_sec_code": "WEB",
"billing_address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"street": "43155 Main Street STE 2310-C",
"phone": "3339998822"
},
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"customer_id": "123456",
"identity_verification": {
"dl_state": "MI",
"dl_number": "1235567",
"ssn4": "8527",
"dob_year": "1980"
},
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"previous_account_vault_api_id": "previousaccountvault123456",
"previous_account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"previous_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_agree": true,
"terms_agree_ip": "192.168.0.10",
"title": "Test CC Account",
"id": "11e95f8ec39de8fbdb0a4f1a",
"account_type": "checking",
"active": true,
"cau_summary_status_id": 1,
"created_ts": 1422040992,
"e_serial_number": "1234567890",
"e_track_data": null,
"e_format": null,
"e_keyed_data": null,
"expiring_in_months": null,
"first_six": "700953",
"has_recurring": false,
"last_four": "3657",
"modified_ts": 1422040992,
"payment_method": "cc",
"ticket": null,
"track_data": null
},
"quick_invoice": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"cc_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"ach_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"due_date": "2021-12-01",
"item_list": [
{
"name": "Bread",
"amount": 20.15
}
],
"allow_overpayment": true,
"email": "email@domain.com",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_api_id": "contact12345",
"customer_id": "11e95f8ec39de8fbdb0a4f1a",
"expire_date": "2021-12-01",
"allow_partial_pay": true,
"attach_files_to_email": true,
"send_email": true,
"invoice_number": "invoice12345",
"item_header": "Quick invoice header sample",
"item_footer": "Thank you",
"amount_due": 245.36,
"notification_email": "email@domain.com",
"payment_status_id": 1,
"status_id": 1,
"note": "some note",
"notification_days_before_due_date": 3,
"notification_days_after_due_date": 7,
"notification_on_due_date": true,
"send_text_to_pay": true,
"files": [
null
],
"remaining_balance": 245.36,
"single_payment_min_amount": 5,
"single_payment_max_amount": 5000,
"cell_phone": "3339998822",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"is_active": true
},
"log_emails": [
{
"subject": "Payment Receipt - 12skiestech",
"body": "This email is being sent from a server.",
"source_address": "\"12skiestech A7t3qi\" <noreply@zeamster.email>",
"return_path": "\"12skiestech A7t3qi\" <noreply@zeamster.email>",
"provider_id": "0100017e67bcc530-e1dd23b4-8a39-4a5b-8d5d-68d51c4c942f-000000",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"reason_sent": "Contact Email",
"reason_model": "Transaction",
"reason_model_id": "11e95f8ec39de8fbdb0a4f1a",
"reply_to": "\"Zeamster\" <emma.p@zeamster.com>",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992
}
],
"is_voidable": true,
"is_reversible": true,
"is_refundable": true,
"is_completable": true,
"is_settled": true,
"created_user": {
"account_number": "5454545454545454",
"address": "43155 Main Street STE 2310-C",
"branding_domain_url": "{branding_domain_url}",
"cell_phone": "3339998822",
"city": "Novi",
"company_name": "Fortis Payment Systems, LLC",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"date_of_birth": "2021-12-01",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "email@domain.com",
"email_trx_receipt": true,
"home_phone": "3339998822",
"first_name": "John",
"last_name": "Smith",
"locale": "en-US",
"office_phone": "3339998822",
"office_ext_phone": "5",
"primary_location_id": "11e95f8ec39de8fbdb0a4f1a",
"requires_new_password": null,
"state": "Michigan",
"terms_condition_code": "20220308",
"tz": "America/New_York",
"ui_prefs": {
"entry_page": "dashboard",
"page_size": 2,
"report_export_type": "csv",
"process_method": "virtual_terminal",
"default_terminal": "11e95f8ec39de8fbdb0a4f1a"
},
"username": "{user_name}",
"user_api_key": "234bas8dfn8238f923w2",
"user_hash_key": null,
"user_type_code": 100,
"password": null,
"zip": "48375",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"status": true,
"login_attempts": 0,
"last_login_ts": 1422040992,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_accepted_ts": 1422040992,
"terms_agree_ip": "192.168.0.10",
"current_date_time": "2019-03-11T10:38:26-0700"
},
"location": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"account_number": "5454545454545454",
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US",
"street": "43155 Main Street STE 2310-C",
"street2": "43155 Main Street STE 2310-C"
},
"branding_domain_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_email_trx_receipt_default": true,
"default_ach": "11e608a7d515f1e093242bb2",
"default_cc": "11e608a442a5f1e092242dda",
"developer_company_id": "11e95f8ec39de8fbdb0a4f1a",
"email_reply_to": "email@domain.com",
"fax": "3339998822",
"location_api_id": "location-111111",
"location_api_key": "AE34BBCAADF4AE34BBCAADF4",
"location_c1": "custom 1",
"location_c2": "custom 2",
"location_c3": "custom data 3",
"name": "Sample Company Headquarters",
"office_phone": "2481234567",
"office_ext_phone": "1021021209",
"recurring_notification_days_default": 0,
"tz": "America/New_York",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"ticket_hash_key": "A5F443CADF4AE34BBCAADF4"
},
"contact": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"account_number": "54545433332",
"contact_api_id": "137",
"first_name": "John",
"last_name": "Smith",
"cell_phone": "3339998822",
"balance": 245.36,
"address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"country": "US",
"street": "43155 Main Street STE 2310-C"
},
"company_name": "Fortis Payment Systems, LLC",
"header_message": "This is a sample message for you",
"date_of_birth": "2021-12-01",
"email_trx_receipt": true,
"home_phone": "3339998822",
"office_phone": "3339998822",
"office_phone_ext": "5",
"header_message_type": 0,
"update_if_exists": 1,
"contact_c1": "any",
"contact_c2": "anything",
"contact_c3": "something",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "email@domain.com",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"active": true
},
"changelogs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"action": "CREATE",
"model": "TransactionRequest",
"model_id": "11ec829598f0d4008be9aba4",
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_details": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"field": "next_run_ts",
"old_value": "1643616000"
}
],
"user": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"username": "email@domain.com",
"first_name": "Bob",
"last_name": "Fairview"
}
}
],
"product_transaction": {
"processor_version": "1_0_0",
"title": "My terminal",
"payment_method": "cc",
"processor": "zgate",
"mcc": "1111",
"tax_surcharge_config": 2,
"partner": "standalone",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"surcharge": {},
"processor_data": {},
"vt_clerk_number": true,
"vt_billing_phone": true,
"vt_enable_tip": true,
"ach_allow_debit": true,
"ach_allow_credit": true,
"ach_allow_refund": true,
"vt_cvv": true,
"vt_street": true,
"vt_zip": true,
"vt_order_num": true,
"vt_enable": true,
"receipt_show_contact_name": true,
"display_avs": true,
"card_type_visa": true,
"card_type_mc": true,
"card_type_disc": true,
"card_type_amex": true,
"card_type_diners": true,
"card_type_jcb": true,
"invoice_location": true,
"allow_partial_authorization": true,
"allow_recurring_partial_authorization": true,
"auto_decline_cvv": true,
"auto_decline_street": true,
"auto_decline_zip": true,
"split_payments_allow": true,
"vt_show_custom_fields": true,
"receipt_show_custom_fields": true,
"vt_override_sales_tax_allowed": true,
"vt_enable_sales_tax": true,
"vt_require_zip": true,
"vt_require_street": true,
"auto_decline_cavv": true,
"current_batch": 34,
"dup_check_per_batch": null,
"quick_invoice_allow": false,
"level3_allow": false,
"payfac_enable": false,
"sales_office_id": "11e95f8ec39de8fbdb0a4f1a",
"hosted_payment_page_allow": false,
"surcharge_id": "11e95f8ec39de8fbdb0a4f1a",
"level3_default": null,
"cau_subscribe_type_id": 0,
"location_billing_account_id": "11eb88b873980c64a21e5fd2",
"product_billing_group_id": "nofees",
"account_number": "12345678",
"run_avs_on_accountvault_create": false,
"accountvault_expire_notification_email_enable": false,
"debit_allow_void": false,
"quick_invoice_text_to_pay": false,
"sms_enable": false,
"vt_show_currency": true,
"receipt_show_currency": false,
"allow_blind_refund": false,
"vt_show_company_name": false,
"receipt_show_company_name": false,
"bank_funded_only": false,
"id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"all_tags": [
{
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"tagTransactions": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"tag_id": "Tag ID",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"declined_recurring_notification": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_ts": 1422040992,
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"payment_recurring_notification": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_ts": 1422040992,
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"developer_company": {
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"terminal": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"default_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_application_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_cvm_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_manufacturer_code": 1,
"title": "My terminal",
"mac_address": "3D:F2:C9:A6:B3:4F",
"local_ip_address": "192.168.0.10",
"port": 10009,
"serial_number": "1234567890",
"terminal_number": "973456789012367",
"terminal_timeouts": {
"card_entry_timeout": 47,
"device_terms_prompt_timeout": 30,
"overall_timeout": 125,
"pin_entry_timeout": 40,
"signature_input_timeout": 35,
"signature_submit_timeout": 38,
"status_display_time": 12,
"tip_cashback_timeout": 25,
"transaction_timeout": 17
},
"tip_percents": {
"percent_1": 0,
"percent_2": 2,
"percent_3": 99
},
"header_line_1": "line 1 sample",
"header_line_2": "line 2 sample",
"header_line_3": "line 3 sample",
"header_line_4": "line 4 sample",
"header_line_5": "line 5 sample",
"trailer_line_1": "trailer 1 sample",
"trailer_line_2": "trailer 2 sample",
"trailer_line_3": "trailer 3 sample",
"trailer_line_4": "trailer 4 sample",
"trailer_line_5": "trailer 5 sample",
"default_checkin": "2021-12-01",
"default_checkout": "2021-12-01",
"default_room_rate": 56,
"default_room_number": "303",
"debit": false,
"emv": false,
"cashback_enable": false,
"print_enable": false,
"sig_capture_enable": false,
"is_provisioned": false,
"tip_enable": false,
"validated_decryption": false,
"communication_type": "http",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"last_registration_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"hosted_payment_page": {
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"location_api_id": null,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "Sample title",
"redirect_url_delay": 15,
"min_payment_amount": 0,
"max_payment_amount": 99999999.99,
"redirect_url_on_approve": null,
"redirect_url_on_decline": null,
"field_configuration": {
"css_mini": true,
"stack": "vertical",
"header": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
},
"body": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
},
"footer": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
}
},
"encryption_key": null,
"stylesheet_url": null,
"parent_send_message": true,
"hide_optional_fields": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"transaction_level3": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"level3_data": {
"destination_country_code": "840",
"duty_amount": 0,
"freight_amount": 0,
"national_tax": 2,
"sales_tax": 200,
"shipfrom_zip_code": "AZ1234",
"shipto_zip_code": "FL1234",
"tax_amount": 10,
"tax_exempt": 0,
"customer_vat_registration": "12345678",
"merchant_vat_registration": "123456",
"order_date": "171006",
"summary_commodity_code": "C1K2",
"tax_rate": 0,
"unique_vat_ref_number": "vat1234",
"line_items": [
{
"description": "cool drink",
"commodity_code": "cc123456",
"discount_amount": 0,
"other_tax_amount": 0,
"product_code": "fanta123456",
"quantity": 12,
"tax_amount": 4,
"tax_rate": 0,
"unit_code": "gll",
"unit_cost": 3,
"alternate_tax_id": "1234",
"debit_credit": "C",
"discount_rate": 11,
"tax_type_applied": "22",
"tax_type_id": "11"
}
]
}
},
"developer_company_id": "Sample Developer Company ID",
"transaction_histories": [
{
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": 101,
"event_date_ts": 1422040992,
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"surcharge_transaction": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"model_name": "Model Name",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"surcharge_fee": 0,
"surcharge_rate": 0,
"surcharge_amount": null,
"surcharge_transaction_min": null,
"surcharge_transaction_max": null,
"created": 1422040992,
"modified": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"surcharge": {
"surcharge_fee": 10,
"surcharge_rate": 1,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"apply_to_user_type_id": "11e95f8ec39de8fbdb0a4f1a",
"title": null,
"surcharge_label": null,
"surcharge_transaction_product_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"signature": {
"signature": "iVBORw0KGgoAAAANSUhEUgAAANwAAAAsCAYAAAAOyNaYAAACvklEQVR4nO3bLZOqUBjA8ScaNxqNRiKRaCQaiXwEG7cRiUajH8FINBqJRCKR+NxyD4OIXtaXw2H3/5s5MwZ39rgz/zkvuKKqgar+YTAYnx/y7wUACwgOsIjgAIsIznFlWerlcpl6GngTgnNYVVW6WCxURDTLsqmngzcgOMdtNhsVERURDYJA8zyfekp4AcE5oCgKzfN8cOvYNM1VdCKiURRNMEu8A8FNrCzLm5j68Q1Fx2o3TwTngCzLNAiCq6D6UTVNo0mS6NfXF+HNGME5or+KeZ7XxrVcLjWOY83zXOu6vnqfeQ/bzHkgOIf0VzHP83Sz2eh6vW4D831fy7JsowvDsH1NdO4jOAfVdX0VXhRFWhSFRlHUrmr7/b4NLU3T9jVbTLcRnMO620ezep1Op3bF832/3XIORQr3EJzjumc7E9HQBUoYhjdnPKJzD8E5xjyT647T6aSr1UpFRPf7ffveuq41TdOHZzyicwvBTeBeVGEY3jwaGBrmWV3/Z82K1z/jca5zB8F9wFBQY6JaLBYax7EmSXJ3DD2v624rzUpoVrsgCDjXOWRWwVVVNfUUrvTDGrNK3YsqTdNRn69pGs2y7NshssV0w2yCK4pCRUSPx+Okc/hfWI9WqbFRPaMbYjc+s7ptt1uic8BsgsvzXEVED4fDR3/P2PPVUFifDOo7THxmPiY03/fZXk7s1wR371z1zPnKlbDGuvc9TKKz78cE9yio3W436vbv1fOV6/oPx010/Ee5PbMLbrfbPRWU53kPb/9+SlRj9L8ALcJ/lNsym+DO5/PTQaVpqnVdT/0RnGLOed0LlikvpH6L2QSnqoPX4QT1mu4FC3/Dz5tVcMDcERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGDRX+EC0ah++pNrAAAAAElFTkSuQmCC",
"resource": "Transaction",
"resource_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"reason_code": {
"id": 50,
"title": "Sample Title"
},
"type": {
"id": 50,
"title": "Sample Title"
},
"status": {
"id": 50,
"title": "Sample Title"
},
"transaction_batch": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"processing_status_id": 2,
"batch_num": 4,
"is_open": 0,
"settlement_file_name": "settement_file.txt",
"batch_close_ts": 1531423693,
"batch_close_detail": "BATCH_MISMATCH",
"total_sale_amount": 2342.45,
"total_sale_count": 21,
"total_refund_amount": 2342.45,
"total_refund_count": 18,
"total_void_amount": 2342.45,
"total_void_count": 17
},
"transaction_splits": [
{
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"amount": 10,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"postback_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"postback_config_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"next_run_ts": 1422040992,
"created_ts": 1422040992,
"model_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"currency_type": {
"id": 50,
"title": "Sample Title"
},
"transaction_references": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
List transactions
function listTransactions(
?Page $page = null,
?Sort26 $sort = null,
?Filter12 $filter = null,
?array $expand = null
): ResponseTransactionsCollection| Parameter | Type | Tags | Description |
|---|---|---|---|
page |
?Page |
Query, Optional | Use this field to specify paginate your results, by using page size and number. You can use one of the following methods: > /endpoint?page={ "number": 1, "size": 50 } > > /endpoint?page[number]=1&page[size]=50 |
sort |
?Sort26 |
Query, Optional | You can use any field_name from this endpoint results, and you can combine more than one field for more complex sorting. You can use one of the following methods:> /endpoint?sort={ "field_name": "asc", "field_name2": "desc" } > > /endpoint?sort[field_name]=asc&sort[field_name2]=desc |
filter |
?Filter12 |
Query, Optional | You can use any field_name from this endpoint results as a filter, and you can also use more than one field to create AND conditions. For date fields (ended with _ts), you can also search for ranges using the $gte (Greater than or equal to) and/or $lte (Lower than or equal to). You can use one of the following methods:> /endpoint?filter={ "field_name": "Value" } > > /endpoint?filter[field_name]=Value > > /endpoint?filter={ "created_ts": "today" } > > /endpoint?filter[created_ts]=today > > /endpoint?filter={ "created_ts": { "$gte": "yesterday", "$lte": "today" } } > > /endpoint?filter[created_ts][$gte]=yesterday&filter[created_ts][$lte]=today |
expand |
?(string[]) (Expand47Enum) |
Query, Optional | Most endpoints in the API have a way to retrieve extra data related to the current record being retrieved. For example, if the API request is for the accountvaults endpoint, and the end user also needs to know which contact the token belongs to, this data can be returned in the accountvaults endpoint request. Constraints: Unique Items Required, Pattern: ^[\w]+$ |
ResponseTransactionsCollection
$result = $transactionsReadController->listTransactions();{
"type": "TransactionsCollection",
"list": [
{
"additional_amounts": [
{
"type": "cashback",
"amount": 10,
"account_type": "credit",
"currency": 840
}
],
"billing_address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"street": "43155 Main Street STE 2310-C",
"phone": "3339998822"
},
"checkin_date": "2021-12-01",
"checkout_date": "2021-12-01",
"clerk_number": "AE1234",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"custom_data": {},
"customer_id": "customerid",
"description": "some description",
"identity_verification": {
"dl_state": "MI",
"dl_number": "1235567",
"dob_year": "1980"
},
"iias_ind": 1,
"image_front": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"image_back": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"installment": true,
"installment_number": 1,
"installment_count": 1,
"location_api_id": "location-api-id-florida-2",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"advance_deposit": false,
"no_show": false,
"notification_email_address": "johnsmith@smiths.com",
"order_number": "433659378839",
"po_number": "555555553123",
"quick_invoice_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring": {
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"description": "Description",
"end_date": "2021-12-01",
"installment_total_count": 20,
"interval": 1,
"interval_type": "d",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"notification_days": 2,
"payment_method": "cc",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring_api_id": "recurring1234abcd",
"start_date": "2021-12-01",
"status": "active",
"transaction_amount": 3,
"terms_agree": true,
"terms_agree_ip": "192.168.0.10",
"recurring_c1": "recurring custom data 1",
"recurring_c2": "recurring custom data 2",
"recurring_c3": "recurring custom data 3",
"send_to_proc_as_recur": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"next_run_date": "2021-12-01",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"recurring_type_id": "i"
},
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
{
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"tax": 0,
"tip_amount": 0,
"transaction_amount": 0,
"secondary_amount": 0,
"transaction_api_id": "transaction-payment-abcd123",
"transaction_c1": "custom-data-1",
"transaction_c2": "custom-data-2",
"transaction_c3": "custom-data-3",
"bank_funded_only_override": false,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"terminal_id": "11e95f8ec39de8fbdb0a4f1a",
"account_holder_name": "smith",
"account_type": "checking",
"token_id": "11e95f8ec39de8fbdb0a4f1a",
"ach_identifier": "P",
"ach_sec_code": "C21",
"auth_amount": 1,
"auth_code": "BR349K",
"avs": "BAD",
"avs_enhanced": "N",
"cardholder_present": true,
"card_present": true,
"check_number": "8520748520963",
"customer_ip": "192.168.0.10",
"cvv_response": "N",
"entry_mode_id": "C",
"emv_receipt_data": {
"AID": "a0000000042203",
"APPLAB": "US Maestro",
"APPN": "US Maestro",
"CVM": "Pin Verified",
"TSI": "e800",
"TVR": "0800008000"
},
"first_six": "545454",
"last_four": "5454",
"payment_method": "cc",
"terminal_serial_number": "1234567890",
"transaction_settlement_status": null,
"charge_back_date": "2021-12-01",
"is_recurring": true,
"notification_email_sent": "true",
"par": "Q1J4Z28RKA1EBL470G9XYG90R5D3E",
"reason_code_id": 1000,
"recurring_id": "11e95f8ec39de8fbdb0a4f1a",
"settle_date": "2021-12-01",
"status_code": 101,
"transaction_batch_id": "11e95f8ec39de8fbdb0a4f1a",
"verbiage": "APPROVED",
"void_date": "2021-12-01",
"batch": "2",
"terms_agree": true,
"response_message": null,
"return_date": "2021-12-01",
"trx_source_id": 8,
"account_vault": {
"account_holder_name": "John Smith",
"account_number": "545454545454545",
"account_vault_api_id": "accountvaultabcd",
"accountvault_c1": "accountvault custom 1",
"accountvault_c2": "accountvault custom 2",
"accountvault_c3": "accountvault custom 3",
"ach_sec_code": "WEB",
"billing_address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"street": "43155 Main Street STE 2310-C",
"phone": "3339998822"
},
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"customer_id": "123456",
"identity_verification": {
"dl_state": "MI",
"dl_number": "1235567",
"ssn4": "8527",
"dob_year": "1980"
},
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"previous_account_vault_api_id": "previousaccountvault123456",
"previous_account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"previous_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_agree": true,
"terms_agree_ip": "192.168.0.10",
"title": "Test CC Account",
"id": "11e95f8ec39de8fbdb0a4f1a",
"account_type": "checking",
"active": true,
"cau_summary_status_id": 1,
"created_ts": 1422040992,
"e_serial_number": "1234567890",
"e_track_data": null,
"e_format": null,
"e_keyed_data": null,
"expiring_in_months": null,
"first_six": "700953",
"has_recurring": false,
"last_four": "3657",
"modified_ts": 1422040992,
"payment_method": "cc",
"ticket": null,
"track_data": null
},
"quick_invoice": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"cc_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"ach_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"due_date": "2021-12-01",
"item_list": [
{
"name": "Bread",
"amount": 20.15
}
],
"allow_overpayment": true,
"email": "email@domain.com",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_api_id": "contact12345",
"customer_id": "11e95f8ec39de8fbdb0a4f1a",
"expire_date": "2021-12-01",
"allow_partial_pay": true,
"attach_files_to_email": true,
"send_email": true,
"invoice_number": "invoice12345",
"item_header": "Quick invoice header sample",
"item_footer": "Thank you",
"amount_due": 245.36,
"notification_email": "email@domain.com",
"payment_status_id": 1,
"status_id": 1,
"note": "some note",
"notification_days_before_due_date": 3,
"notification_days_after_due_date": 7,
"notification_on_due_date": true,
"send_text_to_pay": true,
"files": [
null
],
"remaining_balance": 245.36,
"single_payment_min_amount": 5,
"single_payment_max_amount": 5000,
"cell_phone": "3339998822",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"is_active": true
},
"log_emails": [
{
"subject": "Payment Receipt - 12skiestech",
"body": "This email is being sent from a server.",
"source_address": "\"12skiestech A7t3qi\" <noreply@zeamster.email>",
"return_path": "\"12skiestech A7t3qi\" <noreply@zeamster.email>",
"provider_id": "0100017e67bcc530-e1dd23b4-8a39-4a5b-8d5d-68d51c4c942f-000000",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"reason_sent": "Contact Email",
"reason_model": "Transaction",
"reason_model_id": "11e95f8ec39de8fbdb0a4f1a",
"reply_to": "\"Zeamster\" <emma.p@zeamster.com>",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992
}
],
"is_voidable": true,
"is_reversible": true,
"is_refundable": true,
"is_completable": true,
"is_settled": true,
"created_user": {
"account_number": "5454545454545454",
"address": "43155 Main Street STE 2310-C",
"branding_domain_url": "{branding_domain_url}",
"cell_phone": "3339998822",
"city": "Novi",
"company_name": "Fortis Payment Systems, LLC",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"date_of_birth": "2021-12-01",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "email@domain.com",
"email_trx_receipt": true,
"home_phone": "3339998822",
"first_name": "John",
"last_name": "Smith",
"locale": "en-US",
"office_phone": "3339998822",
"office_ext_phone": "5",
"primary_location_id": "11e95f8ec39de8fbdb0a4f1a",
"requires_new_password": null,
"state": "Michigan",
"terms_condition_code": "20220308",
"tz": "America/New_York",
"ui_prefs": {
"entry_page": "dashboard",
"page_size": 2,
"report_export_type": "csv",
"process_method": "virtual_terminal",
"default_terminal": "11e95f8ec39de8fbdb0a4f1a"
},
"username": "{user_name}",
"user_api_key": "234bas8dfn8238f923w2",
"user_hash_key": null,
"user_type_code": 100,
"password": null,
"zip": "48375",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"status": true,
"login_attempts": 0,
"last_login_ts": 1422040992,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_accepted_ts": 1422040992,
"terms_agree_ip": "192.168.0.10",
"current_date_time": "2019-03-11T10:38:26-0700"
},
"location": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"account_number": "5454545454545454",
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US",
"street": "43155 Main Street STE 2310-C",
"street2": "43155 Main Street STE 2310-C"
},
"branding_domain_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_email_trx_receipt_default": true,
"default_ach": "11e608a7d515f1e093242bb2",
"default_cc": "11e608a442a5f1e092242dda",
"developer_company_id": "11e95f8ec39de8fbdb0a4f1a",
"email_reply_to": "email@domain.com",
"fax": "3339998822",
"location_api_id": "location-111111",
"location_api_key": "AE34BBCAADF4AE34BBCAADF4",
"location_c1": "custom 1",
"location_c2": "custom 2",
"location_c3": "custom data 3",
"name": "Sample Company Headquarters",
"office_phone": "2481234567",
"office_ext_phone": "1021021209",
"recurring_notification_days_default": 0,
"tz": "America/New_York",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"ticket_hash_key": "A5F443CADF4AE34BBCAADF4"
},
"contact": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"account_number": "54545433332",
"contact_api_id": "137",
"first_name": "John",
"last_name": "Smith",
"cell_phone": "3339998822",
"balance": 245.36,
"address": {
"city": "Novi",
"state": "Michigan",
"postal_code": "48375",
"country": "US",
"street": "43155 Main Street STE 2310-C"
},
"company_name": "Fortis Payment Systems, LLC",
"header_message": "This is a sample message for you",
"date_of_birth": "2021-12-01",
"email_trx_receipt": true,
"home_phone": "3339998822",
"office_phone": "3339998822",
"office_phone_ext": "5",
"header_message_type": 0,
"update_if_exists": 1,
"contact_c1": "any",
"contact_c2": "anything",
"contact_c3": "something",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "email@domain.com",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"active": true
},
"changelogs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"action": "CREATE",
"model": "TransactionRequest",
"model_id": "11ec829598f0d4008be9aba4",
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_details": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"field": "next_run_ts",
"old_value": "1643616000"
}
],
"user": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"username": "email@domain.com",
"first_name": "Bob",
"last_name": "Fairview"
}
}
],
"product_transaction": {
"processor_version": "1_0_0",
"title": "My terminal",
"payment_method": "cc",
"processor": "zgate",
"mcc": "1111",
"tax_surcharge_config": 2,
"partner": "standalone",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"surcharge": {},
"processor_data": {},
"vt_clerk_number": true,
"vt_billing_phone": true,
"vt_enable_tip": true,
"ach_allow_debit": true,
"ach_allow_credit": true,
"ach_allow_refund": true,
"vt_cvv": true,
"vt_street": true,
"vt_zip": true,
"vt_order_num": true,
"vt_enable": true,
"receipt_show_contact_name": true,
"display_avs": true,
"card_type_visa": true,
"card_type_mc": true,
"card_type_disc": true,
"card_type_amex": true,
"card_type_diners": true,
"card_type_jcb": true,
"invoice_location": true,
"allow_partial_authorization": true,
"allow_recurring_partial_authorization": true,
"auto_decline_cvv": true,
"auto_decline_street": true,
"auto_decline_zip": true,
"split_payments_allow": true,
"vt_show_custom_fields": true,
"receipt_show_custom_fields": true,
"vt_override_sales_tax_allowed": true,
"vt_enable_sales_tax": true,
"vt_require_zip": true,
"vt_require_street": true,
"auto_decline_cavv": true,
"current_batch": 34,
"dup_check_per_batch": null,
"quick_invoice_allow": false,
"level3_allow": false,
"payfac_enable": false,
"sales_office_id": "11e95f8ec39de8fbdb0a4f1a",
"hosted_payment_page_allow": false,
"surcharge_id": "11e95f8ec39de8fbdb0a4f1a",
"level3_default": null,
"cau_subscribe_type_id": 0,
"location_billing_account_id": "11eb88b873980c64a21e5fd2",
"product_billing_group_id": "nofees",
"account_number": "12345678",
"run_avs_on_accountvault_create": false,
"accountvault_expire_notification_email_enable": false,
"debit_allow_void": false,
"quick_invoice_text_to_pay": false,
"sms_enable": false,
"vt_show_currency": true,
"receipt_show_currency": false,
"allow_blind_refund": false,
"vt_show_company_name": false,
"receipt_show_company_name": false,
"bank_funded_only": false,
"id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"all_tags": [
{
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"tagTransactions": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"tag_id": "Tag ID",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"declined_recurring_notification": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_ts": 1422040992,
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"payment_recurring_notification": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_ts": 1422040992,
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"developer_company": {
"title": "My terminal",
"id": "11e95f8ec39de8fbdb0a4f1a",
"active": true,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"terminal": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"default_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_application_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_cvm_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_manufacturer_code": 1,
"title": "My terminal",
"mac_address": "3D:F2:C9:A6:B3:4F",
"local_ip_address": "192.168.0.10",
"port": 10009,
"serial_number": "1234567890",
"terminal_number": "973456789012367",
"terminal_timeouts": {
"card_entry_timeout": 47,
"device_terms_prompt_timeout": 30,
"overall_timeout": 125,
"pin_entry_timeout": 40,
"signature_input_timeout": 35,
"signature_submit_timeout": 38,
"status_display_time": 12,
"tip_cashback_timeout": 25,
"transaction_timeout": 17
},
"tip_percents": {
"percent_1": 0,
"percent_2": 2,
"percent_3": 99
},
"header_line_1": "line 1 sample",
"header_line_2": "line 2 sample",
"header_line_3": "line 3 sample",
"header_line_4": "line 4 sample",
"header_line_5": "line 5 sample",
"trailer_line_1": "trailer 1 sample",
"trailer_line_2": "trailer 2 sample",
"trailer_line_3": "trailer 3 sample",
"trailer_line_4": "trailer 4 sample",
"trailer_line_5": "trailer 5 sample",
"default_checkin": "2021-12-01",
"default_checkout": "2021-12-01",
"default_room_rate": 56,
"default_room_number": "303",
"debit": false,
"emv": false,
"cashback_enable": false,
"print_enable": false,
"sig_capture_enable": false,
"is_provisioned": false,
"tip_enable": false,
"validated_decryption": false,
"communication_type": "http",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"last_registration_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"hosted_payment_page": {
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"location_api_id": null,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"title": "Sample title",
"redirect_url_delay": 15,
"min_payment_amount": 0,
"max_payment_amount": 99999999.99,
"redirect_url_on_approve": null,
"redirect_url_on_decline": null,
"field_configuration": {
"css_mini": true,
"stack": "vertical",
"header": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
},
"body": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
},
"footer": {
"settings": {
"enabled": true,
"columns": 1,
"rows": 1
},
"fields": [
{
"id": "transaction_amount",
"label": "Header",
"field_type": "heading",
"position": [
"1"
],
"required": true,
"readonly": true,
"visible": true
}
]
}
},
"encryption_key": null,
"stylesheet_url": null,
"parent_send_message": true,
"hide_optional_fields": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"transaction_level3": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"level3_data": {
"destination_country_code": "840",
"duty_amount": 0,
"freight_amount": 0,
"national_tax": 2,
"sales_tax": 200,
"shipfrom_zip_code": "AZ1234",
"shipto_zip_code": "FL1234",
"tax_amount": 10,
"tax_exempt": 0,
"customer_vat_registration": "12345678",
"merchant_vat_registration": "123456",
"order_date": "171006",
"summary_commodity_code": "C1K2",
"tax_rate": 0,
"unique_vat_ref_number": "vat1234",
"line_items": [
{
"description": "cool drink",
"commodity_code": "cc123456",
"discount_amount": 0,
"other_tax_amount": 0,
"product_code": "fanta123456",
"quantity": 12,
"tax_amount": 4,
"tax_rate": 0,
"unit_code": "gll",
"unit_cost": 3,
"alternate_tax_id": "1234",
"debit_credit": "C",
"discount_rate": 11,
"tax_type_applied": "22",
"tax_type_id": "11"
}
]
}
},
"developer_company_id": "Sample Developer Company ID",
"transaction_histories": [
{
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": 101,
"event_date_ts": 1422040992,
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
}
],
"surcharge_transaction": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"model_name": "Model Name",
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"surcharge_fee": 0,
"surcharge_rate": 0,
"surcharge_amount": null,
"surcharge_transaction_min": null,
"surcharge_transaction_max": null,
"created": 1422040992,
"modified": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"surcharge": {
"surcharge_fee": 10,
"surcharge_rate": 1,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"apply_to_user_type_id": "11e95f8ec39de8fbdb0a4f1a",
"title": null,
"surcharge_label": null,
"surcharge_transaction_product_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"signature": {
"signature": "iVBORw0KGgoAAAANSUhEUgAAANwAAAAsCAYAAAAOyNaYAAACvklEQVR4nO3bLZOqUBjA8ScaNxqNRiKRaCQaiXwEG7cRiUajH8FINBqJRCKR+NxyD4OIXtaXw2H3/5s5MwZ39rgz/zkvuKKqgar+YTAYnx/y7wUACwgOsIjgAIsIznFlWerlcpl6GngTgnNYVVW6WCxURDTLsqmngzcgOMdtNhsVERURDYJA8zyfekp4AcE5oCgKzfN8cOvYNM1VdCKiURRNMEu8A8FNrCzLm5j68Q1Fx2o3TwTngCzLNAiCq6D6UTVNo0mS6NfXF+HNGME5or+KeZ7XxrVcLjWOY83zXOu6vnqfeQ/bzHkgOIf0VzHP83Sz2eh6vW4D831fy7JsowvDsH1NdO4jOAfVdX0VXhRFWhSFRlHUrmr7/b4NLU3T9jVbTLcRnMO620ezep1Op3bF832/3XIORQr3EJzjumc7E9HQBUoYhjdnPKJzD8E5xjyT647T6aSr1UpFRPf7ffveuq41TdOHZzyicwvBTeBeVGEY3jwaGBrmWV3/Z82K1z/jca5zB8F9wFBQY6JaLBYax7EmSXJ3DD2v624rzUpoVrsgCDjXOWRWwVVVNfUUrvTDGrNK3YsqTdNRn69pGs2y7NshssV0w2yCK4pCRUSPx+Okc/hfWI9WqbFRPaMbYjc+s7ptt1uic8BsgsvzXEVED4fDR3/P2PPVUFifDOo7THxmPiY03/fZXk7s1wR371z1zPnKlbDGuvc9TKKz78cE9yio3W436vbv1fOV6/oPx010/Ee5PbMLbrfbPRWU53kPb/9+SlRj9L8ALcJ/lNsym+DO5/PTQaVpqnVdT/0RnGLOed0LlikvpH6L2QSnqoPX4QT1mu4FC3/Dz5tVcMDcERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGDRX+EC0ah++pNrAAAAAElFTkSuQmCC",
"resource": "Transaction",
"resource_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"reason_code": {
"id": 50,
"title": "Sample Title"
},
"type": {
"id": 50,
"title": "Sample Title"
},
"status": {
"id": 50,
"title": "Sample Title"
},
"transaction_batch": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"processing_status_id": 2,
"batch_num": 4,
"is_open": 0,
"settlement_file_name": "settement_file.txt",
"batch_close_ts": 1531423693,
"batch_close_detail": "BATCH_MISMATCH",
"total_sale_amount": 2342.45,
"total_sale_count": 21,
"total_refund_amount": 2342.45,
"total_refund_count": 18,
"total_void_amount": 2342.45,
"total_void_count": 17
},
"transaction_splits": [
{
"transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"amount": 10,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"postback_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"postback_config_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"next_run_ts": 1422040992,
"created_ts": 1422040992,
"model_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"currency_type": {
"id": 50,
"title": "Sample Title"
},
"transaction_references": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
]
}
],
"links": {
"type": "Links",
"first": "/v1/endpoint?page[size]=10&page[number]=1",
"previous": "/v1/endpoint?page[size]=10&page[number]=5",
"last": "/v1/endpoint?page[size]=10&page[number]=42"
},
"pagination": {
"type": "Pagination",
"total_count": 423,
"page_count": 42,
"page_number": 6,
"page_size": 10
},
"sort": {
"type": "Sorting",
"fields": [
{
"field": "last_name",
"order": "asc"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |