Skip to content

Miscellaneous

AsyncMiscellaneous

Bases: BaseAsyncAPI

Provides a wrapper for paystack Miscellaneous API

The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs. https://paystack.com/docs/api/miscellaneous/

Source code in src/pypaystack2/api/miscellaneous.py 
 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
class AsyncMiscellaneous(BaseAsyncAPI):
    """Provides a wrapper for paystack Miscellaneous API

    The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs.
    https://paystack.com/docs/api/miscellaneous/
    """

    async def get_banks(
        self,
        country: Country,
        use_cursor: bool = False,
        next: Optional[str] = None,
        previous: Optional[str] = None,
        gateway: Optional[Gateway] = None,
        type: Optional[BankType] = None,
        currency: Optional[Currency] = None,
        pay_with_bank_transfer: Optional[bool] = None,
        pay_with_bank: Optional[bool] = None,
        pagination: int = 50,
    ) -> Response:
        """Get a list of all supported banks and their properties

        Args:
            country: The country from which to obtain the list of supported banks. any value from the ``Country`` enum.
            use_cursor: Flag to enable cursor pagination.
            next: A cursor that indicates your place in the list. It can be used to fetch the next page of the list
            previous: A cursor that indicates your place in the list. It should be used
                to fetch the previous page of the list after an intial next request
            gateway: The gateway type of the bank. Any value from the ``Gateway`` enum.
            type: Type of financial channel. For Ghanaian channels, please use either
                mobile_money for mobile money channels OR ghipps for bank channels
            currency: Any value from the Currency enum.
            pay_with_bank_transfer: A flag to filter for available banks a customer can make a transfer to
                complete a payment
            pay_with_bank: A flag to filter for banks a customer can pay directly from
            pagination: The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        country = Country.get_full(country)
        url = self._parse_url(f"/bank?perPage={pagination}")
        query_params = [
            ("country", country),
            ("use_cursor", use_cursor),
            ("next", next),
            ("previous", previous),
            ("gateway", gateway),
            ("type", type),
            ("currency", currency),
            ("pay_with_bank_transfer", pay_with_bank_transfer),
            ("pay_with_bank", pay_with_bank),
        ]
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_countries(self) -> Response:
        """Gets a list of Countries that Paystack currently supports

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/country")
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_states(self, country: Country) -> Response:
        """Get a list of states for a country for address verification.

        Args:
            country: Any value from the country enum.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/address_verification/states?country={country}")
        return await self._handle_request(HTTPMethod.GET, url)

get_banks(country, use_cursor=False, next=None, previous=None, gateway=None, type=None, currency=None, pay_with_bank_transfer=None, pay_with_bank=None, pagination=50) async

Get a list of all supported banks and their properties

Parameters:

Name Type Description Default
country Country

The country from which to obtain the list of supported banks. any value from the Country enum.

 required
use_cursor bool

Flag to enable cursor pagination.

 False
next Optional[str]

A cursor that indicates your place in the list. It can be used to fetch the next page of the list

 None
previous Optional[str]

A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request

 None
gateway Optional[Gateway]

The gateway type of the bank. Any value from the Gateway enum.

 None
type Optional[BankType]

Type of financial channel. For Ghanaian channels, please use either mobile_money for mobile money channels OR ghipps for bank channels

 None
currency Optional[Currency]

Any value from the Currency enum.

 None
pay_with_bank_transfer Optional[bool]

A flag to filter for available banks a customer can make a transfer to complete a payment

 None
pay_with_bank Optional[bool]

A flag to filter for banks a customer can pay directly from

 None
pagination int

The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

 50

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
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
async def get_banks(
    self,
    country: Country,
    use_cursor: bool = False,
    next: Optional[str] = None,
    previous: Optional[str] = None,
    gateway: Optional[Gateway] = None,
    type: Optional[BankType] = None,
    currency: Optional[Currency] = None,
    pay_with_bank_transfer: Optional[bool] = None,
    pay_with_bank: Optional[bool] = None,
    pagination: int = 50,
) -> Response:
    """Get a list of all supported banks and their properties

    Args:
        country: The country from which to obtain the list of supported banks. any value from the ``Country`` enum.
        use_cursor: Flag to enable cursor pagination.
        next: A cursor that indicates your place in the list. It can be used to fetch the next page of the list
        previous: A cursor that indicates your place in the list. It should be used
            to fetch the previous page of the list after an intial next request
        gateway: The gateway type of the bank. Any value from the ``Gateway`` enum.
        type: Type of financial channel. For Ghanaian channels, please use either
            mobile_money for mobile money channels OR ghipps for bank channels
        currency: Any value from the Currency enum.
        pay_with_bank_transfer: A flag to filter for available banks a customer can make a transfer to
            complete a payment
        pay_with_bank: A flag to filter for banks a customer can pay directly from
        pagination: The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    country = Country.get_full(country)
    url = self._parse_url(f"/bank?perPage={pagination}")
    query_params = [
        ("country", country),
        ("use_cursor", use_cursor),
        ("next", next),
        ("previous", previous),
        ("gateway", gateway),
        ("type", type),
        ("currency", currency),
        ("pay_with_bank_transfer", pay_with_bank_transfer),
        ("pay_with_bank", pay_with_bank),
    ]
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

get_countries() async

Gets a list of Countries that Paystack currently supports

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
153
154
155
156
157
158
159
160
161
async def get_countries(self) -> Response:
    """Gets a list of Countries that Paystack currently supports

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/country")
    return await self._handle_request(HTTPMethod.GET, url)

get_states(country) async

Get a list of states for a country for address verification.

Parameters:

Name Type Description Default
country Country

Any value from the country enum.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
163
164
165
166
167
168
169
170
171
172
173
174
async def get_states(self, country: Country) -> Response:
    """Get a list of states for a country for address verification.

    Args:
        country: Any value from the country enum.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/address_verification/states?country={country}")
    return await self._handle_request(HTTPMethod.GET, url)

Miscellaneous

Bases: BaseAPI

Provides a wrapper for paystack Miscellaneous API

The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs. https://paystack.com/docs/api/miscellaneous/

Source code in src/pypaystack2/api/miscellaneous.py 
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
class Miscellaneous(BaseAPI):
    """Provides a wrapper for paystack Miscellaneous API

    The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs.
    https://paystack.com/docs/api/miscellaneous/
    """

    def get_banks(
        self,
        country: Country,
        use_cursor: bool = False,
        next: Optional[str] = None,
        previous: Optional[str] = None,
        gateway: Optional[Gateway] = None,
        type: Optional[BankType] = None,
        currency: Optional[Currency] = None,
        pay_with_bank_transfer: Optional[bool] = None,
        pay_with_bank: Optional[bool] = None,
        pagination: int = 50,
    ) -> Response:
        """Get a list of all supported banks and their properties

        Args:
            country: The country from which to obtain the list of supported banks. any value from the ``Country`` enum.
            use_cursor: Flag to enable cursor pagination.
            next: A cursor that indicates your place in the list. It can be used to fetch the next page of the list
            previous: A cursor that indicates your place in the list. It should be used
                to fetch the previous page of the list after an intial next request
            gateway: The gateway type of the bank. Any value from the ``Gateway`` enum.
            type: Type of financial channel. For Ghanaian channels, please use either
                mobile_money for mobile money channels OR ghipps for bank channels
            currency: Any value from the Currency enum.
            pay_with_bank_transfer: A flag to filter for available banks a customer can make a transfer to
                complete a payment
            pay_with_bank: A flag to filter for banks a customer can pay directly from
            pagination: The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        country = Country.get_full(country)
        url = self._parse_url(f"/bank?perPage={pagination}")
        query_params = [
            ("country", country),
            ("use_cursor", use_cursor),
            ("next", next),
            ("previous", previous),
            ("gateway", gateway),
            ("type", type),
            ("currency", currency),
            ("pay_with_bank_transfer", pay_with_bank_transfer),
            ("pay_with_bank", pay_with_bank),
        ]
        url = append_query_params(query_params, url)
        return self._handle_request(HTTPMethod.GET, url)

    def get_countries(self) -> Response:
        """Gets a list of Countries that Paystack currently supports

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/country")
        return self._handle_request(HTTPMethod.GET, url)

    def get_states(self, country: Country) -> Response:
        """Get a list of states for a country for address verification.

        Args:
            country: Any value from the country enum.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/address_verification/states?country={country}")
        return self._handle_request(HTTPMethod.GET, url)

get_banks(country, use_cursor=False, next=None, previous=None, gateway=None, type=None, currency=None, pay_with_bank_transfer=None, pay_with_bank=None, pagination=50)

Get a list of all supported banks and their properties

Parameters:

Name Type Description Default
country Country

The country from which to obtain the list of supported banks. any value from the Country enum.

 required
use_cursor bool

Flag to enable cursor pagination.

 False
next Optional[str]

A cursor that indicates your place in the list. It can be used to fetch the next page of the list

 None
previous Optional[str]

A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request

 None
gateway Optional[Gateway]

The gateway type of the bank. Any value from the Gateway enum.

 None
type Optional[BankType]

Type of financial channel. For Ghanaian channels, please use either mobile_money for mobile money channels OR ghipps for bank channels

 None
currency Optional[Currency]

Any value from the Currency enum.

 None
pay_with_bank_transfer Optional[bool]

A flag to filter for available banks a customer can make a transfer to complete a payment

 None
pay_with_bank Optional[bool]

A flag to filter for banks a customer can pay directly from

 None
pagination int

The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

 50

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
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
def get_banks(
    self,
    country: Country,
    use_cursor: bool = False,
    next: Optional[str] = None,
    previous: Optional[str] = None,
    gateway: Optional[Gateway] = None,
    type: Optional[BankType] = None,
    currency: Optional[Currency] = None,
    pay_with_bank_transfer: Optional[bool] = None,
    pay_with_bank: Optional[bool] = None,
    pagination: int = 50,
) -> Response:
    """Get a list of all supported banks and their properties

    Args:
        country: The country from which to obtain the list of supported banks. any value from the ``Country`` enum.
        use_cursor: Flag to enable cursor pagination.
        next: A cursor that indicates your place in the list. It can be used to fetch the next page of the list
        previous: A cursor that indicates your place in the list. It should be used
            to fetch the previous page of the list after an intial next request
        gateway: The gateway type of the bank. Any value from the ``Gateway`` enum.
        type: Type of financial channel. For Ghanaian channels, please use either
            mobile_money for mobile money channels OR ghipps for bank channels
        currency: Any value from the Currency enum.
        pay_with_bank_transfer: A flag to filter for available banks a customer can make a transfer to
            complete a payment
        pay_with_bank: A flag to filter for banks a customer can pay directly from
        pagination: The number of objects to return per page. Defaults to 50, and limited to 100 records per page.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    country = Country.get_full(country)
    url = self._parse_url(f"/bank?perPage={pagination}")
    query_params = [
        ("country", country),
        ("use_cursor", use_cursor),
        ("next", next),
        ("previous", previous),
        ("gateway", gateway),
        ("type", type),
        ("currency", currency),
        ("pay_with_bank_transfer", pay_with_bank_transfer),
        ("pay_with_bank", pay_with_bank),
    ]
    url = append_query_params(query_params, url)
    return self._handle_request(HTTPMethod.GET, url)

get_countries()

Gets a list of Countries that Paystack currently supports

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
72
73
74
75
76
77
78
79
80
def get_countries(self) -> Response:
    """Gets a list of Countries that Paystack currently supports

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/country")
    return self._handle_request(HTTPMethod.GET, url)

get_states(country)

Get a list of states for a country for address verification.

Parameters:

Name Type Description Default
country Country

Any value from the country enum.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/miscellaneous.py 
82
83
84
85
86
87
88
89
90
91
92
93
def get_states(self, country: Country) -> Response:
    """Get a list of states for a country for address verification.

    Args:
        country: Any value from the country enum.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/address_verification/states?country={country}")
    return self._handle_request(HTTPMethod.GET, url)