Skip to content

Transfers

AsyncTransfer

Bases: BaseAsyncAPI

Provides a wrapper for paystack Transfers API

The Transfers API allows you to automate sending money on your integration https://paystack.com/docs/api/transfer/

Note

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

Source code in src/pypaystack2/api/transfers.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
class AsyncTransfer(BaseAsyncAPI):
    """Provides a wrapper for paystack Transfers API

    The Transfers API allows you to automate sending money on your integration
    https://paystack.com/docs/api/transfer/

    Note
    ----
    This feature is only available to businesses in Nigeria and Ghana.
    """

    async def initiate(
        self,
        amount: int,
        recipient: str,
        reason: Optional[str] = None,
        currency: Optional[Currency] = None,
        reference: Optional[str] = None,
        source: str = "balance",
    ) -> Response:
        """Initiate transfer

        Args:
            amount: amount to transfer
            recipient: the beneficiary of the transfer
            reason: narration of the transfer
            currency: transfer currency
            reference: reference id
            source: transfer source

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        amount = validate_amount(amount)

        url = self._parse_url("/transfer")

        payload = {
            "amount": amount,
            "recipient": recipient,
            "source": source,
        }
        optional_params = [
            ("reason", reason),
            ("reference", reference),
            ("currency", currency),
        ]
        payload = add_to_payload(optional_params, payload)
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def finalize(
        self,
        transfer_code: str,
        otp: str,
    ) -> Response:
        """Finalize transfer

        Args:
            transfer_code: The code for transfer.
            otp: One time password.

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

        url = self._parse_url("/transfer/finalize_transfer")

        payload = {
            "transfer_code": transfer_code,
            "otp": otp,
        }
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def bulk_transfer(
        self, transfers: list[TransferInstruction], source: str = "balance"
    ) -> Response:
        """Transfer in bulk

        Args:
            transfers: list of transfer instructions
            source: source of the funds to transfer

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

        url = self._parse_url("/transfer/bulk")

        payload = {
            "transfers": [tx.dict for tx in transfers],
            "source": source,
        }
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def get_transfers(
        self,
        page: int = 1,
        pagination: int = 50,
        customer: Optional[str] = None,
        start_date: Optional[str] = None,
        end_date: Optional[str] = None,
    ) -> Response:
        """Retrieve transfers made to a customer

        Args:
            customer: customer id
            page: Specifies exactly what page you want to retrieve.
                If not specified, we use a default value of 1.
            pagination: Specifies how many records you want to retrieve per page.
                If not specified, we use a default value of 50.
            start_date: A timestamp from which to start listing refund e.g. 2016-09-21
            end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url(f"/transfer?perPage={pagination}")
        query_params = [
            ("customer", customer),
            ("page", page),
            ("from", start_date),
            ("to", end_date),
        ]
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_transfer(
        self,
        id_or_code: str,
    ) -> Response:
        """Retrieve a transfer

        Args:
            id_or_code: transfer ID or code

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

    async def verify(
        self,
        reference: str,
    ) -> Response:
        """Verify a transfer

        Args:
            reference: str

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

bulk_transfer(transfers, source='balance') async

Transfer in bulk

Parameters:

Name Type Description Default
transfers list[TransferInstruction]

list of transfer instructions

 required
source str

source of the funds to transfer

 'balance'

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
async def bulk_transfer(
    self, transfers: list[TransferInstruction], source: str = "balance"
) -> Response:
    """Transfer in bulk

    Args:
        transfers: list of transfer instructions
        source: source of the funds to transfer

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

    url = self._parse_url("/transfer/bulk")

    payload = {
        "transfers": [tx.dict for tx in transfers],
        "source": source,
    }
    return await self._handle_request(HTTPMethod.POST, url, payload)

finalize(transfer_code, otp) async

Finalize transfer

Parameters:

Name Type Description Default
transfer_code str

The code for transfer.

 required
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.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
async def finalize(
    self,
    transfer_code: str,
    otp: str,
) -> Response:
    """Finalize transfer

    Args:
        transfer_code: The code for transfer.
        otp: One time password.

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

    url = self._parse_url("/transfer/finalize_transfer")

    payload = {
        "transfer_code": transfer_code,
        "otp": otp,
    }
    return await self._handle_request(HTTPMethod.POST, url, payload)

get_transfer(id_or_code) async

Retrieve a transfer

Parameters:

Name Type Description Default
id_or_code str

transfer ID or code

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
298
299
300
301
302
303
304
305
306
307
308
309
310
311
async def get_transfer(
    self,
    id_or_code: str,
) -> Response:
    """Retrieve a transfer

    Args:
        id_or_code: transfer ID or code

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

get_transfers(page=1, pagination=50, customer=None, start_date=None, end_date=None) async

Retrieve transfers made to a customer

Parameters:

Name Type Description Default
customer Optional[str]

customer id

 None
page int

Specifies exactly what page you want to retrieve. If not specified, we use a default value of 1.

 1
pagination int

Specifies how many records you want to retrieve per page. If not specified, we use a default value of 50.

 50
start_date Optional[str]

A timestamp from which to start listing refund e.g. 2016-09-21

 None
end_date Optional[str]

A timestamp at which to stop listing refund e.g. 2016-09-21

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
async def get_transfers(
    self,
    page: int = 1,
    pagination: int = 50,
    customer: Optional[str] = None,
    start_date: Optional[str] = None,
    end_date: Optional[str] = None,
) -> Response:
    """Retrieve transfers made to a customer

    Args:
        customer: customer id
        page: Specifies exactly what page you want to retrieve.
            If not specified, we use a default value of 1.
        pagination: Specifies how many records you want to retrieve per page.
            If not specified, we use a default value of 50.
        start_date: A timestamp from which to start listing refund e.g. 2016-09-21
        end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url(f"/transfer?perPage={pagination}")
    query_params = [
        ("customer", customer),
        ("page", page),
        ("from", start_date),
        ("to", end_date),
    ]
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

initiate(amount, recipient, reason=None, currency=None, reference=None, source='balance') async

Initiate transfer

Parameters:

Name Type Description Default
amount int

amount to transfer

 required
recipient str

the beneficiary of the transfer

 required
reason Optional[str]

narration of the transfer

 None
currency Optional[Currency]

transfer currency

 None
reference Optional[str]

reference id

 None
source str

transfer source

 'balance'

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
async def initiate(
    self,
    amount: int,
    recipient: str,
    reason: Optional[str] = None,
    currency: Optional[Currency] = None,
    reference: Optional[str] = None,
    source: str = "balance",
) -> Response:
    """Initiate transfer

    Args:
        amount: amount to transfer
        recipient: the beneficiary of the transfer
        reason: narration of the transfer
        currency: transfer currency
        reference: reference id
        source: transfer source

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    amount = validate_amount(amount)

    url = self._parse_url("/transfer")

    payload = {
        "amount": amount,
        "recipient": recipient,
        "source": source,
    }
    optional_params = [
        ("reason", reason),
        ("reference", reference),
        ("currency", currency),
    ]
    payload = add_to_payload(optional_params, payload)
    return await self._handle_request(HTTPMethod.POST, url, payload)

verify(reference) async

Verify a transfer

Parameters:

Name Type Description Default
reference str

str

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
313
314
315
316
317
318
319
320
321
322
323
324
325
326
async def verify(
    self,
    reference: str,
) -> Response:
    """Verify a transfer

    Args:
        reference: str

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

Transfer

Bases: BaseAPI

Provides a wrapper for paystack Transfers API

The Transfers API allows you to automate sending money on your integration https://paystack.com/docs/api/transfer/

Note

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

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

    The Transfers API allows you to automate sending money on your integration
    https://paystack.com/docs/api/transfer/

    Note
    ----
    This feature is only available to businesses in Nigeria and Ghana.
    """

    def initiate(
        self,
        amount: int,
        recipient: str,
        reason: Optional[str] = None,
        currency: Optional[Currency] = None,
        reference: Optional[str] = None,
        source: str = "balance",
    ) -> Response:
        """Initiate transfer

        Args:
            amount: amount to transfer
            recipient: the beneficiary of the transfer
            reason: narration of the transfer
            currency: transfer currency
            reference: reference id
            source: transfer source

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        amount = validate_amount(amount)

        url = self._parse_url("/transfer")

        payload = {
            "amount": amount,
            "recipient": recipient,
            "source": source,
        }
        optional_params = [
            ("reason", reason),
            ("reference", reference),
            ("currency", currency),
        ]
        payload = add_to_payload(optional_params, payload)
        return self._handle_request(HTTPMethod.POST, url, payload)

    def finalize(
        self,
        transfer_code: str,
        otp: str,
    ) -> Response:
        """Finalize transfer

        Args:
            transfer_code: The code for transfer.
            otp: One time password.

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

        url = self._parse_url("/transfer/finalize_transfer")

        payload = {
            "transfer_code": transfer_code,
            "otp": otp,
        }
        return self._handle_request(HTTPMethod.POST, url, payload)

    def bulk_transfer(
        self, transfers: list[TransferInstruction], source: str = "balance"
    ) -> Response:
        """Transfer in bulk

        Args:
            transfers: list of transfer instructions
            source: source of the funds to transfer

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

        url = self._parse_url("/transfer/bulk")

        payload = {
            "transfers": [tx.dict for tx in transfers],
            "source": source,
        }
        return self._handle_request(HTTPMethod.POST, url, payload)

    def get_transfers(
        self,
        page: int = 1,
        pagination: int = 50,
        customer: Optional[str] = None,
        start_date: Optional[str] = None,
        end_date: Optional[str] = None,
    ) -> Response:
        """Retrieve transfers made to a customer

        Args:
            customer: customer id
            page: Specifies exactly what page you want to retrieve.
                If not specified, we use a default value of 1.
            pagination: Specifies how many records you want to retrieve per page.
                If not specified, we use a default value of 50.
            start_date: A timestamp from which to start listing refund e.g. 2016-09-21
            end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url(f"/transfer?perPage={pagination}")
        query_params = [
            ("customer", customer),
            ("page", page),
            ("from", start_date),
            ("to", end_date),
        ]
        url = append_query_params(query_params, url)
        return self._handle_request(HTTPMethod.GET, url)

    def get_transfer(
        self,
        id_or_code: str,
    ) -> Response:
        """Retrieve a transfer

        Args:
            id_or_code: transfer ID or code

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

    def verify(
        self,
        reference: str,
    ) -> Response:
        """Verify a transfer

        Args:
            reference: str

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

bulk_transfer(transfers, source='balance')

Transfer in bulk

Parameters:

Name Type Description Default
transfers list[TransferInstruction]

list of transfer instructions

 required
source str

source of the funds to transfer

 'balance'

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def bulk_transfer(
    self, transfers: list[TransferInstruction], source: str = "balance"
) -> Response:
    """Transfer in bulk

    Args:
        transfers: list of transfer instructions
        source: source of the funds to transfer

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

    url = self._parse_url("/transfer/bulk")

    payload = {
        "transfers": [tx.dict for tx in transfers],
        "source": source,
    }
    return self._handle_request(HTTPMethod.POST, url, payload)

finalize(transfer_code, otp)

Finalize transfer

Parameters:

Name Type Description Default
transfer_code str

The code for transfer.

 required
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.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def finalize(
    self,
    transfer_code: str,
    otp: str,
) -> Response:
    """Finalize transfer

    Args:
        transfer_code: The code for transfer.
        otp: One time password.

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

    url = self._parse_url("/transfer/finalize_transfer")

    payload = {
        "transfer_code": transfer_code,
        "otp": otp,
    }
    return self._handle_request(HTTPMethod.POST, url, payload)

get_transfer(id_or_code)

Retrieve a transfer

Parameters:

Name Type Description Default
id_or_code str

transfer ID or code

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def get_transfer(
    self,
    id_or_code: str,
) -> Response:
    """Retrieve a transfer

    Args:
        id_or_code: transfer ID or code

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

get_transfers(page=1, pagination=50, customer=None, start_date=None, end_date=None)

Retrieve transfers made to a customer

Parameters:

Name Type Description Default
customer Optional[str]

customer id

 None
page int

Specifies exactly what page you want to retrieve. If not specified, we use a default value of 1.

 1
pagination int

Specifies how many records you want to retrieve per page. If not specified, we use a default value of 50.

 50
start_date Optional[str]

A timestamp from which to start listing refund e.g. 2016-09-21

 None
end_date Optional[str]

A timestamp at which to stop listing refund e.g. 2016-09-21

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
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
def get_transfers(
    self,
    page: int = 1,
    pagination: int = 50,
    customer: Optional[str] = None,
    start_date: Optional[str] = None,
    end_date: Optional[str] = None,
) -> Response:
    """Retrieve transfers made to a customer

    Args:
        customer: customer id
        page: Specifies exactly what page you want to retrieve.
            If not specified, we use a default value of 1.
        pagination: Specifies how many records you want to retrieve per page.
            If not specified, we use a default value of 50.
        start_date: A timestamp from which to start listing refund e.g. 2016-09-21
        end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url(f"/transfer?perPage={pagination}")
    query_params = [
        ("customer", customer),
        ("page", page),
        ("from", start_date),
        ("to", end_date),
    ]
    url = append_query_params(query_params, url)
    return self._handle_request(HTTPMethod.GET, url)

initiate(amount, recipient, reason=None, currency=None, reference=None, source='balance')

Initiate transfer

Parameters:

Name Type Description Default
amount int

amount to transfer

 required
recipient str

the beneficiary of the transfer

 required
reason Optional[str]

narration of the transfer

 None
currency Optional[Currency]

transfer currency

 None
reference Optional[str]

reference id

 None
source str

transfer source

 'balance'

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.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
def initiate(
    self,
    amount: int,
    recipient: str,
    reason: Optional[str] = None,
    currency: Optional[Currency] = None,
    reference: Optional[str] = None,
    source: str = "balance",
) -> Response:
    """Initiate transfer

    Args:
        amount: amount to transfer
        recipient: the beneficiary of the transfer
        reason: narration of the transfer
        currency: transfer currency
        reference: reference id
        source: transfer source

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    amount = validate_amount(amount)

    url = self._parse_url("/transfer")

    payload = {
        "amount": amount,
        "recipient": recipient,
        "source": source,
    }
    optional_params = [
        ("reason", reason),
        ("reference", reference),
        ("currency", currency),
    ]
    payload = add_to_payload(optional_params, payload)
    return self._handle_request(HTTPMethod.POST, url, payload)

verify(reference)

Verify a transfer

Parameters:

Name Type Description Default
reference str

str

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/transfers.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def verify(
    self,
    reference: str,
) -> Response:
    """Verify a transfer

    Args:
        reference: str

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