Skip to content

Transfers control

AsyncTransferControl

Bases: BaseAsyncAPI

Provides a wrapper for paystack Transfers Control API

The Transfer Control API allows you to manage settings of your transfers. https://paystack.com/docs/api/transfer-control/

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

    The Transfer Control API allows you to manage settings of your transfers.
    https://paystack.com/docs/api/transfer-control/
    """

    async def check_balance(self) -> Response:
        """Fetch the available balance on your integration

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/balance")
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_balance_ledger(self) -> Response:
        """Fetch all pay-ins and pay-outs that occured on your integration

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("balance/ledger")
        return await self._handle_request(HTTPMethod.GET, url)

    async def resend_otp(self, transfer_code: str, reason: Reason) -> Response:
        """
        Generates a new OTP and sends to customer in the event they are having trouble receiving one.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Args:
            transfer_code: Transfer code
            reason: Any value from the ``Reason`` enum

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        payload = {"transfer_code": transfer_code, "reason": reason}
        url = self._parse_url("/transfer/resend_otp")
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def disable_otp(self) -> Response:
        """
        This is used in the event that you want to be able to complete transfers
        programmatically without use of OTPs. No arguments required. You will get
        an OTP to complete the request

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/transfer/disable_otp")
        return await self._handle_request(HTTPMethod.POST, url)

    async def finalize_disable_otp(self, otp: str) -> Response:
        """Finalize the request to disable OTP on your transfers.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Args:
            otp: One time password

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        payload = {"otp": otp}
        url = self._parse_url("/transfer/disable_otp_finalize")
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def enable_otp(self) -> Response:
        """
        In the event that a customer wants to stop being able to complete transfers
        programmatically, this endpoint helps turn OTP requirement back on. No
        arguments required.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/transfer/enable_otp")
        return await self._handle_request(HTTPMethod.POST, url)

check_balance() async

Fetch the available balance on your integration

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
107
108
109
110
111
112
113
114
async def check_balance(self) -> Response:
    """Fetch the available balance on your integration

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/balance")
    return await self._handle_request(HTTPMethod.GET, url)

disable_otp() async

This is used in the event that you want to be able to complete transfers programmatically without use of OTPs. No arguments required. You will get an OTP to complete the request

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
async def disable_otp(self) -> Response:
    """
    This is used in the event that you want to be able to complete transfers
    programmatically without use of OTPs. No arguments required. You will get
    an OTP to complete the request

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/transfer/disable_otp")
    return await self._handle_request(HTTPMethod.POST, url)

enable_otp() async

In the event that a customer wants to stop being able to complete transfers programmatically, this endpoint helps turn OTP requirement back on. No arguments required.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
async def enable_otp(self) -> Response:
    """
    In the event that a customer wants to stop being able to complete transfers
    programmatically, this endpoint helps turn OTP requirement back on. No
    arguments required.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/transfer/enable_otp")
    return await self._handle_request(HTTPMethod.POST, url)

finalize_disable_otp(otp) async

Finalize the request to disable OTP on your transfers.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Parameters:

Name Type Description Default
otp str

One time password

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
async def finalize_disable_otp(self, otp: str) -> Response:
    """Finalize the request to disable OTP on your transfers.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Args:
        otp: One time password

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    payload = {"otp": otp}
    url = self._parse_url("/transfer/disable_otp_finalize")
    return await self._handle_request(HTTPMethod.POST, url, payload)

get_balance_ledger() async

Fetch all pay-ins and pay-outs that occured on your integration

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
116
117
118
119
120
121
122
123
async def get_balance_ledger(self) -> Response:
    """Fetch all pay-ins and pay-outs that occured on your integration

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("balance/ledger")
    return await self._handle_request(HTTPMethod.GET, url)

resend_otp(transfer_code, reason) async

Generates a new OTP and sends to customer in the event they are having trouble receiving one.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Parameters:

Name Type Description Default
transfer_code str

Transfer code

 required
reason Reason

Any value from the Reason enum

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
async def resend_otp(self, transfer_code: str, reason: Reason) -> Response:
    """
    Generates a new OTP and sends to customer in the event they are having trouble receiving one.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Args:
        transfer_code: Transfer code
        reason: Any value from the ``Reason`` enum

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    payload = {"transfer_code": transfer_code, "reason": reason}
    url = self._parse_url("/transfer/resend_otp")
    return await self._handle_request(HTTPMethod.POST, url, payload)

TransferControl

Bases: BaseAPI

Provides a wrapper for paystack Transfers Control API

The Transfer Control API allows you to manage settings of your transfers. https://paystack.com/docs/api/transfer-control/

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

    The Transfer Control API allows you to manage settings of your transfers.
    https://paystack.com/docs/api/transfer-control/
    """

    def check_balance(self) -> Response:
        """Fetch the available balance on your integration

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/balance")
        return self._handle_request(HTTPMethod.GET, url)

    def get_balance_ledger(self) -> Response:
        """Fetch all pay-ins and pay-outs that occured on your integration

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/balance/ledger")
        print(url)
        return self._handle_request(HTTPMethod.GET, url)

    def resend_otp(self, transfer_code: str, reason: Reason) -> Response:
        """
        Generates a new OTP and sends to customer in the event they are having trouble receiving one.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Args:
            transfer_code: Transfer code
            reason: Any value from the ``Reason`` enum

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        payload = {"transfer_code": transfer_code, "reason": reason}
        url = self._parse_url("/transfer/resend_otp")
        return self._handle_request(HTTPMethod.POST, url, payload)

    def disable_otp(self) -> Response:
        """
        This is used in the event that you want to be able to complete transfers
        programmatically without use of OTPs. No arguments required. You will get
        an OTP to complete the request

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/transfer/disable_otp")
        return self._handle_request(HTTPMethod.POST, url)

    def finalize_disable_otp(self, otp: str) -> Response:
        """Finalize the request to disable OTP on your transfers.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Args:
            otp: One time password

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        payload = {"otp": otp}
        url = self._parse_url("/transfer/disable_otp_finalize")
        return self._handle_request(HTTPMethod.POST, url, payload)

    def enable_otp(self) -> Response:
        """
        In the event that a customer wants to stop being able to complete transfers
        programmatically, this endpoint helps turn OTP requirement back on. No
        arguments required.

        Note:
            Feature Availability
                This feature is only available to businesses in Nigeria and Ghana.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url("/transfer/enable_otp")
        return self._handle_request(HTTPMethod.POST, url)

check_balance()

Fetch the available balance on your integration

Returns:

Type Description
Response

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

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/balance")
    return self._handle_request(HTTPMethod.GET, url)

disable_otp()

This is used in the event that you want to be able to complete transfers programmatically without use of OTPs. No arguments required. You will get an OTP to complete the request

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def disable_otp(self) -> Response:
    """
    This is used in the event that you want to be able to complete transfers
    programmatically without use of OTPs. No arguments required. You will get
    an OTP to complete the request

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/transfer/disable_otp")
    return self._handle_request(HTTPMethod.POST, url)

enable_otp()

In the event that a customer wants to stop being able to complete transfers programmatically, this endpoint helps turn OTP requirement back on. No arguments required.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def enable_otp(self) -> Response:
    """
    In the event that a customer wants to stop being able to complete transfers
    programmatically, this endpoint helps turn OTP requirement back on. No
    arguments required.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/transfer/enable_otp")
    return self._handle_request(HTTPMethod.POST, url)

finalize_disable_otp(otp)

Finalize the request to disable OTP on your transfers.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Parameters:

Name Type Description Default
otp str

One time password

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def finalize_disable_otp(self, otp: str) -> Response:
    """Finalize the request to disable OTP on your transfers.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Args:
        otp: One time password

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    payload = {"otp": otp}
    url = self._parse_url("/transfer/disable_otp_finalize")
    return self._handle_request(HTTPMethod.POST, url, payload)

get_balance_ledger()

Fetch all pay-ins and pay-outs that occured on your integration

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
21
22
23
24
25
26
27
28
29
def get_balance_ledger(self) -> Response:
    """Fetch all pay-ins and pay-outs that occured on your integration

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url("/balance/ledger")
    print(url)
    return self._handle_request(HTTPMethod.GET, url)

resend_otp(transfer_code, reason)

Generates a new OTP and sends to customer in the event they are having trouble receiving one.

Note

Feature Availability This feature is only available to businesses in Nigeria and Ghana.

Parameters:

Name Type Description Default
transfer_code str

Transfer code

 required
reason Reason

Any value from the Reason enum

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers_control.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def resend_otp(self, transfer_code: str, reason: Reason) -> Response:
    """
    Generates a new OTP and sends to customer in the event they are having trouble receiving one.

    Note:
        Feature Availability
            This feature is only available to businesses in Nigeria and Ghana.

    Args:
        transfer_code: Transfer code
        reason: Any value from the ``Reason`` enum

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    payload = {"transfer_code": transfer_code, "reason": reason}
    url = self._parse_url("/transfer/resend_otp")
    return self._handle_request(HTTPMethod.POST, url, payload)