Skip to content

MultiChequesApi.md

Latest commit

 

History

History
281 lines (198 loc) · 8.52 KB

MultiChequesApi.md

File metadata and controls

281 lines (198 loc) · 8.52 KB

swagger_client.MultiChequesApi

All URIs are relative to https://pay.ton-rocket.com/

Method HTTP request Description
cheques_controller_create_cheque POST /multi-cheques Create multi-cheque
cheques_controller_delete_cheque DELETE /multi-cheques/{id} Delete multi-cheque
cheques_controller_edit_cheque PUT /multi-cheques/{id} Edit multi-cheque
cheques_controller_get_cheque GET /multi-cheques/{id} Get multi-cheque info
cheques_controller_get_cheques GET /multi-cheques Get list of multi-cheques

cheques_controller_create_cheque

SimpleChequeResponse cheques_controller_create_cheque(body)

Create multi-cheque

Example

from __future__ import print_function
import time
import rocketpay
from rocketpay.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = rocketpay.Configuration()
configuration.api_key['Rocket-Pay-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Rocket-Pay-Key'] = 'Bearer'

# create an instance of the API class
api_instance = rocketpay.MultiChequesApi(rocketpay.ApiClient(configuration))
body = rocketpay.CreateChequeDto() # CreateChequeDto | 

try:
    # Create multi-cheque
    api_response = api_instance.cheques_controller_create_cheque(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MultiChequesApi->cheques_controller_create_cheque: %s\n" % e)

Parameters

Name Type Description Notes
body CreateChequeDto

Return type

SimpleChequeResponse

Authorization

api-key

HTTP request headers

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

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

cheques_controller_delete_cheque

DeleteResponseDto cheques_controller_delete_cheque(id)

Delete multi-cheque

Example

from __future__ import print_function
import time
import rocketpay
from rocketpay.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = rocketpay.Configuration()
configuration.api_key['Rocket-Pay-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Rocket-Pay-Key'] = 'Bearer'

# create an instance of the API class
api_instance = rocketpay.MultiChequesApi(rocketpay.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Delete multi-cheque
    api_response = api_instance.cheques_controller_delete_cheque(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MultiChequesApi->cheques_controller_delete_cheque: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

DeleteResponseDto

Authorization

api-key

HTTP request headers

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

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

cheques_controller_edit_cheque

SimpleChequeResponse cheques_controller_edit_cheque(body, id)

Edit multi-cheque

Example

from __future__ import print_function
import time
import rocketpay
from rocketpay.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = rocketpay.Configuration()
configuration.api_key['Rocket-Pay-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Rocket-Pay-Key'] = 'Bearer'

# create an instance of the API class
api_instance = rocketpay.MultiChequesApi(rocketpay.ApiClient(configuration))
body = rocketpay.UpdateChequeDto() # UpdateChequeDto | 
id = 'id_example' # str | 

try:
    # Edit multi-cheque
    api_response = api_instance.cheques_controller_edit_cheque(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MultiChequesApi->cheques_controller_edit_cheque: %s\n" % e)

Parameters

Name Type Description Notes
body UpdateChequeDto
id str

Return type

SimpleChequeResponse

Authorization

api-key

HTTP request headers

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

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

cheques_controller_get_cheque

SimpleShortChequeDtoResponse cheques_controller_get_cheque(id)

Get multi-cheque info

Example

from __future__ import print_function
import time
import rocketpay
from rocketpay.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = rocketpay.Configuration()
configuration.api_key['Rocket-Pay-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Rocket-Pay-Key'] = 'Bearer'

# create an instance of the API class
api_instance = rocketpay.MultiChequesApi(rocketpay.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Get multi-cheque info
    api_response = api_instance.cheques_controller_get_cheque(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MultiChequesApi->cheques_controller_get_cheque: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

SimpleShortChequeDtoResponse

Authorization

api-key

HTTP request headers

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

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

cheques_controller_get_cheques

PaginatedShortChequeDtoResponse cheques_controller_get_cheques(limit=limit, offset=offset)

Get list of multi-cheques

Example

from __future__ import print_function
import time
import rocketpay
from rocketpay.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = rocketpay.Configuration()
configuration.api_key['Rocket-Pay-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Rocket-Pay-Key'] = 'Bearer'

# create an instance of the API class
api_instance = rocketpay.MultiChequesApi(rocketpay.ApiClient(configuration))
limit = 100 # float |  (optional) (default to 100)
offset = 0 # float |  (optional) (default to 0)

try:
    # Get list of multi-cheques
    api_response = api_instance.cheques_controller_get_cheques(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MultiChequesApi->cheques_controller_get_cheques: %s\n" % e)

Parameters

Name Type Description Notes
limit float [optional] [default to 100]
offset float [optional] [default to 0]

Return type

PaginatedShortChequeDtoResponse

Authorization

api-key

HTTP request headers

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

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