Transfer options
transfer_optionsWhich of the traveler's bank points can become miles/points in a target loyalty program, at what ratio, and how many they would end up with. Based on a researched transfer-partner table (has an as_of date; ratios change and transfer bonuses are not included). Pass the traveler's balances.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| balances | Yes | The traveler's bank point balances, e.g. [{"bank":"amex_mr","points":250000}]. amex_mr means a US-issued Amex; for an Amex issued elsewhere use the country key (amex_mr_be/_nl/_uk/_fr/_de/_es/_it/_se/_ch/_ca/_au/_sg/_hk/_in/_ae: different partners and ratios). Also Revolut RevPoints (revolut_eu, revolut_uk) and local banks (rbc_avion_ca, anz_au, westpac_au, nab_au, cba_au, dbs_sg, uob_sg, citi_sg, hsbc_sg, hsbc_hk, citi_hk, scb_hk, hdfc_in, axis_in, icici_in, enbd_ae, mashreq_ae, fab_ae). Ask which country issued the card if unclear. | |
| miles_needed | Yes | Miles the award costs, to check whether the balances cover it; null if unknown | |
| target_programs | Yes | Program slugs, e.g. ["aeroplan","flyingblue","virginatlantic","ana","hyatt"]. Empty array = list every partner reachable from the balances. |