{"method":"POST","path":"https://api.revcent.com/v2/user_gateways","summary":"Create A User Gateway","description":"Create a user gateway in RevCent. A site gateway is required, along with the correct required fields when creating a user gateway. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/CreateUserGateway.md for an in-depth overview of this operation.","operationId":"CreateUserGateway","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The user gateway name. Must be unique from other user gateway names.","type":"string"},"site_gateway_id":{"type":"string","description":"A 20 character site gateway ID which is associated with the user gateway. If you do not have a site gateway ID, or a site gateway ID is invalid, automatically get a list of available site gateway using the GetSiteGateways operation and find the appropriate site gateway and its ID. Confirm with the user the specific site gateway they want.","minLength":20,"maxLength":20},"fields":{"description":"The fields required for the user gateway based on the id of the site gateway fields. Get the site gateway fields by using the GetSiteGateway operation when the site_gateway_id is confirmed.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The id for the individual field according to the site gateway fields required.","type":"string"},"value":{"description":"The value for the individual field according to the site gateway fields required.","type":"string"}},"required":["id","value"]}},"custom_descriptor":{"type":"object","additionalProperties":false,"description":"The custom descriptor for the user gateway. Will be provided to supported gateways as well as provided as shortcodes in email templates.","properties":{"enabled":{"description":"Whether the custom descriptor is enabled.","type":"boolean"},"name":{"description":"The custom descriptor name.","type":"string"},"email":{"description":"The custom descriptor email.","type":"string"},"url":{"description":"The custom descriptor url.","type":"string"},"phone":{"description":"The custom descriptor phone.","type":"string"},"address":{"description":"The custom descriptor address.","type":"string"},"city":{"description":"The custom descriptor city.","type":"string"},"state":{"description":"The custom descriptor state.","type":"string"},"postal_code":{"description":"The custom descriptor postal code.","type":"string"}}},"description":{"description":"The user gateway description.","type":"string"},"discount_rate":{"description":"The discount rate specific to the MID.","type":"number","format":"float"},"enabled":{"description":"Whether the user gateway is currently enabled.","type":"boolean"},"global_cascade_rules":{"type":"object","additionalProperties":false,"description":"Global cascade rules, which determine whether or not the gateway should be used for a specific transaction when choosing a gateway. <a href=\"https://kb.revcent.com/en/payments/credit-card/gateway#global-cascade-rules-1\" target=\"_blank\">Read More</a>.","properties":{"enabled":{"description":"Whether global cascade rules are enabled.","type":"boolean"},"revenue_rules":{"type":"object","additionalProperties":false,"description":"Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. <a href=\"https://kb.revcent.com/en/payments/credit-card/gateway#global-cascade-rules-1\" target=\"_blank\">Read More</a>","properties":{"enabled":{"description":"Whether revenue rules are enabled.","type":"boolean"},"options":{"description":"An array of individual revenue rules.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the individual revenue rule is enabled.","type":"boolean"},"bound":{"description":"The rule bounds to declare if a rule passes or fails.","type":"string","enum":["min","max"]},"rule_value":{"description":"The rule value is compared with the calculation value and bound.","type":"number","format":"float"},"source":{"description":"The source, in combination with the source value and calculation, is what is used to form the calculation value.","type":"string","enum":["gateway","global","step"]},"source_value":{"description":"The source value is specific to the source selected.","type":"string","enum":["captured","declined","chargeback","total","amount"]},"calculation":{"description":"The calculation to perform based on the source value.","type":"string","enum":["count","percent","sum"]},"time_value":{"description":"The total amount of time the rule applies in a past time range. Used in conjunction with the time unit.","type":"integer"},"time_unit":{"description":"The time unit. Used in conjunction with the time value.","type":"string","enum":["hour","day","week","month"]}}}}}},"time_rules":{"type":"object","additionalProperties":false,"description":"Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). <a href=\"https://kb.revcent.com/en/payments/credit-card/gateway#global-cascade-rules-1\" target=\"_blank\">Read More</a>","properties":{"enabled":{"description":"Whether time rules are enabled.","type":"boolean"},"options":{"description":"An array of individual time rules.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the individual time rule is enabled.","type":"boolean"},"start_time":{"description":"The start time, formatted as hh:mm:a","type":"string"},"end_time":{"description":"The end time, formatted as hh:mm:a","type":"string"},"name":{"description":"The specific weekday that the time rule applies.","type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"option":{"description":"Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges.","type":"string","enum":["allow","deny"]}}}}}}}},"merchant_account_id":{"description":"The merchant account id or MID specific to the user gateway.","type":"string"},"transaction_fail_fee":{"description":"The flat fee for failed or declined transactions.","type":"number","format":"float"},"transaction_success_fee":{"description":"The flat fee for approved transactions.","type":"number","format":"float"},"smart_bin":{"type":"object","additionalProperties":false,"description":"If SmartBin is enabled for the RevCent account, the SmartBin settings for the user gateway. When enabled, SmartBin gives you the ability to have payments automatically routed to the gateway that has the highest statistical likelihood of success.<br><br>These are advanced settings and should only be provided if using SmartBin. If using SmartBin and creating a new gateway via CreateUserGateway, attempt to complete as many fields as possible to allow the SmartBin algorithm to have the most information available when determining the best gateway. If editing a gateways' smart_bin object via the EditUserGateway operation, the entire smart_bin object must be present, i.e. the smart_bin object in the request will overwrite existing if provided, so all properties should be retrieved first before editing.<br><br>For more information on SmartBin, please visit our <a href\"https://kb.revcent.com/en/payments/credit-card/smartbin\" target=\"_blank\">knowledge base</a>.","properties":{"mcc":{"description":"The MCC for the specific gateway.","type":"string"},"processor":{"description":"The processor for the specific gateway.","type":"string","enum":["ach_com","acheck","achnow","aci_pay_on","axe_pay_plus","bluesnap","boltpay","card_pmt","cash","cashflows","chase_paymentech_netconnect","chase_paymentech_salem","chase_paymentech_tampa","checkout_com","consumer_choice","credorax_v_2","elavon","elavon_emv","epx","evertec","evo","finest_finance_aci","first_data_canada","first_data_nashville","first_data_north_v_2","first_data_omaha","first_data_rapid_connect_cardnet_north_emv","first_data_rapid_connect_nashville_emv","fiserv_pepper_pay_pinless_debit","fiserv_rapid_hc_host_capture_surcharge_debit_repayment","fiserv_rapid_otc_online_terminal_capture_level_3","flex","gateway_duel_pricing","global_payments_canada","global_payments_east_emv","global_payments_uc","groove_connect","groovepay","integrapay_australia_new_zeland","ironwood","konnectable","kotapay","maverick","mes_trident","mgi_apm","moneris","mx_merchant","netevia","nmi","pathly","paynetworx","paysafe_continuity","paysafe_direct","rapid_iq","reliafund","sage_ach","secure_payment_systems","stax","stripe_connect","tabapay","tsys_emv","tsys_sierra","vantiv","vantiv_now_worldpay_core_terminal_capture","vantiv_now_worldpay_ecommerce_terminal_capture_litle_co","versitix","world_pay","world_pay_host_capture_emv"]},"visa":{"type":"object","description":"The Visa settings for the specific gateway.","additionalProperties":false,"properties":{"mid":{"description":"The Visa MID for the specific gateway.","type":"string"},"bin":{"description":"The Visa BIN for the specific gateway.","type":"string"},"acquirer":{"type":"string","description":"The acquirer for the specific cart type.","enum":["acquirer_first_national","aliant_payments","avidia_bank","axiom","banco_nacional_de_panama","banistmo_s_a","bank_of_china_unlimited","bankcard_usa","banorte","bbva","be_2_bill","bluesnap","bmo_harris","braintree","cardconnect","cashflows","cbcal","central_bank","central_bank_of_st_louis","checkout_com","checkout_limited","chesapeake","citizens_bank","cliq","commercial_bank_of_ca","connexpay","credicorp_bank","deutsche","ecp","elavon","electronic_merchant_services","emerchantpay","eq","esquire","evolve_bank_trust","fifth_third_bank","finaro","first_data_europe_ltd","first_national_bank_of_omaha","fiserv","fresno_first_bank","global_payments","harris_national_bank","humbolt","i_3","imperial_bank","intrix","jp_morgan_chase","maverick","merchant_e","merrick_bank","metabank","metropolitan_commercial_bank","mission_valley","nab","north_american_banking_company","optimal_acquiring","other","payarc","payon","payone","paysafe","paystarx","payvision","peoples_trust_company","pnc","priority_payments","psigate","rapyd","reitumu","secure_trading","select_bank","signapay","signature_bank","ssb","stripe_payfac","synovus_bank","transact_europe_ead","transact_pro","trust_payments_ltd","trustpay","tsys","valitor","vantiv","vermont_state_bank","wells_fargo","westamerica","woodforrest_national","worldline","worldpay","worldpay_pty"]}}},"mastercard":{"type":"object","description":"The MasterCard settings for the specific gateway.","additionalProperties":false,"properties":{"mid":{"description":"The MasterCard MID for the specific gateway.","type":"string"},"bin":{"description":"The MasterCard BIN for the specific gateway.","type":"string"},"acquirer":{"type":"string","description":"The acquirer for the specific cart type.","enum":["acquirer_first_national","aliant_payments","avidia_bank","axiom","banco_nacional_de_panama","banistmo_s_a","bank_of_china_unlimited","bankcard_usa","banorte","bbva","be_2_bill","bluesnap","bmo_harris","braintree","cardconnect","cashflows","cbcal","central_bank","central_bank_of_st_louis","checkout_com","checkout_limited","chesapeake","citizens_bank","cliq","commercial_bank_of_ca","connexpay","credicorp_bank","deutsche","ecp","elavon","electronic_merchant_services","emerchantpay","eq","esquire","evolve_bank_trust","fifth_third_bank","finaro","first_data_europe_ltd","first_national_bank_of_omaha","fiserv","fresno_first_bank","global_payments","harris_national_bank","humbolt","i_3","imperial_bank","intrix","jp_morgan_chase","maverick","merchant_e","merrick_bank","metabank","metropolitan_commercial_bank","mission_valley","nab","north_american_banking_company","optimal_acquiring","other","payarc","payon","payone","paysafe","paystarx","payvision","peoples_trust_company","pnc","priority_payments","psigate","rapyd","reitumu","secure_trading","select_bank","signapay","signature_bank","ssb","stripe_payfac","synovus_bank","transact_europe_ead","transact_pro","trust_payments_ltd","trustpay","tsys","valitor","vantiv","vermont_state_bank","wells_fargo","westamerica","woodforrest_national","worldline","worldpay","worldpay_pty"]}}},"discover":{"type":"object","description":"The Discover settings for the specific gateway.","additionalProperties":false,"properties":{"mid":{"description":"The Discover MID for the specific gateway.","type":"string"},"bin":{"description":"The Discover BIN for the specific gateway.","type":"string"},"acquirer":{"type":"string","description":"The acquirer for the specific cart type.","enum":["acquirer_first_national","aliant_payments","avidia_bank","axiom","banco_nacional_de_panama","banistmo_s_a","bank_of_china_unlimited","bankcard_usa","banorte","bbva","be_2_bill","bluesnap","bmo_harris","braintree","cardconnect","cashflows","cbcal","central_bank","central_bank_of_st_louis","checkout_com","checkout_limited","chesapeake","citizens_bank","cliq","commercial_bank_of_ca","connexpay","credicorp_bank","deutsche","ecp","elavon","electronic_merchant_services","emerchantpay","eq","esquire","evolve_bank_trust","fifth_third_bank","finaro","first_data_europe_ltd","first_national_bank_of_omaha","fiserv","fresno_first_bank","global_payments","harris_national_bank","humbolt","i_3","imperial_bank","intrix","jp_morgan_chase","maverick","merchant_e","merrick_bank","metabank","metropolitan_commercial_bank","mission_valley","nab","north_american_banking_company","optimal_acquiring","other","payarc","payon","payone","paysafe","paystarx","payvision","peoples_trust_company","pnc","priority_payments","psigate","rapyd","reitumu","secure_trading","select_bank","signapay","signature_bank","ssb","stripe_payfac","synovus_bank","transact_europe_ead","transact_pro","trust_payments_ltd","trustpay","tsys","valitor","vantiv","vermont_state_bank","wells_fargo","westamerica","woodforrest_national","worldline","worldpay","worldpay_pty"]}}},"amex":{"type":"object","description":"The American Express settings for the specific gateway.","additionalProperties":false,"properties":{"mid":{"description":"The American Express MID for the specific gateway.","type":"string"},"bin":{"description":"The American Express BIN for the specific gateway.","type":"string","enum":["10000000002","10000000006","10000000232","10000000319","10000000005"]},"acquirer":{"type":"string","description":"The acquirer for the specific cart type.","enum":["acquirer_first_national","aliant_payments","avidia_bank","axiom","banco_nacional_de_panama","banistmo_s_a","bank_of_china_unlimited","bankcard_usa","banorte","bbva","be_2_bill","bluesnap","bmo_harris","braintree","cardconnect","cashflows","cbcal","central_bank","central_bank_of_st_louis","checkout_com","checkout_limited","chesapeake","citizens_bank","cliq","commercial_bank_of_ca","connexpay","credicorp_bank","deutsche","ecp","elavon","electronic_merchant_services","emerchantpay","eq","esquire","evolve_bank_trust","fifth_third_bank","finaro","first_data_europe_ltd","first_national_bank_of_omaha","fiserv","fresno_first_bank","global_payments","harris_national_bank","humbolt","i_3","imperial_bank","intrix","jp_morgan_chase","maverick","merchant_e","merrick_bank","metabank","metropolitan_commercial_bank","mission_valley","nab","north_american_banking_company","optimal_acquiring","other","payarc","payon","payone","paysafe","paystarx","payvision","peoples_trust_company","pnc","priority_payments","psigate","rapyd","reitumu","secure_trading","select_bank","signapay","signature_bank","ssb","stripe_payfac","synovus_bank","transact_europe_ead","transact_pro","trust_payments_ltd","trustpay","tsys","valitor","vantiv","vermont_state_bank","wells_fargo","westamerica","woodforrest_national","worldline","worldpay","worldpay_pty"]}}}}}},"type":"object","required":["name","site_gateway_id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"user_gateway_id":{"type":"string","description":"A 20 character user gateway ID.","minLength":20,"maxLength":20},"result":{"type":"string"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}