All URIs are relative to https://api.paystack.co
| Method | HTTP request | Description |
|---|---|---|
| bulk | POST /transfer/bulk | Initiate Bulk Transfer |
| disable_otp | POST /transfer/disable_otp | Disable OTP requirement for Transfers |
| disable_otp_finalize | POST /transfer/disable_otp_finalize | Finalize Disabling of OTP requirement for Transfers |
| download | GET /transfer/export | Export Transfers |
| enable_otp | POST /transfer/enable_otp | Enable OTP requirement for Transfers |
| fetch | GET /transfer/{code} | Fetch Transfer |
| finalize | POST /transfer/finalize_transfer | Finalize Transfer |
| initiate | POST /transfer | Initiate Transfer |
| list | GET /transfer | List Transfers |
| resend_otp | POST /transfer/resend_otp | Resend OTP for Transfer |
| verify | GET /transfer/verify/{reference} | Verify Transfer |
Response bulk(source=source, transfers=transfers)
Initiate Bulk Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
source = 'source_example' # str | Where should we transfer from? Only balance is allowed for now (optional)
transfers = paystack.TransferInitiate() # list[TransferInitiate] | A list of transfer object. Each object should contain amount, recipient, and reference (optional)
# Initiate Bulk Transfer
response = paystack.Transfer.bulk(source=source, transfers=transfers)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| source | str | Where should we transfer from? Only balance is allowed for now | [optional] |
| transfers | list[TransferInitiate] | A list of transfer object. Each object should contain amount, recipient, and reference | [optional] |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response disable_otp()
Disable OTP requirement for Transfers
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
# Disable OTP requirement for Transfers
response = paystack.Transfer.disable_otp()
pprint(response)This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response disable_otp_finalize(otp)
Finalize Disabling of OTP requirement for Transfers
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
otp = 'otp_example' # str | OTP sent to business phone to verify disabling OTP requirement
# Finalize Disabling of OTP requirement for Transfers
response = paystack.Transfer.disable_otp_finalize(otp)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| otp | str | OTP sent to business phone to verify disabling OTP requirement |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response download(per_page=per_page, page=page, status=status, _from=_from, to=to)
Export Transfers
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
per_page = 56 # int | Number of records to fetch per page (optional)
page = 56 # int | The section to retrieve (optional)
status = 'status_example' # str | (optional)
_from = '2013-10-20T19:20:30+01:00' # datetime | The start date (optional)
to = '2013-10-20T19:20:30+01:00' # datetime | The end date (optional)
# Export Transfers
response = paystack.Transfer.download(per_page=per_page, page=page, status=status, _from=_from, to=to)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| per_page | int | Number of records to fetch per page | [optional] |
| page | int | The section to retrieve | [optional] |
| status | str | [optional] | |
| _from | datetime | The start date | [optional] |
| to | datetime | The end date | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response enable_otp()
Enable OTP requirement for Transfers
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
# Enable OTP requirement for Transfers
response = paystack.Transfer.enable_otp()
pprint(response)This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response fetch(code)
Fetch Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
code = 'code_example' # str | Transfer code
# Fetch Transfer
response = paystack.Transfer.fetch(code)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| code | str | Transfer code |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response finalize(transfer_code, otp)
Finalize Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
transfer_code = 'transfer_code_example' # str | The transfer code you want to finalize
otp = 'otp_example' # str | OTP sent to business phone to verify transfer
# Finalize Transfer
response = paystack.Transfer.finalize(transfer_code, otp)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| transfer_code | str | The transfer code you want to finalize | |
| otp | str | OTP sent to business phone to verify transfer |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response initiate(source, amount, recipient, reason=reason, currency=currency, reference=reference)
Initiate Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
source = 'source_example' # str | Where should we transfer from? Only balance is allowed for now
amount = 'amount_example' # str | Amount to transfer in kobo if currency is NGN and pesewas if currency is GHS.
recipient = 'recipient_example' # str | The transfer recipient's code
reason = 'reason_example' # str | The reason or narration for the transfer. (optional)
currency = 'currency_example' # str | Specify the currency of the transfer. Defaults to NGN. (optional)
reference = 'reference_example' # str | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters are allowed. (optional)
# Initiate Transfer
response = paystack.Transfer.initiate(source, amount, recipient, reason=reason, currency=currency, reference=reference)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| source | str | Where should we transfer from? Only balance is allowed for now | |
| amount | str | Amount to transfer in kobo if currency is NGN and pesewas if currency is GHS. | |
| recipient | str | The transfer recipient's code | |
| reason | str | The reason or narration for the transfer. | [optional] |
| currency | str | Specify the currency of the transfer. Defaults to NGN. | [optional] |
| reference | str | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters are allowed. | [optional] |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response list(per_page=per_page, page=page, status=status, _from=_from, to=to)
List Transfers
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
per_page = 56 # int | Number of records to fetch per page (optional)
page = 56 # int | The section to retrieve (optional)
status = 'status_example' # str | (optional)
_from = '2013-10-20T19:20:30+01:00' # datetime | The start date (optional)
to = '2013-10-20T19:20:30+01:00' # datetime | The end date (optional)
# List Transfers
response = paystack.Transfer.list(per_page=per_page, page=page, status=status, _from=_from, to=to)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| per_page | int | Number of records to fetch per page | [optional] |
| page | int | The section to retrieve | [optional] |
| status | str | [optional] | |
| _from | datetime | The start date | [optional] |
| to | datetime | The end date | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response resend_otp(transfer_code, reason)
Resend OTP for Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
transfer_code = 'transfer_code_example' # str | The transfer code that requires an OTP validation
reason = 'reason_example' # str | Either resend_otp or transfer
# Resend OTP for Transfer
response = paystack.Transfer.resend_otp(transfer_code, reason)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| transfer_code | str | The transfer code that requires an OTP validation | |
| reason | str | Either resend_otp or transfer |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Response verify(reference)
Verify Transfer
- Bearer Authentication (bearerAuth):
import paystack
from paystack.rest import ApiException
from pprint import pprint
reference = 'reference_example' # str |
# Verify Transfer
response = paystack.Transfer.verify(reference)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| reference | str |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]