Card
Card
Bases: BaseAPIWrapper
Source code in pykuda2/wrappers/sync_wrappers/card.py
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
|
activate_card(pan, cvv, id, tracking_reference, simulate_request=False, request_reference=None)
Allows customers activate their cards once they receive it.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pan |
int
|
Card primary account number issued after processing. |
required |
cvv |
int
|
Card CVV. |
required |
tracking_reference |
str
|
The unique identifier of the account. |
required |
id |
int
|
Card unique identifier. |
required |
simulate_request |
bool
|
Flag to simulate request. |
False
|
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
block_card(tracking_reference, id, request_reference=None)
Block a customer's card.
It allows them to longer be able to make card transactions with it. In an emergency, a user may require to block a card in the event that the card is stolen or lost. Use this method to quickly block the card.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
int
|
Card unique identifier. |
required |
tracking_reference |
str
|
The virtual account number. |
required |
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
change_card_pin(id, tracking_reference, new_pin, request_reference=None)
Allows customers change their 4 digits PIN to any combination they desire.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
int
|
Card unique identifier. |
required |
tracking_reference |
str
|
The virtual account number. |
required |
new_pin |
int
|
Customer's new PIN. |
required |
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
deactivate_card(id, tracking_reference, simulate_request=False, request_reference=None)
Allows customers deactivate their cards.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tracking_reference |
str
|
The unique identifier of the account. |
required |
id |
int
|
Card unique identifier. |
required |
simulate_request |
bool
|
Flag to simulate request. |
False
|
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
get_cards(tracking_reference, simulate_request=False, request_reference=None)
Retrieves a list of cards requested.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tracking_reference |
str
|
The unique identifier of the account. |
required |
simulate_request |
bool
|
Flag to simulate request. |
False
|
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
manage_card_channel(id, tracking_reference, channel, limit, simulate_request=False, request_reference=None)
Allows customers manage where their cards can be used.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
int
|
Card unique identifier. |
required |
tracking_reference |
str
|
The virtual account number. |
required |
channel |
CardChannel
|
Card channels e.g. CardChannel.ATM, CardChannel.POS. |
required |
limit |
int
|
Transaction amount limit in kobo. |
required |
simulate_request |
bool
|
Flag to simulate request. |
False
|
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
request_card(tracking_reference, name_on_card, country, gender, additional_phone_number, delivery_city, delivery_lga, delivery_landmark, date_of_birth, delivery_state, delivery_street_no_and_name, request_reference=None)
Request for a new card for a customer and get it delivered to their location.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tracking_reference |
str
|
The unique identifier of the virtual account. |
required |
name_on_card |
str
|
The virtual account name. |
required |
date_of_birth |
str
|
The customer's date of birth. Format(YYYY-MM-DD). |
required |
gender |
Gender
|
Customer's gender e.g. Gender.MALE, Gender.FEMALE. |
required |
delivery_state |
str
|
The state of residence for card delivery. |
required |
delivery_street_no_and_name |
str
|
The street no and name for card delivery. |
required |
delivery_city |
str
|
Name of city for card delivery. |
required |
delivery_lga |
str
|
Local government area for card delivery |
required |
delivery_landmark |
str
|
Landmark for card delivery. |
required |
country |
str
|
Country of residence for card delivery. |
required |
additional_phone_number |
str
|
additional phone number. |
required |
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
set_card_limit(id, tracking_reference, channel, limit, simulate_request=False, request_reference=None)
Set spend limit on a card.
Card limits are a good way to manage individual spend on their accounts. There are use cases for this, especially in the edtech space where an individual will like to manage spending limits or even in the contracting space where clients want to manage spend limits on purchases. - A good way to start this is to manage where and how these limits can be set and across the channels the card can be accessed.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
int
|
Card unique identifier. |
required |
tracking_reference |
str
|
The virtual account number. |
required |
channel |
CardChannel
|
Card channels e.g. CardChannel.ATM, CardChannel.POS. |
required |
limit |
int
|
Transaction amount limit in kobo. |
required |
simulate_request |
bool
|
Flag to simulate request. |
False
|
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |
Source code in pykuda2/wrappers/sync_wrappers/card.py
unblock_card(tracking_reference, id, request_reference=None)
Unblocks a customers card.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
int
|
Card unique identifier. |
required |
tracking_reference |
str
|
The virtual account number. |
required |
request_reference |
Optional[str]
|
a unique identifier for this api call. it is automatically generated if not provided. |
None
|
Returns:
Type | Description |
---|---|
APIResponse
|
An |
Raises:
Type | Description |
---|---|
ConnectionException
|
when the request times out or in the absence of an internet connection. |