Glossary
Contains the complementary values necessary to correctly fill the data of the requests sent to the API
The glossary serves as a reference for fields that have pre-defined values, such as document types, currencies, payment methods, among others. These values ensure the consistency and standardization of the information sent and processed by the API.
Integration Modules
Person Type
billing.type shipping.type
| Value | Description |
|---|---|
| 1 | Individual |
| 2 | Legal Entity |
Customer Gender
billing.gender shipping.gender passenger.gender
| Value | Description |
|---|---|
| M | Male |
| F | Female |
Delivery Type
shipping.deliveryType
| Value | Description |
|---|---|
| 0 | Others |
| 1 | Normal |
| 2 | Guaranteed |
| 3 | ExpressBR |
| 4 | ExpressSP |
| 5 | High |
| 6 | Economic |
| 7 | Scheduled |
| 8 | Extra Fast |
| 9 | Printed |
| 10 | Application |
| 11 | |
| 12 | Motorcycle Courier |
| 13 | Ticket Office Pickup |
| 14 | Partner Store Pickup |
| 15 | Credit Card Ticket |
| 16 | Store Pickup |
| 17 | Pickup via Lockers (Partners) |
| 18 | Pickup at Post Office Agency |
| 19 | Guaranteed Delivery on the same day of purchase |
| 20 | Guaranteed Delivery on the day after purchase |
| 21 | Store pickup - Express |
Payment Type
payment.type
| Value | Description |
|---|---|
| 1 | Credit Card |
| 2 | Bank Slip |
| 3 | Bank Debit |
| 4 | Bank Debit - Cash |
| 5 | Bank Debit - Check |
| 6 | Bank Transfer |
| 7 | Sedex Collect |
| 8 | Check |
| 9 | Cash |
| 10 | Financing |
| 11 | Invoice |
| 12 | Coupon |
| 13 | Multi-check |
| 14 | Others |
| 16 | Voucher |
| 19 | Debit Card |
| 23 | Food Voucher |
| 27 | PIX |
| 28 | Cashback |
| 1041 | Virtual Gift Card |
| 4011 | Debit Card / Electronic Transfer (CD) |
Currency Used
payment.currency
| Numeric Code | Currency | Alphabetic Code |
|---|---|---|
| 965 | ADB Unit of Account | XUA |
| 971 | Afghani | AFN |
| 12 | Algerian Dinar | DZD |
| 32 | Argentine Peso | ARS |
| 51 | Armenian Dram | AMD |
| 533 | Aruban Florin | AWG |
| 36 | Australian Dollar | AUD |
| 944 | Azerbaijanian Manat | AZN |
| 44 | Bahamian Dollar | BSD |
| 48 | Bahraini Dinar | BHD |
| 764 | Baht | THB |
| 590 | Balboa | PAB |
| 52 | Barbados Dollar | BBD |
| 974 | Belarussian Ruble | BYR |
| 84 | Belize Dollar | BZD |
| 60 | Bermudian Dollar | BMD |
| 937 | Bolivar Fuerte | VEF |
| 68 | Boliviano | BOB |
| 955 | Bond Markets Unit European Composite Unit (EURCO) | XBA |
| 956 | Bond Markets Unit European Monetary Unit (E.M.U.-6) | XBB |
| 958 | Bond Markets Unit European Unit of Account 17 (E.U.A.-17) | XBD |
| 957 | Bond Markets Unit European Unit of Account 9 (E.U.A.-9) | XBC |
| 986 | Brazilian Real | BRL |
| 96 | Brunei Dollar | BND |
| 975 | Bulgarian Lev | BGN |
| 108 | Burundi Franc | BIF |
| 124 | Canadian Dollar | CAD |
| 132 | Cape Verde Escudo | CVE |
| 136 | Cayman Islands Dollar | KYD |
| 952 | CFA Franc BCEAO | XOF |
| 950 | CFA Franc BEAC | XAF |
| 953 | CFP Franc | XPF |
| 152 | Chilean Peso | CLP |
| 963 | Codes specifically reserved for testing purposes | XTS |
| 170 | Colombian Peso | COP |
| 174 | Comoro Franc | KMF |
| 976 | Congolese Franc | CDF |
| 977 | Convertible Mark | BAM |
| 558 | Cordoba Oro | NIO |
| 188 | Costa Rican Colon | CRC |
| 191 | Croatian Kuna | HRK |
| 192 | Cuban Peso | CUP |
| 203 | Czech Koruna | CZK |
| 270 | Dalasi | GMD |
| 208 | Danish Krone | DKK |
| 807 | Denar | MKD |
| 262 | Djibouti Franc | DJF |
| 678 | Dobra | STD |
| 214 | Dominican Peso | DOP |
| 704 | Dong | VND |
| 951 | East Caribbean Dollar | XCD |
| 818 | Egyptian Pound | EGP |
| 222 | El Salvador Colon | SVC |
| 230 | Ethiopian Birr | ETB |
| 978 | Euro | EUR |
| 238 | Falkland Islands Pound | FKP |
| 242 | Fiji Dollar | FJD |
| 348 | Forint | HUF |
| 936 | Ghana Cedi | GHS |
| 292 | Gibraltar Pound | GIP |
| 959 | Gold | XAU |
| 332 | Gourde | HTG |
| 600 | Guarani | PYG |
| 324 | Guinea Franc | GNF |
| 328 | Guyana Dollar | GYD |
| 344 | Hong Kong Dollar | HKD |
| 980 | Hryvnia | UAH |
| 352 | Iceland Krona | ISK |
| 356 | Indian Rupee | INR |
| 364 | Iranian Rial | IRR |
| 368 | Iraqi Dinar | IQD |
| 388 | Jamaican Dollar | JMD |
| 400 | Jordanian Dinar | JOD |
| 404 | Kenyan Shilling | KES |
| 598 | Kina | PGK |
| 418 | Kip | LAK |
| 414 | Kuwaiti Dinar | KWD |
| 454 | Kwacha | MWK |
| 973 | Kwanza | AOA |
| 104 | Kyat | MMK |
| 981 | Lari | GEL |
| 428 | Latvian Lats | LVL |
| 422 | Lebanese Pound | LBP |
| 8 | Lek | ALL |
| 340 | Lempira | HNL |
| 694 | Leone | SLL |
| 430 | Liberian Dollar | LRD |
| 434 | Libyan Dinar | LYD |
| 748 | Lilangeni | SZL |
| 440 | Lithuanian Litas | LTL |
| 426 | Loti | LSL |
| 969 | Malagasy Ariary | MGA |
| 458 | Malaysian Ringgit | MYR |
| 480 | Mauritius Rupee | MUR |
| 484 | Mexican Peso | MXN |
| 979 | Mexican Unidad de Inversion (UDI) | MXV |
| 498 | Moldovan Leu | MDL |
| 504 | Moroccan Dirham | MAD |
| 943 | Mozambique Metical | MZN |
| 984 | Mvdol | BOV |
| 566 | Naira | NGN |
| 232 | Nakfa | ERN |
| 516 | Namibia Dollar | NAD |
| 524 | Nepalese Rupee | NPR |
| 532 | Netherlands Antillean Guilder | ANG |
| 376 | New Israeli Sheqel | ILS |
| 946 | New Romanian Leu | RON |
| 901 | New Taiwan Dollar | TWD |
| 554 | New Zealand Dollar | NZD |
| 64 | Ngultrum | BTN |
| 408 | North Korean Won | KPW |
| 578 | Norwegian Krone | NOK |
| 604 | Nuevo Sol | PEN |
| 478 | Ouguiya | MRO |
| 776 | Pa'anga | TOP |
| 586 | Pakistan Rupee | PKR |
| 964 | Palladium | XPD |
| 446 | Pataca | MOP |
| 931 | Peso Convertible | CUC |
| 858 | Peso Uruguayo | UYU |
| 608 | Philippine Peso | PHP |
| 962 | Platinum | XPT |
| 826 | Pound Sterling | GBP |
| 72 | Pula | BWP |
| 634 | Qatari Rial | QAR |
| 320 | Quetzal | GTQ |
| 710 | Rand | ZAR |
| 512 | Rial Omani | OMR |
| 116 | Riel | KHR |
| 462 | Rufiyaa | MVR |
| 360 | Rupiah | IDR |
| 643 | Russian Ruble | RUB |
| 646 | Rwanda Franc | RWF |
| 654 | Saint Helena Pound | SHP |
| 682 | Saudi Riyal | SAR |
| 960 | SDR (Special Drawing Right) | XDR |
| 941 | Serbian Dinar | RSD |
| 690 | Seychelles Rupee | SCR |
| 961 | Silver | XAG |
| 702 | Singapore Dollar | SGD |
| 90 | Solomon Islands Dollar | SBD |
| 417 | Som | KGS |
| 706 | Somali Shilling | SOS |
| 972 | Somoni | TJS |
| 728 | South Sudanese Pound | SSP |
| 144 | Sri Lanka Rupee | LKR |
| 994 | Sucre | XSU |
| 938 | Sudanese Pound | SDG |
| 968 | Surinam Dollar | SRD |
| 752 | Swedish Krona | SEK |
| 756 | Swiss Franc | CHF |
| 760 | Syrian Pound | SYP |
| 50 | Taka | BDT |
| 882 | Tala | WST |
| 834 | Tanzanian Shilling | TZS |
| 398 | Tenge | KZT |
| 780 | Trinidad and Tobago Dollar | TTD |
| 496 | Tugrik | MNT |
| 788 | Tunisian Dinar | TND |
| 949 | Turkish Lira | TRY |
| 934 | Turkmenistan New Manat | TMT |
| 784 | UAE Dirham | AED |
| 800 | Uganda Shilling | UGX |
| Nil | UIC-Franc | XFU |
| 970 | Unidad de Valor Real | COU |
| 990 | Unidades de fomento | CLF |
| 940 | Uruguay Peso en Unidades Indexadas (URUIURUI) | UYI |
| 840 | US Dollar | USD |
| 997 | US Dollar (Next day) | USN |
| 998 | US Dollar (Same day) | USS |
| 860 | Uzbekistan Sum | UZS |
| 548 | Vatu | VUV |
| 947 | WIR Euro | CHE |
| 948 | WIR Franc | CHW |
| 410 | Won | KRW |
| 886 | Yemeni Rial | YER |
| 392 | Yen | JPY |
| 156 | Yuan Renminbi | CNY |
| 894 | Zambian Kwacha | ZMK |
| 932 | Zimbabwe Dollar | ZWL |
| 985 | Zloty | PLN |
Card Type
card.type
| Value | Description |
|---|---|
| 1 | Diners |
| 2 | MasterCard |
| 3 | Visa |
| 4 | Others |
| 5 | American Express |
| 6 | HiperCard |
| 7 | Aura |
| 10 | Elo Card |
| 50 | LeaderCard |
| 100 | Fortbrasil |
| 101 | Sorocred |
| 102 | A Vista |
| 103 | Mais Card |
| 105 | C&A Card |
Document Type
document.type passenger.type
| Value | Description |
|---|---|
| 1 | CPF |
| 2 | CNPJ |
| 3 | RG |
| 4 | IE |
| 5 | Passport |
| 6 | CTPS |
| 7 | Voter ID |
Address Type
address.type
| Value |
|---|
| Area |
| Camp |
| Churchyard |
| Airport |
| Right Marginal Avenue |
| Ring Road |
| Artery |
| Shortcut |
| Avenue |
| Marginal Avenue |
| Seaside Resort |
| Hole |
| Block |
| Blocks |
| Woods |
| Quay |
| Path |
| Small Farm |
| Cycle Path |
| Complex |
| Road Complex |
| Community |
| Corridor |
| Stream |
| Descent |
| District |
| Intermunicipal Road |
| Private Entrance |
| Staircase |
| State Road |
| Link Road |
| Esplanade |
| Road |
| Old Road |
| Stadium |
| Private Road |
| Evangelical |
| Industrial Axis |
| Farm |
| Fountain |
| Fort |
| Small Holding |
| Island |
| Small Island |
| Small Garden |
| Lagoon |
| Subdivision |
| Lot |
| Marina |
| Projection |
| Mount |
| Rural Nucleus |
| Parallel |
| Patio |
| Sports Square |
| Stopover |
| Beach |
| Municipal Park |
| Residential Park |
| Passage |
| Underpass |
| Port |
| Estate |
| Street |
| Link Street |
| Old Street |
| Recreation |
| Retreat |
| Straight |
| Ramp |
| Highway |
| Pedestrian Street |
| Return |
| Second Avenue |
| Easement |
| Ascent |
| Terminal |
| Interchange |
| Cross Street |
| Old Cross Street |
| Way |
| Local Way |
| Ditch |
| Viaduct |
| Path |
| Village |
| Valley |
| Pedestrian Way |
| Zigzag |
Phone Type
phone.type
| Value | Description |
|---|---|
| 0 | Undefined |
| 1 | Residential |
| 2 | Commercial |
| 3 | Messages |
| 4 | Collection |
| 5 | Temporary |
| 6 | Mobile |
Item Category ID and Item Category
item.categoryId
| Value | Description |
|---|---|
| 1 | Null field |
| 2 | Computers: Notebook |
| 3 | Games |
| 4 | Mobile phone |
| 5 | Telephony: Others |
| 6 | Computers: Others |
| 7 | Computers: Computer |
| 8 | Home Appliances: Stove/Microwave |
| 9 | Home Appliances: Washing Machine |
| 10 | Home Appliances: Refrigerator/Freezer |
| 11 | Small Appliances |
| 12 | Home Appliances: Air/Fan |
| 13 | Home Appliances: Others |
| 14 | Electronics: Tv/Monitor |
| 15 | Electronics: Video |
| 16 | Electronics: Audio |
| 17 | Automotive |
| 18 | Cinema and Photo |
| 19 | Beauty |
| 20 | Toys |
| 21 | Furniture |
| 22 | Home utilities |
| 23 | Backpack/bags |
| 24 | Sports |
| 25 | Watch |
| 26 | Flight/Ticket |
| 27 | Shoes |
| 28 | Moccasin |
| 29 | Boots |
| 30 | Sneakers |
| 31 | T-Shirt |
| 32 | Shirt |
| 33 | Bags/backpacks |
| 34 | Pants |
| 35 | Shorts |
| 36 | Cap |
| 37 | Sweaters |
| 38 | Jackets |
| 39 | Blouse |
| 40 | Tennis shoes |
| 41 | Dresses |
| 42 | Skirt |
| 43 | Accessories |
| 44 | Glasses |
| 45 | Underwear |
| 46 | Beachwear |
| 47 | Perfume |
| 48 | Makeup |
| 49 | Suit |
| 50 | Jumpsuit |
| 51 | Baby |
| 52 | Pajamas |
| 53 | Socks |
| 54 | Jewelry |
Decision Result
decision.result
| Value | Description |
|---|---|
| AMA | Manual Analysis |
| AME | External Manual Analysis |
| APA | Automatic Approval |
| APP | Approved by Policy |
| ASA | No Analysis |
| CAN | Canceled |
| CPP | Canceled by Policy |
| INC | Inconclusive Strong Authentication |
| PEN | Pending Strong Authentication / Awaiting Extended Decision |
| PGA | Payment Approved |
| PGR | Payment Rejected |
| RPA | Automatic Rejection |
| RPP | Rejected by Policy |
| SCO | Model Applied |
Status Result
decision.status mfa.status biolink.status insights.status
| Value | Description |
|---|---|
| Done | Completed |
| Pending | Pending |
| Error | Error |
Updated 2 months ago