Skip to content

Apple pay

ApplePay

Bases: BaseAPI

Provides a wrapper for paystack Apple Pay API

The Apple Pay API allows you to register your application's top-level domain or subdomain. see https://paystack.com/docs/api/apple-pay/

Note This feature is available to businesses in all markets except South Africa.

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

    The Apple Pay API allows you to register your application's top-level domain or subdomain.
    see https://paystack.com/docs/api/apple-pay/

    Note
      This feature is available to businesses in all markets except South Africa.
    """

    def register_domain(self, domain_name: str) -> Response:
        """Register a top-level domain or subdomain for your Apple Pay integration.

        Note
            * This method can only be called with one domain or subdomain at a time.
            * This feature is available to businesses in all markets except South Africa.


        Args:
            domain_name: Domain name to be registered.

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

        url = self._parse_url("/apple-pay/domain")
        payload = {
            "domainName": domain_name,
        }
        return self._handle_request(HTTPMethod.POST, url, payload)

    def get_domains(
        self,
        use_cursor: bool = False,
        next: Optional[str] = None,
        previous: Optional[str] = None,
    ) -> Response:
        """Fetches all registered domains on your integration.

        Note
            * This feature is available to businesses in all markets except South Africa.

        Returns:
            A named tuple containing the response gotten from paystack's server.
            An empty list in the data if no domains have been added.
        """

        url = self._parse_url("/apple-pay/domain")
        query_params = [
            ("use_cursor", use_cursor),
            ("next", next),
            ("previous", previous),
        ]
        url = append_query_params(query_params, url)
        return self._handle_request(HTTPMethod.GET, url)

    def unregister_domain(self, domain_name: str) -> Response:
        """Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

        Args:
            domain_name: Domain name to be unregistered

        Note
            * This feature is available to businesses in all markets except South Africa.

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

        url = self._parse_url("/apple-pay/domain")
        payload = {
            "domainName": domain_name,
        }
        raw_response = httpx.request(
            HTTPMethod.DELETE, url, json=payload, headers=self._headers
        )
        return (
            self._parse_response(raw_response)
            if codes.is_success(raw_response.status_code)
            else self._parse_response(raw_response, as_error=True)
        )

get_domains(use_cursor=False, next=None, previous=None)

Fetches all registered domains on your integration.

Note * This feature is available to businesses in all markets except South Africa.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Response

An empty list in the data if no domains have been added.
Source code in src/pypaystack2/api/apple_pay.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_domains(
    self,
    use_cursor: bool = False,
    next: Optional[str] = None,
    previous: Optional[str] = None,
) -> Response:
    """Fetches all registered domains on your integration.

    Note
        * This feature is available to businesses in all markets except South Africa.

    Returns:
        A named tuple containing the response gotten from paystack's server.
        An empty list in the data if no domains have been added.
    """

    url = self._parse_url("/apple-pay/domain")
    query_params = [
        ("use_cursor", use_cursor),
        ("next", next),
        ("previous", previous),
    ]
    url = append_query_params(query_params, url)
    return self._handle_request(HTTPMethod.GET, url)

register_domain(domain_name)

Register a top-level domain or subdomain for your Apple Pay integration.

Note * This method can only be called with one domain or subdomain at a time. * This feature is available to businesses in all markets except South Africa.

Parameters:

Name Type Description Default
domain_name str

Domain name to be registered.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/apple_pay.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def register_domain(self, domain_name: str) -> Response:
    """Register a top-level domain or subdomain for your Apple Pay integration.

    Note
        * This method can only be called with one domain or subdomain at a time.
        * This feature is available to businesses in all markets except South Africa.


    Args:
        domain_name: Domain name to be registered.

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

    url = self._parse_url("/apple-pay/domain")
    payload = {
        "domainName": domain_name,
    }
    return self._handle_request(HTTPMethod.POST, url, payload)

unregister_domain(domain_name)

Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

Parameters:

Name Type Description Default
domain_name str

Domain name to be unregistered

 required

Note * This feature is available to businesses in all markets except South Africa.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/apple_pay.py 
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
def unregister_domain(self, domain_name: str) -> Response:
    """Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

    Args:
        domain_name: Domain name to be unregistered

    Note
        * This feature is available to businesses in all markets except South Africa.

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

    url = self._parse_url("/apple-pay/domain")
    payload = {
        "domainName": domain_name,
    }
    raw_response = httpx.request(
        HTTPMethod.DELETE, url, json=payload, headers=self._headers
    )
    return (
        self._parse_response(raw_response)
        if codes.is_success(raw_response.status_code)
        else self._parse_response(raw_response, as_error=True)
    )

AsyncApplePay

Bases: BaseAsyncAPI

Provides a wrapper for paystack Apple Pay API

The Apple Pay API allows you to register your application's top-level domain or subdomain. Visit paystack api doc

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

    The Apple Pay API allows you to register your application's top-level domain or subdomain.
    [Visit paystack api doc](https://paystack.com/docs/api/apple-pay/)
    """

    async def register_domain(self, domain_name: str) -> Response:
        """Register a top-level domain or subdomain for your Apple Pay integration.

        This method can only be called with one domain or subdomain at a time.

        Args:
            domain_name: Domain name to be registered.

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

        url = self._parse_url("/apple-pay/domain")
        payload = {
            "domainName": domain_name,
        }
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def get_domains(
        self,
        use_cursor: bool = False,
        next: Optional[str] = None,
        previous: Optional[str] = None,
    ) -> Response:
        """Fetches all registered domains on your integration.

        Note
            * This feature is available to businesses in all markets except South Africa.

        Returns:
            A named tuple containing the response gotten from paystack's server.
            An empty list in the data if no domains have been added.
        """

        url = self._parse_url("/apple-pay/domain")
        query_params = [
            ("use_cursor", use_cursor),
            ("next", next),
            ("previous", previous),
        ]
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def unregister_domain(self, domain_name: str) -> Response:
        """Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

        Args:
             domain_name: Domain name to be unregistered

         Note
             * This feature is available to businesses in all markets except South Africa.

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

        url = self._parse_url("/apple-pay/domain")
        payload = {
            "domainName": domain_name,
        }
        async with httpx.AsyncClient() as client:
            raw_response = await client.request(
                HTTPMethod.DELETE, url, json=payload, headers=self._headers
            )
        return (
            self._parse_response(raw_response)
            if codes.is_success(raw_response.status_code)
            else self._parse_response(raw_response, as_error=True)
        )

get_domains(use_cursor=False, next=None, previous=None) async

Fetches all registered domains on your integration.

Note * This feature is available to businesses in all markets except South Africa.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Response

An empty list in the data if no domains have been added.
Source code in src/pypaystack2/api/apple_pay.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
async def get_domains(
    self,
    use_cursor: bool = False,
    next: Optional[str] = None,
    previous: Optional[str] = None,
) -> Response:
    """Fetches all registered domains on your integration.

    Note
        * This feature is available to businesses in all markets except South Africa.

    Returns:
        A named tuple containing the response gotten from paystack's server.
        An empty list in the data if no domains have been added.
    """

    url = self._parse_url("/apple-pay/domain")
    query_params = [
        ("use_cursor", use_cursor),
        ("next", next),
        ("previous", previous),
    ]
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

register_domain(domain_name) async

Register a top-level domain or subdomain for your Apple Pay integration.

This method can only be called with one domain or subdomain at a time.

Parameters:

Name Type Description Default
domain_name str

Domain name to be registered.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/apple_pay.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
async def register_domain(self, domain_name: str) -> Response:
    """Register a top-level domain or subdomain for your Apple Pay integration.

    This method can only be called with one domain or subdomain at a time.

    Args:
        domain_name: Domain name to be registered.

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

    url = self._parse_url("/apple-pay/domain")
    payload = {
        "domainName": domain_name,
    }
    return await self._handle_request(HTTPMethod.POST, url, payload)

unregister_domain(domain_name) async

Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

Parameters:

Name Type Description Default
domain_name str

Domain name to be unregistered

 required

Note * This feature is available to businesses in all markets except South Africa.

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

Source code in src/pypaystack2/api/apple_pay.py 
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
async def unregister_domain(self, domain_name: str) -> Response:
    """Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

    Args:
         domain_name: Domain name to be unregistered

     Note
         * This feature is available to businesses in all markets except South Africa.

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

    url = self._parse_url("/apple-pay/domain")
    payload = {
        "domainName": domain_name,
    }
    async with httpx.AsyncClient() as client:
        raw_response = await client.request(
            HTTPMethod.DELETE, url, json=payload, headers=self._headers
        )
    return (
        self._parse_response(raw_response)
        if codes.is_success(raw_response.status_code)
        else self._parse_response(raw_response, as_error=True)
    )