v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Campaigns

Get campaign route merchant

When a campaign is configured to use a payment router, this method will return the next merchant the router will use.

get/campaigns/{campaign_id}/route_merchant

Query parameters

payment_method_idinteger required

Send the payment method ID that will be used.

card_type_idinteger required

Send the card type ID that will be used.

customer_idinteger

Send customer ID if there is an existing customer.

order_idinteger

Send order ID if there is an existing order.

Response

route_merchant_idinteger

route_idinteger

merchant_weightinteger

merchant_limit_enableboolean

merchant_limitinteger

limit_timeframe_idinteger

merchant_priority_enableboolean

merchant_priorityinteger

merchant_priority_limitinteger

priority_timeframe_idinteger

route_timeframe_capinteger

route_type_id1 | 2 | 3

1 - Round Robin
2 - Volume
3 - Weight

route_include_declineboolean

merchant_attempt_3dsboolean

merchant_3ds_providerobject nullable

Custom 3ds provider fields

merchant_idinteger

merchant_namestring

gateway_idinteger

currency_idinteger

Default currency

merchant_mid_idstring

merchant_descriptorstring

merchant_phonestring

merchant_urlstring

merchant_activeboolean

merchant_processorstring nullable

merchant_mcc_codestring nullable

merchant_processing_limitstring

merchant_processing_inforceboolean

merchant_daily_rebills_limitstring

merchant_statestring nullable

merchant_taxstring

merchant_mtd_revenuestring

merchant_mtd_transactionsinteger

merchant_mtd_initialinteger

merchant_processing_percstring

primary_merchant_category_idinteger

secondary_merchant_category_idinteger

merchant_notesstring nullable

date_createdstring date-time

created_byinteger

date_modifiedstring date-time

modified_byinteger

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}