Skip to content

Latest commit

 

History

History
358 lines (246 loc) · 9.77 KB

Split.md

File metadata and controls

358 lines (246 loc) · 9.77 KB

paystack.Split

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

add_subaccount

Response add_subaccount(id, subaccount=subaccount, share=share)

Add Subaccount to Split

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'application/json' # str | 

# Add Subaccount to Split

response = paystack.Split.add_subaccount(
    id,
)

pprint(response)

Parameters

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]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

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]

create

Response create(name, type, subaccounts, currency, bearer_type=bearer_type, bearer_subaccount=bearer_subaccount)

Create Split

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# 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 split
type = '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 shares
currency = 'currency_example' # str | The transaction currency

# Create Split

response = paystack.Split.create(
    name,
    type,
    subaccounts,
    currency,
)

pprint(response)

Parameters

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]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

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]

fetch

Response fetch(id)

Fetch Split

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | 

# Fetch Split

response = paystack.Split.fetch(
    id,
)

pprint(response)

Parameters

Name Type Description Notes
id str

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]

list

Response list(name=name, active=active, sort_by=sort_by, _from=_from, to=to, per_page=per_page, page=page)

List/Search Splits

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'


# List/Search Splits

response = paystack.Split.list(
)

pprint(response)

Parameters

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]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]

remove_subaccount

Response remove_subaccount(id, subaccount=subaccount, share=share)

Remove Subaccount from split

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | 

# Remove Subaccount from split

response = paystack.Split.remove_subaccount(
    id,
)

pprint(response)

Parameters

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]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

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]

update

Response update(id, name=name, active=active, bearer_type=bearer_type, bearer_subaccount=bearer_subaccount)

Update Split

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | 

# Update Split

response = paystack.Split.update(
    id,
)

pprint(response)

Parameters

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]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

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]