The tokens endpoint is used as a tokenization endpoint to store token records. If there is a need to store accountvaults (tokens) for account numbers and card numbers for later use, then this is the endpoint to perform that task.
The account_vault_id field can be used in place of the account_number and exp_date fields on most endpoints in the system. So storing an accountvault on this endpoint will allow for the reuse of the account at a later time.
$tokensController = $client->getTokensController();TokensController
- Create a New ACH Token
- Create a New Credit Card Token
- Create a New Previous Transaction Token
- Create a New Terminal Token
- Create a New Ticket Token
- Delete a Single Token Record
- View Single Token Record
- List All Tokens Related
- Update ACH Token
- Update CC Token
Create a new ACH Token
function createANewACHToken(V1TokensAchRequest $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
body |
V1TokensAchRequest |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$body_accountHolderName = 'John Smith';
$body_accountNumber = '545454545454545';
$body_locationId = '11e95f8ec39de8fbdb0a4f1a';
$body_accountType = Models\AccountType6Enum::SAVINGS;
$body_routingNumber = '100020200';
$body = new Models\V1TokensAchRequest(
$body_accountHolderName,
$body_accountNumber,
$body_locationId,
$body_accountType,
$body_routingNumber
);
$result = $tokensController->createANewACHToken($body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Create a new Credit Card Token
function createANewCreditCardToken(V1TokensCcRequest $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
body |
V1TokensCcRequest |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$body_accountNumber = '5454545454545454';
$body_locationId = '11e95f8ec39de8fbdb0a4f1a';
$body_expDate = '0929';
$body = new Models\V1TokensCcRequest(
$body_accountNumber,
$body_locationId,
$body_expDate
);
$result = $tokensController->createANewCreditCardToken($body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Create a new Previous Transaction Token
function createANewPreviousTransactionToken(
V1TokensPreviousTransactionRequest $body,
?array $expand = null
): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
body |
V1TokensPreviousTransactionRequest |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$body_locationId = '11e95f8ec39de8fbdb0a4f1a';
$body_previousTransactionId = '11e95f8ec39de8fbdb0a4f1a';
$body = new Models\V1TokensPreviousTransactionRequest(
$body_locationId,
$body_previousTransactionId
);
$result = $tokensController->createANewPreviousTransactionToken($body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Create a new Terminal Token
function createANewTerminalToken(V1TokensTerminalRequest $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
body |
V1TokensTerminalRequest |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$body_contactId = '11e95f8ec39de8fbdb0a4f1a';
$body_locationId = '11e95f8ec39de8fbdb0a4f1a';
$body_terminalId = '11e95f8ec39de8fbdb0a4f1a';
$body = new Models\V1TokensTerminalRequest(
$body_contactId,
$body_locationId,
$body_terminalId
);
$result = $tokensController->createANewTerminalToken($body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Create a new Ticket Token
function createANewTicketToken(V1TokensTicketRequest $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
body |
V1TokensTicketRequest |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$body_locationId = '11e95f8ec39de8fbdb0a4f1a';
$body_ticket = '12345678';
$body = new Models\V1TokensTicketRequest(
$body_locationId,
$body_ticket
);
$result = $tokensController->createANewTicketToken($body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Delete a single token record
function deleteASingleTokenRecord(string $tokenId): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
tokenId |
string |
Template, Required | A unique, system-generated identifier for the Token. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
$tokenId = '11e95f8ec39de8fbdb0a4f1a';
$result = $tokensController->deleteASingleTokenRecord($tokenId);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
View single token record
function viewSingleTokenRecord(string $tokenId, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
tokenId |
string |
Template, Required | A unique, system-generated identifier for the Token. 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[]) (Expand38Enum) |
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]+$ |
$tokenId = '11e95f8ec39de8fbdb0a4f1a';
$result = $tokensController->viewSingleTokenRecord($tokenId);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
List all tokens related
function listAllTokensRelated(
?Page $page = null,
?Sort25 $sort = null,
?Filter11 $filter = null,
?array $expand = null
): ResponseTokensCollection| 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 |
?Sort25 |
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 |
?Filter11 |
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[]) (Expand38Enum) |
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]+$ |
$result = $tokensController->listAllTokensRelated();{
"type": "TokensCollection",
"list": [
{
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
],
"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 |
Update ACH Token
function updateACHToken(string $tokenId, V1TokensAchRequest1 $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
tokenId |
string |
Template, Required | A unique, system-generated identifier for the Token. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
body |
V1TokensAchRequest1 |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$tokenId = '11e95f8ec39de8fbdb0a4f1a';
$body = new Models\V1TokensAchRequest1();
$result = $tokensController->updateACHToken($tokenId, $body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |
Update CC Token
function updateCCToken(string $tokenId, V1TokensCcRequest1 $body, ?array $expand = null): ResponseToken| Parameter | Type | Tags | Description |
|---|---|---|---|
tokenId |
string |
Template, Required | A unique, system-generated identifier for the Token. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
body |
V1TokensCcRequest1 |
Body, Required | - |
expand |
?(string[]) (Expand38Enum) |
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]+$ |
$tokenId = '11e95f8ec39de8fbdb0a4f1a';
$body = new Models\V1TokensCcRequest1();
$result = $tokensController->updateCCToken($tokenId, $body);{
"type": "Token",
"data": {
"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,
"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
},
"transactions": [
{
"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": false,
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tags": [
"Walk-in Customer"
],
"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
}
],
"activeRecurrings": [
{
"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"
}
],
"is_deletable": true,
"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
},
"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"
},
"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"
}
}
],
"account_vault_cau_logs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a"
}
],
"account_vault_cau_product_transactions": [
{
"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"
}
]
}
}| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 401 | Unauthorized | Response401tokenException |
| 412 | Precondition Failed | Response412Exception |