Documentation
Request a demo

Payout Routing attributes

Payout Routing attributes define the parameters used to determine how outbound transactions are routed through available Providers and Payout Methods. These attributes allow you to create Routing rules that automatically select the most appropriate processing Route based on specific payout characteristics.

Payout Routing attributes overview

Condition property → applied Description Precondition for the value entity
Day of week The property applies to the day of the week of the current month.

The payout is initiated based on the day the payment was finalised. 		Data type: integer. The value must be greater than or equal to 7 and less than or equal to 1.
Day of month The property covers the day of the month at the present time.

The payout is initiated based on the day the payment was finalised. 		Data type: integer. The value must be greater than or equal to 31 and less than or equal to 1.
Day of year The property covers the day of the year at the present time.

The payout is initiated based on the day the payment was finalised. 		Data type: integer. The value must be greater than or equal to 1 and less than or equal to 365.
Payout Commit amount The Payout amount is set based on the currency used in a Payout Commit. Data type: float.
Random initial The default property which enables you to set a particular number and if the system random number matches the condition you set with a relational operator, the payment can be delivered to a particular Route accordingly. The payout should be fulfilled based on the condition. Data type: integer. The total number of characters in the string should be greater or equal to 1 and less than or equal to 15.
Payout Commit auth 3ds 3DS mode serves as an additional level of protection while the system asks the Cardholder to provide proof of identity and insert a unique code, password, etc.

The property corresponds to the Route configuration 3DS feature enabled. However, if not applied earlier, you can establish the condition and choose the 3DS specification for the value entity. 		You can choose the value from the dropdown list containing:
  • 3DS Disabled
  • 3DS Optional
  • 3DS Required
  • 3DS v1 Required
  • 3DS v2 Required
Card network The property covers the system response to the payment Card network type: Visa, Mastercard, American Express, Discover, Diners Club, China UnionPay, etc.

The payout is made based on payments within specific card network. 		You can choose the value from the dropdown list containing all supported Card networks.
Payout Commit auth cvv CVV mode can be required for certain PSPs to enable accepting payments. Thus, you can establish the condition and make a CVV field required for your Customers if needed. Then, the payouts could be finalised to those Customers based on the condition. You can choose the value from the dropdown list containing:
  • CVV Disabled
  • CVV Optional
  • CVV Required
Card brand The property covers the card network or scheme under which the card is issued. Data type: string. The total number of characters in the string should not exceed 10.
Card first 6 The property covers the Card Bin, which is the first 6 items of a credit or debit card number used to identify which bank or institution issued the card. The Routing condition can be created based on that data and the payout should be distributed accordingly. Data type: integer. The total number of characters in the string should be equal to 6.
Card type The property applies to the Card type used for the payment. The Routing is initiated if the Card type condition is fulfilled. You can choose the value from the dropdown list containing:
  • Debit
  • Credit
  • Prepaid
Payout Commit currency The property corresponds to a currency used when creating a Payout Request. You can choose the value from the dropdown list containing the overview of all supported currencies.
Payout issuer country The property pertains to the country from where the Payout Request was created. You can choose the value from the dropdown list containing the supported countries.
Payout client country The property refers to the country from which the payment was initiated. You can choose the value from the dropdown list containing the supported countries.
Payout issuer name The property outlines the name of the issuing bank or financial institution that issued the payer's card. This attribute identifies the issuer involved in the payment. Data type: string. The total number of characters in the string should not exceed 10.
Payout Request metadata The property covers the Metadata included in the Payout Request. The Routing is initiated and the payout is made according to that specific Metadata. You can enter data into the input key and input value fields. The key is an attribute, and the value is the key parameter. Data type: text, integer, float.
Card Successful Payouts Day/Week/Month The property covers the system response to the number of successful card payments fulfilled per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Failed Payouts Day/Week/Month The property covers the system response to the number of Customer's failed payments fulfilled per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Total Payouts Day/Week/Month The property covers the system response to the number of all Customer's payments fulfilled per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Successful Turnover Day/Week/Month The property covers the system response to the total monetary value of successful card transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Not Final Turnover Day/Week/Month The property covers the system response to the total value of authorised but not yet settled card transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Total Turnover Day/Week/Month The property covers the system response to the total monetary value of all card transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Successful Turnover Day/Week/Month The property covers the system response to the total monetary value of successful Customer's transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Not Final Turnover Day/Week/Month The property covers the system response to the total value of authorised but not yet settled Customer's transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Total Turnover Day/Week/Month The property covers the system response to the total monetary value of all Customer's transactions per day, week, or month accordingly. The payout process functions based on the condition. Data type: float. The total number of characters in the string should be less than or equal to 15.

Attributes & Operators matrix

Operators →
Conditions ↓		 = Equals to ≠ Not equals > Greater than ≥ Greater or equal < Less than ≤ Less or equal =+ Equals any of ≠+ Not equals any of = Matches → On a List −\→ Not on a List = Key exists = Key not exist = Key matches
Day of week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Day of month ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Day of year ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Payout Commit amount ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Random initial ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Payout Commit Auth 3DS ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌
Payout Commit Auth CVV ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌
Card first 6 ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card type ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ❌ ✅ ✅ ❌ ❌ ❌
Card network ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card brand ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Payout issuer name ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Payout Commit currency ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ❌ ✅ ✅ ❌ ❌ ❌
Payout issuer country ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Payout client country ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Payout Request metadata ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅ ✅
Card Successful Payouts
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Failed Payouts
Day/Week/Month		 ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Total Payouts
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Successful Payouts
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Failed Payouts
Day/Week/Month		 ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Total Payouts
Day/Week/Month		 ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Successful Turnover
Day/Week/Month		 ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Not Final Turnover
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Total Turnover
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Successful Turnover
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Not Final Turnover
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Total Turnover
Day/Week/Month 		✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌

Updated 20 days ago