Country States Codes Endpoint
Learn how to use the Country States Codes Endpoint to retrieve the list of States ISO codes in each country
get
https://api-stg.directa24.com
/v3/states?country={ISO_CODE}
Country States Codes Endpoint

Introduction

This endpoint is used to retrieve and display to your customer the list of States available on their country. In case we add or remove a State, this endpoint will reflect those updates real-time and, therefore, it is a good idea to constantly check this endpoint for the list of banks.
Once the user selected their State by its name (For example on a dropdown), you need to send its code to us in the payer.address.state field of the deposits requests.
The endpoint is read only and so it uses a read only API Key. It can even be used from the front-end without major security concerns.

Bank Codes Request

Request Example

1
// URL
2
GET: https://api-stg.directa24.com/v3/states?country=BR
3
4
// HEADERS
5
Authorization: Bearer EKiFOWiHnI
Copied!

Request Fields

Type
Field
Format
Description
Query Param
country
String (length: 2)
Header
Authorization
String
Bearer Token Authentication. It is a concatenation of the word "Bearer " and your read only API Key (or Web Status API Key)

Bank Codes Response

Response Example

Brazil
Colombia
1
[
2
{
3
"iso": "AC",
4
"name": "Acre"
5
},
6
{
7
"iso": "AL",
8
"name": "Alagoas"
9
},
10
{
11
"iso": "AM",
12
"name": "Amazonas"
13
},
14
{
15
"iso": "AP",
16
"name": "Amapá"
17
},
18
{
19
"iso": "BA",
20
"name": "Bahia"
21
},
22
{
23
"iso": "CE",
24
"name": "Ceará"
25
},
26
{
27
"iso": "DF",
28
"name": "Distrito Federal"
29
},
30
{
31
"iso": "ES",
32
"name": "Espírito Santo"
33
},
34
{
35
"iso": "GO",
36
"name": "Goiás"
37
},
38
{
39
"iso": "MA",
40
"name": "Maranhão"
41
},
42
{
43
"iso": "MG",
44
"name": "Minas Gerais"
45
},
46
{
47
"iso": "MS",
48
"name": "Mato Grosso do Sul"
49
},
50
{
51
"iso": "MT",
52
"name": "Mato Grosso"
53
},
54
{
55
"iso": "PA",
56
"name": "Pará"
57
},
58
{
59
"iso": "PB",
60
"name": "Paraíba"
61
},
62
{
63
"iso": "PE",
64
"name": "Pernambuco"
65
},
66
{
67
"iso": "PI",
68
"name": "Piauí"
69
},
70
{
71
"iso": "PR",
72
"name": "Paraná"
73
},
74
{
75
"iso": "RJ",
76
"name": "Rio de Janeiro"
77
},
78
{
79
"iso": "RN",
80
"name": "Rio Grande do Norte"
81
},
82
{
83
"iso": "RO",
84
"name": "Rondônia"
85
},
86
{
87
"iso": "RR",
88
"name": "Roraima"
89
},
90
{
91
"iso": "RS",
92
"name": "Rio Grande do Sul"
93
},
94
{
95
"iso": "SC",
96
"name": "Santa Catarina"
97
},
98
{
99
"iso": "SE",
100
"name": "Sergipe"
101
},
102
{
103
"iso": "SP",
104
"name": "São Paulo"
105
},
106
{
107
"iso": "TO",
108
"name": "Tocantins"
109
}
110
]
Copied!
1
[
2
{
3
"iso": "AMA",
4
"name": "Amazonas"
5
},
6
{
7
"iso": "ANT",
8
"name": "Antioquia"
9
},
10
{
11
"iso": "ARA",
12
"name": "Arauca"
13
},
14
{
15
"iso": "ATL",
16
"name": "Atlántico"
17
},
18
{
19
"iso": "BOL",
20
"name": "Bolívar"
21
},
22
{
23
"iso": "BOY",
24
"name": "Boyacá"
25
},
26
{
27
"iso": "CAL",
28
"name": "Caldas"
29
},
30
{
31
"iso": "CAQ",
32
"name": "Caquetá"
33
},
34
{
35
"iso": "CAS",
36
"name": "Casanare"
37
},
38
{
39
"iso": "CAU",
40
"name": "Cauca"
41
},
42
{
43
"iso": "CES",
44
"name": "Cesar"
45
},
46
{
47
"iso": "CHO",
48
"name": "Chocó"
49
},
50
{
51
"iso": "COR",
52
"name": "Córdoba"
53
},
54
{
55
"iso": "CUN",
56
"name": "Cundinamarca"
57
},
58
{
59
"iso": "GUA",
60
"name": "Guainía"
61
},
62
{
63
"iso": "GUV",
64
"name": "Guaviare"
65
},
66
{
67
"iso": "HUI",
68
"name": "Huila"
69
},
70
{
71
"iso": "LAG",
72
"name": "La Guajira"
73
},
74
{
75
"iso": "MAG",
76
"name": "Magdalena"
77
},
78
{
79
"iso": "MET",
80
"name": "Meta"
81
},
82
{
83
"iso": "NAR",
84
"name": "Nariño"
85
},
86
{
87
"iso": "NSA",
88
"name": "Norte de Santander"
89
},
90
{
91
"iso": "PUT",
92
"name": "Putumayo"
93
},
94
{
95
"iso": "QUI",
96
"name": "Quindío"
97
},
98
{
99
"iso": "RIS",
100
"name": "Risaralda"
101
},
102
{
103
"iso": "SAN",
104
"name": "Santander"
105
},
106
{
107
"iso": "SAP",
108
"name": "San Andrés y Providencia"
109
},
110
{
111
"iso": "SUC",
112
"name": "Sucre"
113
},
114
{
115
"iso": "TOL",
116
"name": "Tolima"
117
},
118
{
119
"iso": "VAC",
120
"name": "Valle del Cauca"
121
},
122
{
123
"iso": "VAU",
124
"name": "Vaupés"
125
},
126
{
127
"iso": "VID",
128
"name": "Vichada"
129
}
130
]
Copied!

Response fields

Field
Format
Description
iso
String (length between 1 and 3)
State code in ISO 3166-2 format. It is the value you must send in the payer.address.state field of the Deposits requests
name
String
Name of the State