Routing Rules

Evaluate the existing hybrid routing pipeline using the flat request contract. Existing rule evaluation, SR feature gates, A/B experiments and fallback behavior apply.

post/decide

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/decide
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

payment_idstring required
amountinteger required

Amount in currency minor units; supplies both existing amount and payment_amount rule keys and the dynamic payment amount.

currencystring required

Currency code, e.g. USD.

payment_method_typestring nullable

Payment method family, e.g. card.

payment_method_sub_typestring nullable

Payment method subtype, e.g. credit.

authentication_typestring nullable
capture_methodstring nullable
mandate_typestring nullable
mandate_acceptance_typestring nullable
payment_typestring nullable

The payment_type rule key: normal, new_mandate, update_mandate, setup_mandate, recurring_mandate, non_mandate or ppt_mandate. A rule that tests payment_type matches only when it is sent.

setup_future_usagestring nullable
transaction_initiatorstring nullable
surcharge_amountinteger nullable

Amount in currency minor units.

business_countrystring nullable

ISO 3166 alpha-2 country code.

billing_countrystring nullable

ISO 3166 alpha-2 country code.

business_labelstring nullable
customer_device_platformstring nullable
customer_device_typestring nullable
customer_device_display_sizestring nullable
pay_laterstring nullable
walletstring nullable
upistring nullable
voucherstring nullable
bank_redirectstring nullable
bank_debitstring nullable
bank_transferstring nullable
real_time_paymentstring nullable
gift_cardstring nullable
card_redirectstring nullable
open_bankingstring nullable
mobile_paymentstring nullable
cryptostring nullable
rewardstring nullable
network_tokenstring nullable
metadataobject nullable
countrystring nullable

ISO 3166 alpha-2 country code.

customer_idstring nullable
merchant_idstring required

Routing scope previously supplied as created_by. Use the same identifier, including the HS profile ID where applicable.

Response

Routing decision. Connector order and account IDs are preserved from hybrid routing. An account ID can be null when a legacy rule identifies only a gateway.

idstring required

Unique per decision (dec_ + a time-ordered UUID), so a retried payment's decisions stay apart.

payment_idstring required
request_idstring required

The x-request-id of the call, or the one minted for it. Matches the response header.

created_atstring date-time required

Example response

{
  "debit_routing": {
    "co_badged_card_networks_info": [
      {
        "network": "NYCE",
        "saving_percentage": 1.2
      }
    ],
    "issuer_country": "US",
    "card_type": "Debit"
  }
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional request property

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became optional

    • info

      the request property /// became optional

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      endpoint added