Skip to content

Integration

AsyncIntegration

Bases: BaseAsyncAPI

Provides a wrapper for paystack Integration API

The Integration API allows you to manage some settings on your integration. https://paystack.com/docs/api/integration/

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

    The Integration API allows you to manage some settings on your integration.
    https://paystack.com/docs/api/integration/
    """

    async def get_payment_session_timeout(self) -> Response:
        """Fetch the payment session timeout on your integration

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

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

    async def update_payment_session_timeout(self, timeout: int) -> Response:
        """Update the payment session timeout on your integration

        Args:
            timeout: Time before stopping session (in seconds). Set to 0 to cancel session timeouts

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

        payload = {"timeout": timeout}
        url = self._parse_url("/integration/payment_session_timeout")
        return await self._handle_request(HTTPMethod.PUT, url, payload)

get_payment_session_timeout() async

Fetch the payment session timeout on your integration

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/integration.py 
44
45
46
47
48
49
50
51
52
async def get_payment_session_timeout(self) -> Response:
    """Fetch the payment session timeout on your integration

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

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

update_payment_session_timeout(timeout) async

Update the payment session timeout on your integration

Parameters:

Name Type Description Default
timeout int

Time before stopping session (in seconds). Set to 0 to cancel session timeouts

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/integration.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
async def update_payment_session_timeout(self, timeout: int) -> Response:
    """Update the payment session timeout on your integration

    Args:
        timeout: Time before stopping session (in seconds). Set to 0 to cancel session timeouts

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

    payload = {"timeout": timeout}
    url = self._parse_url("/integration/payment_session_timeout")
    return await self._handle_request(HTTPMethod.PUT, url, payload)

Integration

Bases: BaseAPI

Provides a wrapper for paystack Integration API

The Integration API allows you to manage some settings on your integration. https://paystack.com/docs/api/integration/

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

    The Integration API allows you to manage some settings on your integration.
    https://paystack.com/docs/api/integration/
    """

    def get_payment_session_timeout(self) -> Response:
        """Fetch the payment session timeout on your integration

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

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

    def update_payment_session_timeout(self, timeout: int) -> Response:
        """Update the payment session timeout on your integration

        Args:
            timeout: Time before stopping session (in seconds). Set to 0 to cancel session timeouts

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

        payload = {"timeout": timeout}
        url = self._parse_url("/integration/payment_session_timeout")
        return self._handle_request(HTTPMethod.PUT, url, payload)

get_payment_session_timeout()

Fetch the payment session timeout on your integration

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/integration.py 
12
13
14
15
16
17
18
19
20
def get_payment_session_timeout(self) -> Response:
    """Fetch the payment session timeout on your integration

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

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

update_payment_session_timeout(timeout)

Update the payment session timeout on your integration

Parameters:

Name Type Description Default
timeout int

Time before stopping session (in seconds). Set to 0 to cancel session timeouts

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/integration.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
def update_payment_session_timeout(self, timeout: int) -> Response:
    """Update the payment session timeout on your integration

    Args:
        timeout: Time before stopping session (in seconds). Set to 0 to cancel session timeouts

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

    payload = {"timeout": timeout}
    url = self._parse_url("/integration/payment_session_timeout")
    return self._handle_request(HTTPMethod.PUT, url, payload)