All URIs are relative to https://api.paystack.co
| Method | HTTP request | Description |
|---|---|---|
| add_subaccount | POST /split/{id}/subaccount/add | Add Subaccount to Split |
| create | POST /split | Create Split |
| fetch | GET /split/{id} | Fetch Split |
| list | GET /split | List/Search Splits |
| remove_subaccount | POST /split/{id}/subaccount/remove | Remove Subaccount from split |
| update | PUT /split/{id} | Update Split |
Response add_subaccount(id, subaccount=subaccount, share=share)
Add Subaccount to Split
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'id='application/json'# str | # Add Subaccount to Splitresponse=paystack.Split.add_subaccount(
id,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| subaccount | str | Subaccount code of the customer or partner | [optional] |
| share | str | The percentage or flat quota of the customer or partner | [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 create(name, type, subaccounts, currency, bearer_type=bearer_type, bearer_subaccount=bearer_subaccount)
Create Split
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'name='name_example'# str | Name of the transaction splittype='type_example'# str | The type of transaction split you want to create.subaccounts=paystack.SplitSubaccounts() # list[SplitSubaccounts] | A list of object containing subaccount code and number of sharescurrency='currency_example'# str | The transaction currency# Create Splitresponse=paystack.Split.create(
name,
type,
subaccounts,
currency,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | Name of the transaction split | |
| type | str | The type of transaction split you want to create. | |
| subaccounts | list[SplitSubaccounts] | A list of object containing subaccount code and number of shares | |
| currency | str | The transaction currency | |
| bearer_type | str | This allows you specify how the transaction charge should be processed | [optional] |
| bearer_subaccount | str | This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type | [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 fetch(id)
Fetch Split
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'id='id_example'# str | # Fetch Splitresponse=paystack.Split.fetch(
id,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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]
Response list(name=name, active=active, sort_by=sort_by, _from=_from, to=to, per_page=per_page, page=page)
List/Search Splits
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'# List/Search Splitsresponse=paystack.Split.list(
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | [optional] | |
| active | str | [optional] | |
| sort_by | str | [optional] | |
| _from | str | [optional] | |
| to | str | [optional] | |
| per_page | str | [optional] | |
| page | str | [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 remove_subaccount(id, subaccount=subaccount, share=share)
Remove Subaccount from split
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'id='id_example'# str | # Remove Subaccount from splitresponse=paystack.Split.remove_subaccount(
id,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| subaccount | str | Subaccount code of the customer or partner | [optional] |
| share | str | The percentage or flat quota of the customer or partner | [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 update(id, name=name, active=active, bearer_type=bearer_type, bearer_subaccount=bearer_subaccount)
Update Split
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'id='id_example'# str | # Update Splitresponse=paystack.Split.update(
id,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| name | str | Name of the transaction split | [optional] |
| active | bool | Toggle status of split. When true, the split is active, else it's inactive | [optional] |
| bearer_type | str | This allows you specify how the transaction charge should be processed | [optional] |
| bearer_subaccount | str | This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type | [optional] |
- Content-Type: application/x-www-form-urlencoded, application/json
- 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]