Skip to content

Latest commit

 

History

History
333 lines (221 loc) · 7.77 KB

BulkCharge.md

File metadata and controls

333 lines (221 loc) · 7.77 KB

paystack.BulkCharge

All URIs are relative to https://api.paystack.co

Method HTTP request Description
charges GET /bulkcharge/{code}/charges Fetch Charges in a Batch
fetch GET /bulkcharge/{code} Fetch Bulk Charge Batch
initiate POST /bulkcharge Initiate Bulk Charge
list GET /bulkcharge List Bulk Charge Batches
pause GET /bulkcharge/pause/{code} Pause Bulk Charge Batch
resume GET /bulkcharge/resume/{code} Resume Bulk Charge Batch

charges

Response charges(code)

Fetch Charges in a Batch

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'

code = 'code_example' # str | Batch code

# Fetch Charges in a Batch

response = paystack.BulkCharge.charges(
    code,
)

pprint(response)

Parameters

Name Type Description Notes
code str Batch code

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]

fetch

Response fetch(code)

Fetch Bulk Charge Batch

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'

code = 'code_example' # str | Batch code

# Fetch Bulk Charge Batch

response = paystack.BulkCharge.fetch(
    code,
)

pprint(response)

Parameters

Name Type Description Notes
code str Batch code

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]

initiate

Response initiate()

Initiate Bulk Charge

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'


# Initiate Bulk Charge

response = paystack.BulkCharge.initiate()


pprint(response)

Parameters

This endpoint does not need any parameter.

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 Resource created -
401 Unauthorized operation -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

Response list(per_page=per_page, page=page, _from=_from, to=to)

List Bulk Charge Batches

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 Bulk Charge Batches

response = paystack.BulkCharge.list(
)

pprint(response)

Parameters

Name Type Description Notes
per_page int Number of records to fetch per page [optional]
page int The section to retrieve [optional]
_from datetime The start date [optional]
to datetime The end date [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]

pause

Response pause(code)

Pause Bulk Charge Batch

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'

code = 'code_example' # str | Batch code

# Pause Bulk Charge Batch

response = paystack.BulkCharge.pause(
    code,
)

pprint(response)

Parameters

Name Type Description Notes
code str Batch code

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]

resume

Response resume(code)

Resume Bulk Charge Batch

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'

code = 'code_example' # str | Batch code

# Resume Bulk Charge Batch

response = paystack.BulkCharge.resume(
    code,
)

pprint(response)

Parameters

Name Type Description Notes
code str Batch code

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]