POST api/fortisreceiver/merchantpayload
Request Information
URI Parameters
None.
Body Parameters
MerchantOnboardingPayloadName | Description | Type | Additional information |
---|---|---|---|
type | string |
None. |
|
stage | string |
None. |
|
data | Data |
None. |
Request Formats
application/json, text/json
Sample:
{ "type": "sample string 1", "stage": "sample string 2", "data": { "company": { "dba_name": "sample string 1", "legal_name": "sample string 2", "email": "sample string 3", "website": "sample string 4", "address": { "address_1": "sample string 1", "address_2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "postal_code": "sample string 5", "country": "sample string 6", "phone_number": "sample string 7" } }, "parent_id": "sample string 1", "location_id": "sample string 2", "client_app_id": "sample string 3", "tz": "sample string 4", "users": [ { "user_id": "sample string 1", "user_api_key": "sample string 2", "email": "sample string 3" }, { "user_id": "sample string 1", "user_api_key": "sample string 2", "email": "sample string 3" } ], "product_transactions": [ { "current_batch": 1, "vt_require_street": true, "vt_require_zip": true, "vt_enable_sales_tax": true, "vt_override_sales_tax_allowed": true, "tax_surcharge_config": 6, "allow_partial_authorization": 7, "allow_recurring_partial_authorization": 8, "processor_data": { "company_name": "sample string 1", "data_wire_id": {}, "terminal_number": {}, "bank_id": "sample string 4", "store_id": {}, "agent_id": {}, "chain_id": {}, "zip_code": "sample string 8", "city": {}, "state": {}, "service_phone": "sample string 11", "authentication_code": {}, "sub_processor": "sample string 13", "merchant_tax_id": "sample string 14", "auth_key": {}, "payfac_id": {}, "payfac_name": {}, "merchant_address": {}, "iias_ind": {}, "time_zone": {}, "payfac_email": {}, "group_id": "sample string 22", "secure_ecomm_url": {}, "qsr_limit": {}, "max_decline_percent_per_batch": 25, "max_decline_count_per_batch": 26, "batch_autoclose_count": 27, "batch_autoclose_amount": 28, "processor_key": "sample string 29", "processor_secret": "sample string 30", "ach_sec_codes": [ "sample string 1", "sample string 2" ] }, "ach_allow_credit": true, "ach_allow_debit": true, "ach_allow_refund": true, "card_type_visa": true, "card_type_diners": true, "card_type_disc": true, "card_type_mc": true, "card_type_jcb": true, "card_type_amex": true, "id": "sample string 18", "title": "sample string 19", "merchant_id": "sample string 20", "terminal_id": "sample string 21", "payment_method": "sample string 22", "industry_type": "sample string 23", "processor": "sample string 24", "product_transaction_api_id": {}, "receipt_header": {}, "receipt_footer": {}, "receipt_add_account_above_signature": {}, "receipt_add_recurring_above_signature": {}, "receipt_vt_above_signature": {}, "partner": {}, "mcc": "sample string 32", "product_ach_pv_store_id": {}, "vt_cvv": true, "vt_street": true, "vt_zip": true, "vt_order_num": true, "vt_enable": true, "receipt_show_contact_name": true, "display_avs": true, "default_transaction_type": "sample string 41", "location_id": "sample string 42", "surcharge_id": {}, "created_user_id": "sample string 44", "modified_user_id": "sample string 45", "receipt_logo": {}, "authentication_code": {}, "created_ts": 48, "modified_ts": 49, "dup_check_per_batch": {}, "vt_clerk_number": true, "vt_billing_phone": true, "auto_decline_cvv": 53, "auto_decline_street": 54, "auto_decline_zip": 55, "auto_decline_cavv": 56, "agent_code": {}, "active": 58, "sub_processor": "sample string 59", "vt_enable_tip": 60, "quick_invoice_allow": 61, "sales_office_id": {}, "hosted_payment_page_max_allowed": 63, "hosted_payment_page_allow": 64, "cau_subscribe_type_id": 65, "cau_account_number": {}, "level3_allow": 67, "level3_default": {}, "payfac_enable": 69, "location_billing_account_id": "sample string 70", "account_number": "sample string 71", "product_billing_group_id": "sample string 72", "split_payments_allow": 73, "tz": "sample string 74", "run_avs_on_accountvault_create": 75, "currency_code": 76, "accountvault_expire_notification_email_enable": 77, "processor_version": "sample string 78", "debit_allow_void": 79, "vt_show_custom_fields": true, "show_apple_pay": true, "show_google_pay": true, "receipt_show_custom_fields": true, "sms_enable": 84, "current_stan": 85, "vt_show_currency": 86, "receipt_show_currency": 87, "allow_blind_refund": 88, "vt_show_company_name": 89, "receipt_show_company_name": 90, "paylink_allow": 91, "bank_funded_only": 92, "is_secondary_amount_allowed": true, "support_risk_hold": true, "transaction_amount_notification_threshold": "sample string 95", "show_secondary_amount": 96, "allow_secondary_amount": 97, "batch_risk_config": { "blind_refund_total_count": 1, "blind_refund_max_amount": 2 }, "require_cvv_on_keyed_cnp": 98, "require_cvv_on_tokenized_cnp": 99, "host_capture": true, "fortis_id": "sample string 101" }, { "current_batch": 1, "vt_require_street": true, "vt_require_zip": true, "vt_enable_sales_tax": true, "vt_override_sales_tax_allowed": true, "tax_surcharge_config": 6, "allow_partial_authorization": 7, "allow_recurring_partial_authorization": 8, "processor_data": { "company_name": "sample string 1", "data_wire_id": {}, "terminal_number": {}, "bank_id": "sample string 4", "store_id": {}, "agent_id": {}, "chain_id": {}, "zip_code": "sample string 8", "city": {}, "state": {}, "service_phone": "sample string 11", "authentication_code": {}, "sub_processor": "sample string 13", "merchant_tax_id": "sample string 14", "auth_key": {}, "payfac_id": {}, "payfac_name": {}, "merchant_address": {}, "iias_ind": {}, "time_zone": {}, "payfac_email": {}, "group_id": "sample string 22", "secure_ecomm_url": {}, "qsr_limit": {}, "max_decline_percent_per_batch": 25, "max_decline_count_per_batch": 26, "batch_autoclose_count": 27, "batch_autoclose_amount": 28, "processor_key": "sample string 29", "processor_secret": "sample string 30", "ach_sec_codes": [ "sample string 1", "sample string 2" ] }, "ach_allow_credit": true, "ach_allow_debit": true, "ach_allow_refund": true, "card_type_visa": true, "card_type_diners": true, "card_type_disc": true, "card_type_mc": true, "card_type_jcb": true, "card_type_amex": true, "id": "sample string 18", "title": "sample string 19", "merchant_id": "sample string 20", "terminal_id": "sample string 21", "payment_method": "sample string 22", "industry_type": "sample string 23", "processor": "sample string 24", "product_transaction_api_id": {}, "receipt_header": {}, "receipt_footer": {}, "receipt_add_account_above_signature": {}, "receipt_add_recurring_above_signature": {}, "receipt_vt_above_signature": {}, "partner": {}, "mcc": "sample string 32", "product_ach_pv_store_id": {}, "vt_cvv": true, "vt_street": true, "vt_zip": true, "vt_order_num": true, "vt_enable": true, "receipt_show_contact_name": true, "display_avs": true, "default_transaction_type": "sample string 41", "location_id": "sample string 42", "surcharge_id": {}, "created_user_id": "sample string 44", "modified_user_id": "sample string 45", "receipt_logo": {}, "authentication_code": {}, "created_ts": 48, "modified_ts": 49, "dup_check_per_batch": {}, "vt_clerk_number": true, "vt_billing_phone": true, "auto_decline_cvv": 53, "auto_decline_street": 54, "auto_decline_zip": 55, "auto_decline_cavv": 56, "agent_code": {}, "active": 58, "sub_processor": "sample string 59", "vt_enable_tip": 60, "quick_invoice_allow": 61, "sales_office_id": {}, "hosted_payment_page_max_allowed": 63, "hosted_payment_page_allow": 64, "cau_subscribe_type_id": 65, "cau_account_number": {}, "level3_allow": 67, "level3_default": {}, "payfac_enable": 69, "location_billing_account_id": "sample string 70", "account_number": "sample string 71", "product_billing_group_id": "sample string 72", "split_payments_allow": 73, "tz": "sample string 74", "run_avs_on_accountvault_create": 75, "currency_code": 76, "accountvault_expire_notification_email_enable": 77, "processor_version": "sample string 78", "debit_allow_void": 79, "vt_show_custom_fields": true, "show_apple_pay": true, "show_google_pay": true, "receipt_show_custom_fields": true, "sms_enable": 84, "current_stan": 85, "vt_show_currency": 86, "receipt_show_currency": 87, "allow_blind_refund": 88, "vt_show_company_name": 89, "receipt_show_company_name": 90, "paylink_allow": 91, "bank_funded_only": 92, "is_secondary_amount_allowed": true, "support_risk_hold": true, "transaction_amount_notification_threshold": "sample string 95", "show_secondary_amount": 96, "allow_secondary_amount": 97, "batch_risk_config": { "blind_refund_total_count": 1, "blind_refund_max_amount": 2 }, "require_cvv_on_keyed_cnp": 98, "require_cvv_on_tokenized_cnp": 99, "host_capture": true, "fortis_id": "sample string 101" } ] } }
application/xml, text/xml
Sample:
<MerchantOnboardingPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iCareWebApi.Controllers"> <data> <client_app_id>sample string 3</client_app_id> <company> <address> <address_1>sample string 1</address_1> <address_2>sample string 2</address_2> <city>sample string 3</city> <country>sample string 6</country> <phone_number>sample string 7</phone_number> <postal_code>sample string 5</postal_code> <state>sample string 4</state> </address> <dba_name>sample string 1</dba_name> <email>sample string 3</email> <legal_name>sample string 2</legal_name> <website>sample string 4</website> </company> <location_id>sample string 2</location_id> <parent_id>sample string 1</parent_id> <product_transactions> <ProductTransaction> <account_number>sample string 71</account_number> <accountvault_expire_notification_email_enable>77</accountvault_expire_notification_email_enable> <ach_allow_credit>true</ach_allow_credit> <ach_allow_debit>true</ach_allow_debit> <ach_allow_refund>true</ach_allow_refund> <active>58</active> <agent_code /> <allow_blind_refund>88</allow_blind_refund> <allow_partial_authorization>7</allow_partial_authorization> <allow_recurring_partial_authorization>8</allow_recurring_partial_authorization> <allow_secondary_amount>97</allow_secondary_amount> <authentication_code /> <auto_decline_cavv>56</auto_decline_cavv> <auto_decline_cvv>53</auto_decline_cvv> <auto_decline_street>54</auto_decline_street> <auto_decline_zip>55</auto_decline_zip> <bank_funded_only>92</bank_funded_only> <batch_risk_config> <blind_refund_max_amount>2</blind_refund_max_amount> <blind_refund_total_count>1</blind_refund_total_count> </batch_risk_config> <card_type_amex>true</card_type_amex> <card_type_diners>true</card_type_diners> <card_type_disc>true</card_type_disc> <card_type_jcb>true</card_type_jcb> <card_type_mc>true</card_type_mc> <card_type_visa>true</card_type_visa> <cau_account_number /> <cau_subscribe_type_id>65</cau_subscribe_type_id> <created_ts>48</created_ts> <created_user_id>sample string 44</created_user_id> <currency_code>76</currency_code> <current_batch>1</current_batch> <current_stan>85</current_stan> <debit_allow_void>79</debit_allow_void> <default_transaction_type>sample string 41</default_transaction_type> <display_avs>true</display_avs> <dup_check_per_batch /> <fortis_id>sample string 101</fortis_id> <host_capture>true</host_capture> <hosted_payment_page_allow>64</hosted_payment_page_allow> <hosted_payment_page_max_allowed>63</hosted_payment_page_max_allowed> <id>sample string 18</id> <industry_type>sample string 23</industry_type> <is_secondary_amount_allowed>true</is_secondary_amount_allowed> <level3_allow>67</level3_allow> <level3_default /> <location_billing_account_id>sample string 70</location_billing_account_id> <location_id>sample string 42</location_id> <mcc>sample string 32</mcc> <merchant_id>sample string 20</merchant_id> <modified_ts>49</modified_ts> <modified_user_id>sample string 45</modified_user_id> <partner /> <payfac_enable>69</payfac_enable> <paylink_allow>91</paylink_allow> <payment_method>sample string 22</payment_method> <processor>sample string 24</processor> <processor_data> <ach_sec_codes xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </ach_sec_codes> <agent_id /> <auth_key /> <authentication_code /> <bank_id>sample string 4</bank_id> <batch_autoclose_amount>28</batch_autoclose_amount> <batch_autoclose_count>27</batch_autoclose_count> <chain_id /> <city /> <company_name>sample string 1</company_name> <data_wire_id /> <group_id>sample string 22</group_id> <iias_ind /> <max_decline_count_per_batch>26</max_decline_count_per_batch> <max_decline_percent_per_batch>25</max_decline_percent_per_batch> <merchant_address /> <merchant_tax_id>sample string 14</merchant_tax_id> <payfac_email /> <payfac_id /> <payfac_name /> <processor_key>sample string 29</processor_key> <processor_secret>sample string 30</processor_secret> <qsr_limit /> <secure_ecomm_url /> <service_phone>sample string 11</service_phone> <state /> <store_id /> <sub_processor>sample string 13</sub_processor> <terminal_number /> <time_zone /> <zip_code>sample string 8</zip_code> </processor_data> <processor_version>sample string 78</processor_version> <product_ach_pv_store_id /> <product_billing_group_id>sample string 72</product_billing_group_id> <product_transaction_api_id /> <quick_invoice_allow>61</quick_invoice_allow> <receipt_add_account_above_signature /> <receipt_add_recurring_above_signature /> <receipt_footer /> <receipt_header /> <receipt_logo /> <receipt_show_company_name>90</receipt_show_company_name> <receipt_show_contact_name>true</receipt_show_contact_name> <receipt_show_currency>87</receipt_show_currency> <receipt_show_custom_fields>true</receipt_show_custom_fields> <receipt_vt_above_signature /> <require_cvv_on_keyed_cnp>98</require_cvv_on_keyed_cnp> <require_cvv_on_tokenized_cnp>99</require_cvv_on_tokenized_cnp> <run_avs_on_accountvault_create>75</run_avs_on_accountvault_create> <sales_office_id /> <show_apple_pay>true</show_apple_pay> <show_google_pay>true</show_google_pay> <show_secondary_amount>96</show_secondary_amount> <sms_enable>84</sms_enable> <split_payments_allow>73</split_payments_allow> <sub_processor>sample string 59</sub_processor> <support_risk_hold>true</support_risk_hold> <surcharge_id /> <tax_surcharge_config>6</tax_surcharge_config> <terminal_id>sample string 21</terminal_id> <title>sample string 19</title> <transaction_amount_notification_threshold>sample string 95</transaction_amount_notification_threshold> <tz>sample string 74</tz> <vt_billing_phone>true</vt_billing_phone> <vt_clerk_number>true</vt_clerk_number> <vt_cvv>true</vt_cvv> <vt_enable>true</vt_enable> <vt_enable_sales_tax>true</vt_enable_sales_tax> <vt_enable_tip>60</vt_enable_tip> <vt_order_num>true</vt_order_num> <vt_override_sales_tax_allowed>true</vt_override_sales_tax_allowed> <vt_require_street>true</vt_require_street> <vt_require_zip>true</vt_require_zip> <vt_show_company_name>89</vt_show_company_name> <vt_show_currency>86</vt_show_currency> <vt_show_custom_fields>true</vt_show_custom_fields> <vt_street>true</vt_street> <vt_zip>true</vt_zip> </ProductTransaction> <ProductTransaction> <account_number>sample string 71</account_number> <accountvault_expire_notification_email_enable>77</accountvault_expire_notification_email_enable> <ach_allow_credit>true</ach_allow_credit> <ach_allow_debit>true</ach_allow_debit> <ach_allow_refund>true</ach_allow_refund> <active>58</active> <agent_code /> <allow_blind_refund>88</allow_blind_refund> <allow_partial_authorization>7</allow_partial_authorization> <allow_recurring_partial_authorization>8</allow_recurring_partial_authorization> <allow_secondary_amount>97</allow_secondary_amount> <authentication_code /> <auto_decline_cavv>56</auto_decline_cavv> <auto_decline_cvv>53</auto_decline_cvv> <auto_decline_street>54</auto_decline_street> <auto_decline_zip>55</auto_decline_zip> <bank_funded_only>92</bank_funded_only> <batch_risk_config> <blind_refund_max_amount>2</blind_refund_max_amount> <blind_refund_total_count>1</blind_refund_total_count> </batch_risk_config> <card_type_amex>true</card_type_amex> <card_type_diners>true</card_type_diners> <card_type_disc>true</card_type_disc> <card_type_jcb>true</card_type_jcb> <card_type_mc>true</card_type_mc> <card_type_visa>true</card_type_visa> <cau_account_number /> <cau_subscribe_type_id>65</cau_subscribe_type_id> <created_ts>48</created_ts> <created_user_id>sample string 44</created_user_id> <currency_code>76</currency_code> <current_batch>1</current_batch> <current_stan>85</current_stan> <debit_allow_void>79</debit_allow_void> <default_transaction_type>sample string 41</default_transaction_type> <display_avs>true</display_avs> <dup_check_per_batch /> <fortis_id>sample string 101</fortis_id> <host_capture>true</host_capture> <hosted_payment_page_allow>64</hosted_payment_page_allow> <hosted_payment_page_max_allowed>63</hosted_payment_page_max_allowed> <id>sample string 18</id> <industry_type>sample string 23</industry_type> <is_secondary_amount_allowed>true</is_secondary_amount_allowed> <level3_allow>67</level3_allow> <level3_default /> <location_billing_account_id>sample string 70</location_billing_account_id> <location_id>sample string 42</location_id> <mcc>sample string 32</mcc> <merchant_id>sample string 20</merchant_id> <modified_ts>49</modified_ts> <modified_user_id>sample string 45</modified_user_id> <partner /> <payfac_enable>69</payfac_enable> <paylink_allow>91</paylink_allow> <payment_method>sample string 22</payment_method> <processor>sample string 24</processor> <processor_data> <ach_sec_codes xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </ach_sec_codes> <agent_id /> <auth_key /> <authentication_code /> <bank_id>sample string 4</bank_id> <batch_autoclose_amount>28</batch_autoclose_amount> <batch_autoclose_count>27</batch_autoclose_count> <chain_id /> <city /> <company_name>sample string 1</company_name> <data_wire_id /> <group_id>sample string 22</group_id> <iias_ind /> <max_decline_count_per_batch>26</max_decline_count_per_batch> <max_decline_percent_per_batch>25</max_decline_percent_per_batch> <merchant_address /> <merchant_tax_id>sample string 14</merchant_tax_id> <payfac_email /> <payfac_id /> <payfac_name /> <processor_key>sample string 29</processor_key> <processor_secret>sample string 30</processor_secret> <qsr_limit /> <secure_ecomm_url /> <service_phone>sample string 11</service_phone> <state /> <store_id /> <sub_processor>sample string 13</sub_processor> <terminal_number /> <time_zone /> <zip_code>sample string 8</zip_code> </processor_data> <processor_version>sample string 78</processor_version> <product_ach_pv_store_id /> <product_billing_group_id>sample string 72</product_billing_group_id> <product_transaction_api_id /> <quick_invoice_allow>61</quick_invoice_allow> <receipt_add_account_above_signature /> <receipt_add_recurring_above_signature /> <receipt_footer /> <receipt_header /> <receipt_logo /> <receipt_show_company_name>90</receipt_show_company_name> <receipt_show_contact_name>true</receipt_show_contact_name> <receipt_show_currency>87</receipt_show_currency> <receipt_show_custom_fields>true</receipt_show_custom_fields> <receipt_vt_above_signature /> <require_cvv_on_keyed_cnp>98</require_cvv_on_keyed_cnp> <require_cvv_on_tokenized_cnp>99</require_cvv_on_tokenized_cnp> <run_avs_on_accountvault_create>75</run_avs_on_accountvault_create> <sales_office_id /> <show_apple_pay>true</show_apple_pay> <show_google_pay>true</show_google_pay> <show_secondary_amount>96</show_secondary_amount> <sms_enable>84</sms_enable> <split_payments_allow>73</split_payments_allow> <sub_processor>sample string 59</sub_processor> <support_risk_hold>true</support_risk_hold> <surcharge_id /> <tax_surcharge_config>6</tax_surcharge_config> <terminal_id>sample string 21</terminal_id> <title>sample string 19</title> <transaction_amount_notification_threshold>sample string 95</transaction_amount_notification_threshold> <tz>sample string 74</tz> <vt_billing_phone>true</vt_billing_phone> <vt_clerk_number>true</vt_clerk_number> <vt_cvv>true</vt_cvv> <vt_enable>true</vt_enable> <vt_enable_sales_tax>true</vt_enable_sales_tax> <vt_enable_tip>60</vt_enable_tip> <vt_order_num>true</vt_order_num> <vt_override_sales_tax_allowed>true</vt_override_sales_tax_allowed> <vt_require_street>true</vt_require_street> <vt_require_zip>true</vt_require_zip> <vt_show_company_name>89</vt_show_company_name> <vt_show_currency>86</vt_show_currency> <vt_show_custom_fields>true</vt_show_custom_fields> <vt_street>true</vt_street> <vt_zip>true</vt_zip> </ProductTransaction> </product_transactions> <tz>sample string 4</tz> <users> <User> <email>sample string 3</email> <user_api_key>sample string 2</user_api_key> <user_id>sample string 1</user_id> </User> <User> <email>sample string 3</email> <user_api_key>sample string 2</user_api_key> <user_id>sample string 1</user_id> </User> </users> </data> <stage>sample string 2</stage> <type>sample string 1</type> </MerchantOnboardingPayload>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.