Transfers Control Module

This wrapper class facilitates synchronous integration with Paystack Transfer Control APIs. The Transfers Control API allows you manage settings of your transfers.

---

class TransferControlClientAPI(secret_key: str = None)

Paystack Transfers Control API Reference: Transfer Control

check_balance()→ PayStackResponse

Get the available balance

Returns:

The response from the API

Return type:

PayStackResponse object

disable_otp()→ PayStackResponse

This is used in the event that you want to be able to complete transfers programmatically without use of OTPs

Returns:

The response from the API

Return type:

PayStackResponse object

enable_otp()→ PayStackResponse

This is used in the event that you want to stop being able to complete transfers programmatically with use of OTPs

Returns:

The response from the API

Return type:

PayStackResponse object

fetch_balance_ledger()→ PayStackResponse

Fetch all pay-ins and pay-outs that occurred on your integration

Returns:

The response from the API

Return type:

PayStackResponse object

finalize_disable_otp(otp: str)→ PayStackResponse

Finalize the request to disable OTP on your transfers.

Parameters:

otp – The OTP sent to the business phone to verify disabling of OTP

Returns:

The response from the API

Return type:

PayStackResponse object

resend_otp(transfer_code: str, reason: str)→ PayStackResponse

Generates a new OTP and sends to customer in the event they are having trouble receiving one.

Parameters:

• transfer_code (str) – The transfer code to resend

• reason (str) – The reason for the resend

Returns:

The response from the API

Return type:

PayStackResponse object