Skip to content

Gift card

GiftCard

Bases: BaseAPIWrapper

Source code in pykuda2/wrappers/sync_wrappers/gift_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
class GiftCard(BaseAPIWrapper):
    def get_gift_cards(self, request_reference: Optional[str] = None) -> APIResponse:
        """Retrieves a curated list of gift cards supported by Kuda.

        Args:
            request_reference: a unique identifier for this api call.
                it is automatically generated if not provided.

        Returns:
            An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
                of calling this function.

        Raises:
            ConnectionException: when the request times out or in the absence of an internet connection.
        """
        return self._api_call(
            service_type=ServiceType.GET_GIFT_CARD, request_reference=request_reference
        )

    def purchase_gift_card(
        self,
        amount: Union[int, float],
        customer_name: str,
        customer_mobile: str,
        customer_email: str,
        biller_identifier: str,
        note: Optional[str] = None,
        request_reference: Optional[str] = None,
    ) -> APIResponse:
        """Buy gift cards from the admin account

        Args:
            amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
                a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
                it is advisable that static values are passed for this parameter. see
                https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
            customer_name: Name of the customer receiving the gift card.
            customer_mobile: Mobile number of customer.
            customer_email: The email address of customer.
            biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
                `self.gift_cards`.
            note: An optional gift card note.
            request_reference: a unique identifier for this api call.
                it is automatically generated if not provided.

        Returns:
            An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
                of calling this function.

        Raises:
            ConnectionException: when the request times out or in the absence of an internet connection.
        """
        data = {
            "amount": amount,
            "requestingCustomerName": customer_name,
            "requestingCustomerMobile": customer_mobile,
            "requestingCustomerEmail": customer_email,
            "billerIdentifier": biller_identifier,
            "note": note,
        }
        return self._api_call(
            service_type=ServiceType.ADMIN_BUY_GIFT_CARD,
            data=data,
            request_reference=request_reference,
        )

    def purchase_gift_card_from_virtual_account(
        self,
        tracking_reference: str,
        amount: Union[int, float],
        customer_name: str,
        customer_mobile: str,
        customer_email: str,
        biller_identifier: str,
        note: Optional[str] = None,
        request_reference: Optional[str] = None,
    ) -> APIResponse:
        """Buy gift cards from the virtual account.

        Args:
            tracking_reference: The unique identifier of the virtual account.
            amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
                a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
                it is advisable that static values are passed for this parameter. see
                https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
            customer_name: Name of the customer receiving the gift card.
            customer_mobile: Mobile number of customer.
            customer_email: The email address of customer.
            biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
                `self.gift_cards`.
            note: An optional gift card note.
            request_reference: a unique identifier for this api call.
                it is automatically generated if not provided.

        Returns:
            An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
                of calling this function.

        Raises:
            ConnectionException: when the request times out or in the absence of an internet connection.
        """
        data = {
            "trackingReference": tracking_reference,
            "amount": amount,
            "requestingCustomerName": customer_name,
            "requestingCustomerMobile": customer_mobile,
            "requestingCustomerEmail": customer_email,
            "billerIdentifier": biller_identifier,
            "note": note,
        }
        return self._api_call(
            service_type=ServiceType.BUY_GIFT_CARD,
            data=data,
            request_reference=request_reference,
        )

    def get_gift_card_status(
        self,
        tracking_reference: str,
        amount: Union[int, float],
        customer_name: str,
        customer_mobile: str,
        customer_email: str,
        biller_identifier: str,
        note: Optional[str] = None,
        request_reference: Optional[str] = None,
    ) -> APIResponse:
        """Retrieves the status of all gift cards purchased.

        Args:
            tracking_reference: The unique identifier of the virtual account.
            amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
                a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
                it is advisable that static values are passed for this parameter. see
                https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
            customer_name: Name of the customer receiving the gift card.
            customer_mobile: Mobile number of customer.
            customer_email: The email address of customer.
            biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
                `self.gift_cards`.
            note: An optional gift card note.
            request_reference: a unique identifier for this api call.
                it is automatically generated if not provided.

        Returns:
            An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
                of calling this function.

        Raises:
            ConnectionException: when the request times out or in the absence of an internet connection.
        """
        data = {
            "trackingReference": tracking_reference,
            "amount": amount,
            "requestingCustomerName": customer_name,
            "requestingCustomerMobile": customer_mobile,
            "requestingCustomerEmail": customer_email,
            "billerIdentifier": biller_identifier,
            "note": note,
        }
        return self._api_call(
            service_type=ServiceType.GIFT_CARD_TSQ,
            data=data,
            request_reference=request_reference,
        )

get_gift_card_status(tracking_reference, amount, customer_name, customer_mobile, customer_email, biller_identifier, note=None, request_reference=None)

Retrieves the status of all gift cards purchased.

Parameters:

Name Type Description Default
tracking_reference str

The unique identifier of the virtual account.

 required
amount Union[int, float]

The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved. a Decimal would have been the preferred type compared to Union[int, float] that was used. it is advisable that static values are passed for this parameter. see https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency

 required
customer_name str

Name of the customer receiving the gift card.

 required
customer_mobile str

Mobile number of customer.

 required
customer_email str

The email address of customer.

 required
biller_identifier str

The Biller ID or identifier. You can find it in the APIResponse of self.gift_cards.

 required
note Optional[str]

An optional gift card note.

 None
request_reference Optional[str]

a unique identifier for this api call. it is automatically generated if not provided.

 None

Returns:

Type Description
APIResponse

An APIResponse which is basically just a dataclass containing the data returned by the server as result of calling this function.

Raises:

Type Description
ConnectionException

when the request times out or in the absence of an internet connection.
Source code in pykuda2/wrappers/sync_wrappers/gift_card.py 
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
def get_gift_card_status(
    self,
    tracking_reference: str,
    amount: Union[int, float],
    customer_name: str,
    customer_mobile: str,
    customer_email: str,
    biller_identifier: str,
    note: Optional[str] = None,
    request_reference: Optional[str] = None,
) -> APIResponse:
    """Retrieves the status of all gift cards purchased.

    Args:
        tracking_reference: The unique identifier of the virtual account.
        amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
            a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
            it is advisable that static values are passed for this parameter. see
            https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
        customer_name: Name of the customer receiving the gift card.
        customer_mobile: Mobile number of customer.
        customer_email: The email address of customer.
        biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
            `self.gift_cards`.
        note: An optional gift card note.
        request_reference: a unique identifier for this api call.
            it is automatically generated if not provided.

    Returns:
        An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
            of calling this function.

    Raises:
        ConnectionException: when the request times out or in the absence of an internet connection.
    """
    data = {
        "trackingReference": tracking_reference,
        "amount": amount,
        "requestingCustomerName": customer_name,
        "requestingCustomerMobile": customer_mobile,
        "requestingCustomerEmail": customer_email,
        "billerIdentifier": biller_identifier,
        "note": note,
    }
    return self._api_call(
        service_type=ServiceType.GIFT_CARD_TSQ,
        data=data,
        request_reference=request_reference,
    )

get_gift_cards(request_reference=None)

Retrieves a curated list of gift cards supported by Kuda.

Parameters:

Name Type Description Default
request_reference Optional[str]

a unique identifier for this api call. it is automatically generated if not provided.

 None

Returns:

Type Description
APIResponse

An APIResponse which is basically just a dataclass containing the data returned by the server as result of calling this function.

Raises:

Type Description
ConnectionException

when the request times out or in the absence of an internet connection.
Source code in pykuda2/wrappers/sync_wrappers/gift_card.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def get_gift_cards(self, request_reference: Optional[str] = None) -> APIResponse:
    """Retrieves a curated list of gift cards supported by Kuda.

    Args:
        request_reference: a unique identifier for this api call.
            it is automatically generated if not provided.

    Returns:
        An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
            of calling this function.

    Raises:
        ConnectionException: when the request times out or in the absence of an internet connection.
    """
    return self._api_call(
        service_type=ServiceType.GET_GIFT_CARD, request_reference=request_reference
    )

purchase_gift_card(amount, customer_name, customer_mobile, customer_email, biller_identifier, note=None, request_reference=None)

Buy gift cards from the admin account

Parameters:

Name Type Description Default
amount Union[int, float]

The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved. a Decimal would have been the preferred type compared to Union[int, float] that was used. it is advisable that static values are passed for this parameter. see https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency

 required
customer_name str

Name of the customer receiving the gift card.

 required
customer_mobile str

Mobile number of customer.

 required
customer_email str

The email address of customer.

 required
biller_identifier str

The Biller ID or identifier. You can find it in the APIResponse of self.gift_cards.

 required
note Optional[str]

An optional gift card note.

 None
request_reference Optional[str]

a unique identifier for this api call. it is automatically generated if not provided.

 None

Returns:

Type Description
APIResponse

An APIResponse which is basically just a dataclass containing the data returned by the server as result of calling this function.

Raises:

Type Description
ConnectionException

when the request times out or in the absence of an internet connection.
Source code in pykuda2/wrappers/sync_wrappers/gift_card.py 
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
def purchase_gift_card(
    self,
    amount: Union[int, float],
    customer_name: str,
    customer_mobile: str,
    customer_email: str,
    biller_identifier: str,
    note: Optional[str] = None,
    request_reference: Optional[str] = None,
) -> APIResponse:
    """Buy gift cards from the admin account

    Args:
        amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
            a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
            it is advisable that static values are passed for this parameter. see
            https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
        customer_name: Name of the customer receiving the gift card.
        customer_mobile: Mobile number of customer.
        customer_email: The email address of customer.
        biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
            `self.gift_cards`.
        note: An optional gift card note.
        request_reference: a unique identifier for this api call.
            it is automatically generated if not provided.

    Returns:
        An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
            of calling this function.

    Raises:
        ConnectionException: when the request times out or in the absence of an internet connection.
    """
    data = {
        "amount": amount,
        "requestingCustomerName": customer_name,
        "requestingCustomerMobile": customer_mobile,
        "requestingCustomerEmail": customer_email,
        "billerIdentifier": biller_identifier,
        "note": note,
    }
    return self._api_call(
        service_type=ServiceType.ADMIN_BUY_GIFT_CARD,
        data=data,
        request_reference=request_reference,
    )

purchase_gift_card_from_virtual_account(tracking_reference, amount, customer_name, customer_mobile, customer_email, biller_identifier, note=None, request_reference=None)

Buy gift cards from the virtual account.

Parameters:

Name Type Description Default
tracking_reference str

The unique identifier of the virtual account.

 required
amount Union[int, float]

The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved. a Decimal would have been the preferred type compared to Union[int, float] that was used. it is advisable that static values are passed for this parameter. see https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency

 required
customer_name str

Name of the customer receiving the gift card.

 required
customer_mobile str

Mobile number of customer.

 required
customer_email str

The email address of customer.

 required
biller_identifier str

The Biller ID or identifier. You can find it in the APIResponse of self.gift_cards.

 required
note Optional[str]

An optional gift card note.

 None
request_reference Optional[str]

a unique identifier for this api call. it is automatically generated if not provided.

 None

Returns:

Type Description
APIResponse

An APIResponse which is basically just a dataclass containing the data returned by the server as result of calling this function.

Raises:

Type Description
ConnectionException

when the request times out or in the absence of an internet connection.
Source code in pykuda2/wrappers/sync_wrappers/gift_card.py 
 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
def purchase_gift_card_from_virtual_account(
    self,
    tracking_reference: str,
    amount: Union[int, float],
    customer_name: str,
    customer_mobile: str,
    customer_email: str,
    biller_identifier: str,
    note: Optional[str] = None,
    request_reference: Optional[str] = None,
) -> APIResponse:
    """Buy gift cards from the virtual account.

    Args:
        tracking_reference: The unique identifier of the virtual account.
        amount: The gift card amount to be purchased. It could be in USD/ GBP/ EUR/ NGN/ AED , e.t.c. Note care should be taken when performing calculations as money is involved.
            a `Decimal` would have been the preferred type compared to `Union[int, float]` that was used.
            it is advisable that static values are passed for this parameter. see
            https://stackoverflow.com/questions/3730019/why-not-use-double-or-float-to-represent-currency
        customer_name: Name of the customer receiving the gift card.
        customer_mobile: Mobile number of customer.
        customer_email: The email address of customer.
        biller_identifier: The Biller ID or identifier. You can find it in the `APIResponse` of
            `self.gift_cards`.
        note: An optional gift card note.
        request_reference: a unique identifier for this api call.
            it is automatically generated if not provided.

    Returns:
        An `APIResponse` which is basically just a dataclass containing the data returned by the server as result
            of calling this function.

    Raises:
        ConnectionException: when the request times out or in the absence of an internet connection.
    """
    data = {
        "trackingReference": tracking_reference,
        "amount": amount,
        "requestingCustomerName": customer_name,
        "requestingCustomerMobile": customer_mobile,
        "requestingCustomerEmail": customer_email,
        "billerIdentifier": biller_identifier,
        "note": note,
    }
    return self._api_call(
        service_type=ServiceType.BUY_GIFT_CARD,
        data=data,
        request_reference=request_reference,
    )