Dedicated accounts

`AsyncDedicatedAccount`

Bases: BaseAsyncAPI

Provides a wrapper for paystack Dedicated Virtual Account API

The Dedicated Virtual Account API enables Nigerian merchants to manage unique payment accounts of their customers. https://paystack.com/docs/api/dedicated-virtual-account/

Note

This feature is only available to businesses in Nigeria.

Source code in src/pypaystack2/api/dedicated_accounts.py

class AsyncDedicatedAccount(BaseAsyncAPI):
    """Provides a wrapper for paystack Dedicated Virtual Account API

    The Dedicated Virtual Account API enables Nigerian merchants to manage
    unique payment accounts of their customers.
    https://paystack.com/docs/api/dedicated-virtual-account/


    Note:
        This feature is only available to businesses in Nigeria.
    """

    async def create(
        self,
        customer: str,
        preferred_bank: Optional[str] = None,
        subaccount: Optional[str] = None,
        split_code: Optional[str] = None,
        first_name: Optional[str] = None,
        last_name: Optional[str] = None,
        phone: Optional[str] = None,
    ) -> Response:
        """Create a dedicated virtual account for an existing customer

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Wema Bank and Titan Paystack.

        Args:
            customer: Customer ID or code
            preferred_bank: The bank slug for a preferred bank. To get a list of available banks, use the
                Miscellaneous API ``.get_providers`` method.
            subaccount: Subaccount code of the account you want to split the transaction with
            split_code: Split code consisting of the lists of accounts you want to split the transaction with
            first_name: Customer's first name
            last_name: Customer's last name
            phone: Customer's phone number

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/dedicated_account")
        payload = {
            "customer": customer,
        }
        optional_params = [
            ("preferred_bank", preferred_bank),
            ("subaccount", subaccount),
            ("split_code", split_code),
            ("first_name", first_name),
            ("last_name", last_name),
            ("phone", phone),
        ]
        payload = add_to_payload(optional_params, payload)
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def assign(
        self,
        email: str,
        first_name: str,
        last_name: str,
        phone: str,
        preferred_bank: str,
        country: Country = Country.NIGERIA,
        account_number: Optional[str] = None,
        bvn: Optional[str] = None,
        bank_code: Optional[str] = None,
        subaccount: Optional[str] = None,
        split_code: Optional[str] = None,
    ) -> Response:
        """Create a customer, validate the customer, and assign a DVA to the customer.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Wema Bank and Titan Paystack.

        Args:
            email: Customer email address
            first_name: Customer's first name
            last_name: Customer's last name
            phone: Customer's phone number
            preferred_bank: The bank slug for preferred bank. To get a list of available banks, use the
                Paystack.miscellaneous.get_banks, AsyncPaystack.miscellaneous.get_banks, Miscellaneous.get_banks
                or AsyncMiscellaneous.get_banks, with `pay_with_bank_transfer=true`
            country: Currently accepts `Country.NIGERIA` only
            account_number: Customer's account number
            bvn: Customer's Bank Verification Number
            bank_code: Customer's bank code
            subaccount: Subaccount code of the account you want to split the transaction with
            split_code: Split code consisting of the lists of accounts you want to split the transaction with
        """

        url = self._parse_url("/dedicated_account/assign")
        payload = {
            "email": email,
            "first_name": first_name,
            "last_name": last_name,
            "phone": phone,
            "preferred_bank": preferred_bank,
            "country": country,
        }
        optional_params = [
            ("account_number", account_number),
            ("bvn", bvn),
            ("bank_code", bank_code),
            ("subaccount", subaccount),
            ("split_code", split_code),
        ]
        payload = add_to_payload(optional_params, payload)
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def get_dedicated_accounts(
        self,
        active: bool = True,
        currency: Currency = Currency.NGN,
        provider_slug: Optional[str] = None,
        bank_id: Optional[str] = None,
        customer: Optional[str] = None,
    ) -> Response:
        """Fetches dedicated virtual accounts available on your integration.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Wema Bank and Titan Paystack.

        Args:
            active: Status of the dedicated virtual account
            currency: The currency of the dedicated virtual account. Only ``Currency.NGN`` is currently allowed
            provider_slug: The bank's slug in lowercase, without spaces e.g. wema-bank. call the `.get_providers`
                method of this class to see available providers.
            bank_id: The bank's ID e.g., 035
            customer: The customer's ID

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        query_params = [
            ("currency", currency),
            ("provider_slug", provider_slug),
            ("bank_id", bank_id),
            ("customer", customer),
        ]
        url = self._parse_url(f"/dedicated_account?active={active}")
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_dedicated_account(self, dedicated_account_id: int) -> Response:
        """Get details of a dedicated virtual account on your integration.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Wema Bank and Titan Paystack.

        Args:
            dedicated_account_id: ID of dedicated virtual account

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/dedicated_account/{dedicated_account_id}")
        return await self._handle_request(HTTPMethod.GET, url)

    async def requery(
        self, account_number: str, provider_slug: str, date: Optional[str]
    ) -> Response:
        """Get details of a dedicated virtual account on your integration.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Wema Bank and Titan Paystack.

        Args:
            account_number: Virtual account number to requery
            provider_slug: The bank's slug in lowercase, without spaces e.g. wema-bank
            date: The day the transfer was made in YYYY-MM-DD ISO format

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/dedicated_account?account_number={account_number}")
        query_params = [
            ("provider_slug", provider_slug),
            ("date", date),
        ]
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def deactivate(self, dedicated_account_id: int) -> Response:
        """Deactivate a dedicated virtual account on your integration.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Access Bank and Wema Bank.

        Args:
            dedicated_account_id: ID of dedicated virtual account

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/dedicated_account/{dedicated_account_id}")
        return await self._handle_request(HTTPMethod.DELETE, url)

    async def split(
        self,
        customer: str,
        subaccount: Optional[str] = None,
        split_code: Optional[str] = None,
        preferred_bank: Optional[str] = None,
    ) -> Response:
        """Split a dedicated virtual account transaction with one or more accounts

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Access Bank and Wema Bank.

        Args:
            customer: Customer ID or code
            subaccount: Subaccount code of the account you want to split the transaction with
            split_code: Split code consisting of the lists of accounts you want to split the transaction with
            preferred_bank: The bank slug for a preferred bank. To get a list of available banks,
                use the Miscellaneous API ``.get_providers`` method

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/dedicated_account/split")
        payload = {"customer": customer}

        optional_params = [
            ("subaccount", subaccount),
            ("split_code", split_code),
            ("preferred_bank", preferred_bank),
        ]
        payload = add_to_payload(optional_params, payload)
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def remove_split(self, account_number: str) -> Response:
        """Removes a split.

        If you've previously set up split payment for transactions on a dedicated virtual
        account, you can remove it with this method.

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Access Bank and Wema Bank.

        Args:
            account_number: Dedicated virtual account number

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/dedicated_account/split")
        payload = {
            "account_number": account_number,
        }
        return await self._handle_request(HTTPMethod.DELETE, url, payload)

    async def get_providers(self) -> Response:
        """Get available bank providers for a dedicated virtual account

        Note:
            * This feature is only available to businesses in Nigeria.
            * Paystack currently supports Access Bank and Wema Bank.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url("/dedicated_account/available_providers")
        return await self._handle_request(HTTPMethod.GET, url)

`assign(email, first_name, last_name, phone, preferred_bank, country=Country.NIGERIA, account_number=None, bvn=None, bank_code=None, subaccount=None, split_code=None)` `async`

Create a customer, validate the customer, and assign a DVA to the customer.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Wema Bank and Titan Paystack.

Parameters:

Name	Type	Description	Default
`email`	`str`	Customer email address	required
`first_name`	`str`	Customer's first name	required
`last_name`	`str`	Customer's last name	required
`phone`	`str`	Customer's phone number	required
`preferred_bank`	`str`	The bank slug for preferred bank. To get a list of available banks, use the Paystack.miscellaneous.get_banks, AsyncPaystack.miscellaneous.get_banks, Miscellaneous.get_banks or AsyncMiscellaneous.get_banks, with `pay_with_bank_transfer=true`	required
`country`	`Country`	Currently accepts `Country.NIGERIA` only	`NIGERIA`
`account_number`	`Optional[str]`	Customer's account number	`None`
`bvn`	`Optional[str]`	Customer's Bank Verification Number	`None`
`bank_code`	`Optional[str]`	Customer's bank code	`None`
`subaccount`	`Optional[str]`	Subaccount code of the account you want to split the transaction with	`None`
`split_code`	`Optional[str]`	Split code consisting of the lists of accounts you want to split the transaction with	`None`

Source code in src/pypaystack2/api/dedicated_accounts.py

async def assign(
    self,
    email: str,
    first_name: str,
    last_name: str,
    phone: str,
    preferred_bank: str,
    country: Country = Country.NIGERIA,
    account_number: Optional[str] = None,
    bvn: Optional[str] = None,
    bank_code: Optional[str] = None,
    subaccount: Optional[str] = None,
    split_code: Optional[str] = None,
) -> Response:
    """Create a customer, validate the customer, and assign a DVA to the customer.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Wema Bank and Titan Paystack.

    Args:
        email: Customer email address
        first_name: Customer's first name
        last_name: Customer's last name
        phone: Customer's phone number
        preferred_bank: The bank slug for preferred bank. To get a list of available banks, use the
            Paystack.miscellaneous.get_banks, AsyncPaystack.miscellaneous.get_banks, Miscellaneous.get_banks
            or AsyncMiscellaneous.get_banks, with `pay_with_bank_transfer=true`
        country: Currently accepts `Country.NIGERIA` only
        account_number: Customer's account number
        bvn: Customer's Bank Verification Number
        bank_code: Customer's bank code
        subaccount: Subaccount code of the account you want to split the transaction with
        split_code: Split code consisting of the lists of accounts you want to split the transaction with
    """

    url = self._parse_url("/dedicated_account/assign")
    payload = {
        "email": email,
        "first_name": first_name,
        "last_name": last_name,
        "phone": phone,
        "preferred_bank": preferred_bank,
        "country": country,
    }
    optional_params = [
        ("account_number", account_number),
        ("bvn", bvn),
        ("bank_code", bank_code),
        ("subaccount", subaccount),
        ("split_code", split_code),
    ]
    payload = add_to_payload(optional_params, payload)
    return await self._handle_request(HTTPMethod.POST, url, payload)

`create(customer, preferred_bank=None, subaccount=None, split_code=None, first_name=None, last_name=None, phone=None)` `async`

Create a dedicated virtual account for an existing customer

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Wema Bank and Titan Paystack.

Parameters:

Name	Type	Description	Default
`customer`	`str`	Customer ID or code	required
`preferred_bank`	`Optional[str]`	The bank slug for a preferred bank. To get a list of available banks, use the Miscellaneous API `.get_providers` method.	`None`
`subaccount`	`Optional[str]`	Subaccount code of the account you want to split the transaction with	`None`
`split_code`	`Optional[str]`	Split code consisting of the lists of accounts you want to split the transaction with	`None`
`first_name`	`Optional[str]`	Customer's first name	`None`
`last_name`	`Optional[str]`	Customer's last name	`None`
`phone`	`Optional[str]`	Customer's phone number	`None`

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def create(
    self,
    customer: str,
    preferred_bank: Optional[str] = None,
    subaccount: Optional[str] = None,
    split_code: Optional[str] = None,
    first_name: Optional[str] = None,
    last_name: Optional[str] = None,
    phone: Optional[str] = None,
) -> Response:
    """Create a dedicated virtual account for an existing customer

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Wema Bank and Titan Paystack.

    Args:
        customer: Customer ID or code
        preferred_bank: The bank slug for a preferred bank. To get a list of available banks, use the
            Miscellaneous API ``.get_providers`` method.
        subaccount: Subaccount code of the account you want to split the transaction with
        split_code: Split code consisting of the lists of accounts you want to split the transaction with
        first_name: Customer's first name
        last_name: Customer's last name
        phone: Customer's phone number

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/dedicated_account")
    payload = {
        "customer": customer,
    }
    optional_params = [
        ("preferred_bank", preferred_bank),
        ("subaccount", subaccount),
        ("split_code", split_code),
        ("first_name", first_name),
        ("last_name", last_name),
        ("phone", phone),
    ]
    payload = add_to_payload(optional_params, payload)
    return await self._handle_request(HTTPMethod.POST, url, payload)

`deactivate(dedicated_account_id)` `async`

Deactivate a dedicated virtual account on your integration.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Access Bank and Wema Bank.

Parameters:

Name	Type	Description	Default
`dedicated_account_id`	`int`	ID of dedicated virtual account	required

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def deactivate(self, dedicated_account_id: int) -> Response:
    """Deactivate a dedicated virtual account on your integration.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Access Bank and Wema Bank.

    Args:
        dedicated_account_id: ID of dedicated virtual account

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/dedicated_account/{dedicated_account_id}")
    return await self._handle_request(HTTPMethod.DELETE, url)

`get_dedicated_account(dedicated_account_id)` `async`

Get details of a dedicated virtual account on your integration.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Wema Bank and Titan Paystack.

Parameters:

Name	Type	Description	Default
`dedicated_account_id`	`int`	ID of dedicated virtual account	required

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def get_dedicated_account(self, dedicated_account_id: int) -> Response:
    """Get details of a dedicated virtual account on your integration.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Wema Bank and Titan Paystack.

    Args:
        dedicated_account_id: ID of dedicated virtual account

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/dedicated_account/{dedicated_account_id}")
    return await self._handle_request(HTTPMethod.GET, url)

`get_dedicated_accounts(active=True, currency=Currency.NGN, provider_slug=None, bank_id=None, customer=None)` `async`

Fetches dedicated virtual accounts available on your integration.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Wema Bank and Titan Paystack.

Parameters:

Name	Type	Description	Default
`active`	`bool`	Status of the dedicated virtual account	`True`
`currency`	`Currency`	The currency of the dedicated virtual account. Only `Currency.NGN` is currently allowed	`NGN`
`provider_slug`	`Optional[str]`	The bank's slug in lowercase, without spaces e.g. wema-bank. call the `.get_providers` method of this class to see available providers.	`None`
`bank_id`	`Optional[str]`	The bank's ID e.g., 035	`None`
`customer`	`Optional[str]`	The customer's ID	`None`

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def get_dedicated_accounts(
    self,
    active: bool = True,
    currency: Currency = Currency.NGN,
    provider_slug: Optional[str] = None,
    bank_id: Optional[str] = None,
    customer: Optional[str] = None,
) -> Response:
    """Fetches dedicated virtual accounts available on your integration.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Wema Bank and Titan Paystack.

    Args:
        active: Status of the dedicated virtual account
        currency: The currency of the dedicated virtual account. Only ``Currency.NGN`` is currently allowed
        provider_slug: The bank's slug in lowercase, without spaces e.g. wema-bank. call the `.get_providers`
            method of this class to see available providers.
        bank_id: The bank's ID e.g., 035
        customer: The customer's ID

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    query_params = [
        ("currency", currency),
        ("provider_slug", provider_slug),
        ("bank_id", bank_id),
        ("customer", customer),
    ]
    url = self._parse_url(f"/dedicated_account?active={active}")
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

`get_providers()` `async`

Get available bank providers for a dedicated virtual account

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Access Bank and Wema Bank.

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def get_providers(self) -> Response:
    """Get available bank providers for a dedicated virtual account

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Access Bank and Wema Bank.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/dedicated_account/available_providers")
    return await self._handle_request(HTTPMethod.GET, url)

`remove_split(account_number)` `async`

Removes a split.

If you've previously set up split payment for transactions on a dedicated virtual account, you can remove it with this method.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Access Bank and Wema Bank.

Parameters:

Name	Type	Description	Default
`account_number`	`str`	Dedicated virtual account number	required

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def remove_split(self, account_number: str) -> Response:
    """Removes a split.

    If you've previously set up split payment for transactions on a dedicated virtual
    account, you can remove it with this method.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Access Bank and Wema Bank.

    Args:
        account_number: Dedicated virtual account number

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/dedicated_account/split")
    payload = {
        "account_number": account_number,
    }
    return await self._handle_request(HTTPMethod.DELETE, url, payload)

`requery(account_number, provider_slug, date)` `async`

Get details of a dedicated virtual account on your integration.

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Wema Bank and Titan Paystack.

Parameters:

Name	Type	Description	Default
`account_number`	`str`	Virtual account number to requery	required
`provider_slug`	`str`	The bank's slug in lowercase, without spaces e.g. wema-bank	required
`date`	`Optional[str]`	The day the transfer was made in YYYY-MM-DD ISO format	required

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def requery(
    self, account_number: str, provider_slug: str, date: Optional[str]
) -> Response:
    """Get details of a dedicated virtual account on your integration.

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Wema Bank and Titan Paystack.

    Args:
        account_number: Virtual account number to requery
        provider_slug: The bank's slug in lowercase, without spaces e.g. wema-bank
        date: The day the transfer was made in YYYY-MM-DD ISO format

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/dedicated_account?account_number={account_number}")
    query_params = [
        ("provider_slug", provider_slug),
        ("date", date),
    ]
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

`split(customer, subaccount=None, split_code=None, preferred_bank=None)` `async`

Split a dedicated virtual account transaction with one or more accounts

Note

This feature is only available to businesses in Nigeria.
Paystack currently supports Access Bank and Wema Bank.

Parameters:

Name	Type	Description	Default
`customer`	`str`	Customer ID or code	required
`subaccount`	`Optional[str]`	Subaccount code of the account you want to split the transaction with	`None`
`split_code`	`Optional[str]`	Split code consisting of the lists of accounts you want to split the transaction with	`None`
`preferred_bank`	`Optional[str]`	The bank slug for a preferred bank. To get a list of available banks, use the Miscellaneous API `.get_providers` method	`None`

Returns:

Type	Description
`Response`	A named tuple containing the response gotten from paystack's server.

Source code in src/pypaystack2/api/dedicated_accounts.py

async def split(
    self,
    customer: str,
    subaccount: Optional[str] = None,
    split_code: Optional[str] = None,
    preferred_bank: Optional[str] = None,
) -> Response:
    """Split a dedicated virtual account transaction with one or more accounts

    Note:
        * This feature is only available to businesses in Nigeria.
        * Paystack currently supports Access Bank and Wema Bank.

    Args:
        customer: Customer ID or code
        subaccount: Subaccount code of the account you want to split the transaction with
        split_code: Split code consisting of the lists of accounts you want to split the transaction with
        preferred_bank: The bank slug for a preferred bank. To get a list of available banks,
            use the Miscellaneous API ``.get_providers`` method

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url("/dedicated_account/split")
    payload = {"customer": customer}

    optional_params = [
        ("subaccount", subaccount),
        ("split_code", split_code),
        ("preferred_bank", preferred_bank),
    ]
    payload = add_to_payload(optional_params, payload)
    return await self._handle_request(HTTPMethod.POST, url, payload)