Capabilities API is used for fetching a JSON-formatted full list of payment channels available for the specified merchant. Returned list also includes additional information like recommended price format, country and channel codes and supported authorization and payment flows.
Capabilities API should not be called for each authorization or payment. For better performance it is recommended to cache capabilities API response for up to 5 minutes. On Fortumo side capabilities output is cached so it may take up to 20 minutes for changes to appear.
The most common way of using Capabilities API is to simplify country and operator payment channels management while using Payments API and Unified SDK products and expanding coverage.
Please note that the fact a certain payment channel is listed in capabilities output does not guarantee that this channel or its flows are fully ready for production usage. Many channels require additional prelaunch configuration before they can be used and Capabilities API does not reflect that status of telco approvals and UAT requirements. Please always consult with your Account Manager on latest status of payment channel availability.
If you plan to fully automate country and operator visibility in your checkout flow based on Capabilities API output, then please take into account that new channel launches may still require a limited UAT testing before new route can be enabled to all users. Taking this into account, we suggest to also implement a configurable "limited testing availability" mode that you could enable for new routes or rely on a setup with 2 merchant accounts, one for staging testing and UAT and one for production.
Capabilities API endpoint URL:
https://api-jwt.fortumo.io
1 | GET /capabilities/{merchant_id} HTTP/1.1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | HTTP/1.1 200 OK Content-Type: application/json [ { "country":"KH", "display_format":"$[value] including Tax", "payment_methods":[ { "name":"CARRIER_BILLING", "channel":[ { "name":"Smart", "code":"smart-kh", "authorisation_flows":[ "pin" ], "charging_flows":[ "one_step" ], "messaging_flows":[ "sms" ], "transaction_ranges":[ { "currency":"USD", "min":0.0, "max":100.0, "step":1.0 } ] }, { "name":"Cellcard", "code":"cellcard-kh", "ip_ranges":[ "54.72.129.115", "203.144.92.0/24", "203.144.93.0/24", "1.1.1.1", "203.144.88.0/24", "203.144.67.0/24" ], "authorisation_flows":[ "pin", "he" ], "charging_flows":[ "one_step" ], "transaction_ranges":[ { "currency":"USD", "min":0.0, "max":100.0, "step":1.0 } ] } ] } ] }, { "country": "EE", "display_format": "€[value]", "payment_methods": [ { "name": "CARRIER_BILLING", "channel": [ { "name": "Sandbox Estonia", "code": "sandbox-ee", "ip_ranges": [ "127.0.0.1" ], "authorisation_flows": [ "pin", "he" ], "charging_flows": [ "reserve_charge", "one_step" ], "transaction_ranges": [ { "currency": "EUR", "min": 0, "max": 100, "step": 1 } ] } ] } ] }, { "country":"ID", "display_format":"Rp[value]", "payment_methods":[ { "name":"CARRIER_BILLING", "channel":[ { "name":"3", "code":"hutchison-id", "ip_ranges":[ "223.255.224.0/21", "180.214.232.0/22", "103.10.64.0/22", "124.153.32.0/23", "202.67.32.0/20" ], "msisdn_patterns":[ "^62895[0-9].*", "^62896[0-9].*", "^62897[0-9].*", "^62898[0-9].*", "^62899[0-9].*" ], "authorisation_flows":[ "pin" ], "charging_flows":[ "reserve_charge", "one_step" ], "messaging_flows":[ "sms" ], "transaction_ranges":[ { "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 } ] }, { "name":"Smartfren", "code":"smartfren-id", "ip_ranges":[ "103.3.210.0/23", "114.79.0.0/18", "115.178.184.0/21", "115.178.192.0/18", "202.73.224.0/22" ], "msisdn_patterns":[ "^62881[0-9].*", "^62882[0-9].*", "^62887[0-9].*", "^62888[0-9].*", "^62889[0-9].*" ], "authorisation_flows":[ "pin", "he" ], "charging_flows":[ "reserve_charge", "one_step" ], "messaging_flows":[ "sms" ], "transaction_ranges":[ { "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 } ] }, { "name":"Sandbox Indonesia", "code":"sandbox-id", "authorisation_flows":[ "pin", "he" ], "charging_flows":[ "reserve_charge", "one_step" ], "messaging_flows":[ "sms" ], "transaction_ranges":[ { "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 } ] }, { "name":"Indosat Ooredoo", "code":"indosat-id", "msisdn_patterns":[ "^62814[0-9].*", "^62815[0-9].*", "^62816[0-9].*", "^62855[0-9].*", "^62856[0-9].*", "^62857[0-9].*", "^62858[0-9].*" ], "authorisation_flows":[ "pin" ], "charging_flows":[ "reserve_charge", "one_step" ], "messaging_flows":[ "sms" ], "transaction_ranges":[ { "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 } ] }, { "name":"XL Axiata", "code":"axiata-id", "ip_ranges":[ "112.215.63.0/24", "112.215.64.0/24", "112.215.66.0/24", "112.215.19.0/24", "112.215.170.0/24", "112.215.45.0/24", "112.215.65.0/24", "112.215.200.0/24", "112.215.201.0/24", "112.215.171.0/24", "112.215.151.0/24", "112.215.152.0/24", "112.215.44.0/24", "112.215.153.0/24", "112.215.154.0/24", "112.215.172.0/24", "112.215.173.0/24", "112.215.36.128/26", "112.215.50.0/24", "112.215.123.0/25", "112.215.124.0/24", "112.215.123.128/26", "112.215.123.192/27", "112.215.147.0/24", "112.215.174.0/24", "112.215.148.0/24", "112.215.175.0/24" ], "msisdn_patterns":[ "^62817[0-9].*", "^62818[0-9].*", "^62819[0-9].*", "^62831[0-9].*", "^62832[0-9].*", "^62838[0-9].*", "^62859[0-9].*", "^62877[0-9].*", "^62878[0-9].*", "^62879[0-9].*" ], "authorisation_flows":[ "pin" ], "charging_flows":[ "one_step" ], "transaction_ranges":[ { "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 } ] } ] } ] } ] |
| Parameter | Type | Required | Description |
|---|---|---|---|
| country | String | Mandatory | Specifies the country of the recipient's MSISDN according to ISO 3166-1 alpha-2. Example: NO |
| display_format | String | Mandatory | Provides a sample format for price in accordance with local requirements. Example: kr[value] or [value] leva |
| channel → name | String | Mandatory | Specifies the name of the payment channel, usually the name of the mobile operator, e.g. Orange or T-Mobile |
| channel → code | String | Mandatory | Specifies the payment channel (carrier) that can be used for completing a payment. Channel codes are issued by Fortumo, e.g. orange-pl |
| channel → ip_ranges | Array | Optional | An array of public IP addresses or IP ranges that are used by mobile operator's customers when browsing the internet via mobile data and thus can be used for automatic operator detection. Please note that these can change at any time and constantly maintaining an up to date list poses a significant challenge. Example: ["43.224.84.0/24","43.224.85.0/24"] |
| channel → msisdn_patterns | Array | Optional | An array of regular expressions that can be used for validating if a MSISDN belongs to specific operator. Universally usable only in markets without number portability. Example: ["^(9599\\d{8})$","^(+9599\\d{8})$"] |
| channel → authorisation_flows | Array | Optional | Lists available authentication flows, e.g. pin for PIN flow, remote_auth for remote authorisation, redirect_auth for redirect authorisation, redirect_auth_on_payment for redirect authorisation on payment, he for header enrichment flow and mo for MO authorisation |
| channel → charging_flows | Array | Mandatory | Lists supported charging flows, e.g. one_step for standard 1-step charging flow and reserve_charge for 2-step reserve and capture flow. |
| channel → messaging_flows | Array | Optional | Lists the availability of messaging channels, e.g. sms or viber |
| channel → transaction_ranges | Array | Mandatory | An object describing currency code, minimum incremental price step, minimum and maximum supported prices, e.g. "currency":"IDR", "min":0.0, "max":100.0, "step":1.0 |