Skip to content

Verification

AsyncVerification

Bases: BaseAsyncAPI

Provides a wrapper for paystack Verification API

The Verification API allows you to perform KYC processes. https://paystack.com/docs/api/verification/

Note

This feature is only available to businesses in Nigeria.

Source code in src/pypaystack2/api/verification.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
class AsyncVerification(BaseAsyncAPI):
    """Provides a wrapper for paystack Verification API

    The Verification API allows you to perform KYC processes.
    https://paystack.com/docs/api/verification/

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

    async def resolve_account_number(
        self,
        account_number: str,
        bank_code: str,
    ) -> Response:
        """Confirm an account belongs to the right customer

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

        Args:
            account_number: Account Number
            bank_code: You can get the list of bank codes by calling the
                Miscellaneous API wrapper ``.get_banks`` method.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url(
            f"/bank/resolve?account_number={account_number}&bank_code={bank_code}"
        )
        return await self._handle_request(HTTPMethod.GET, url)

    async def validate_account(
        self,
        account_name: str,
        account_number: str,
        account_type: AccountType,
        bank_code: str,
        country_code: Country,
        document_type: Document,
        document_number: Optional[str] = None,
    ) -> Response:
        """Confirm the authenticity of a customer's account number before sending money

        Args:
            account_name: Customer's first and last name registered with their bank
            account_number: Customer's account number
            account_type: bank_code: The bank code of the customer’s bank. You can fetch the bank codes by
                using Miscellaneous API wrapper ``.get_banks`` method.
            bank_code: The bank code of the customer’s bank
            country_code: Any value from the ``Country`` enum
            document_type: Customer’s mode of identity. any value from the
                ``DocumentType`` enum.
            document_number: Customer’s mode of identity number

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

        payload = {
            "account_name": account_name,
            "account_number": account_number,
            "account_type": account_type,
            "bank_code": bank_code,
            "country_code": country_code,
            "document_type": document_type,
        }
        url = self._parse_url("/bank/validate")

        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def resolve_card_bin(self, bin: str) -> Response:
        """Get more information about a customer's card

        Args:
            bin: First 6 characters of card


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

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

resolve_account_number(account_number, bank_code) async

Confirm an account belongs to the right customer

Note

Feature Availability This feature is only available to businesses in Nigeria.

Parameters:

Name Type Description Default
account_number str

Account Number

 required
bank_code str

You can get the list of bank codes by calling the Miscellaneous API wrapper .get_banks method.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
async def resolve_account_number(
    self,
    account_number: str,
    bank_code: str,
) -> Response:
    """Confirm an account belongs to the right customer

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

    Args:
        account_number: Account Number
        bank_code: You can get the list of bank codes by calling the
            Miscellaneous API wrapper ``.get_banks`` method.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url(
        f"/bank/resolve?account_number={account_number}&bank_code={bank_code}"
    )
    return await self._handle_request(HTTPMethod.GET, url)

resolve_card_bin(bin) async

Get more information about a customer's card

Parameters:

Name Type Description Default
bin str

First 6 characters of card

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
async def resolve_card_bin(self, bin: str) -> Response:
    """Get more information about a customer's card

    Args:
        bin: First 6 characters of card


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

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

validate_account(account_name, account_number, account_type, bank_code, country_code, document_type, document_number=None) async

Confirm the authenticity of a customer's account number before sending money

Parameters:

Name Type Description Default
account_name str

Customer's first and last name registered with their bank

 required
account_number str

Customer's account number

 required
account_type AccountType

bank_code: The bank code of the customer’s bank. You can fetch the bank codes by using Miscellaneous API wrapper .get_banks method.

 required
bank_code str

The bank code of the customer’s bank

 required
country_code Country

Any value from the Country enum

 required
document_type Document

Customer’s mode of identity. any value from the DocumentType enum.

 required
document_number Optional[str]

Customer’s mode of identity number

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
async def validate_account(
    self,
    account_name: str,
    account_number: str,
    account_type: AccountType,
    bank_code: str,
    country_code: Country,
    document_type: Document,
    document_number: Optional[str] = None,
) -> Response:
    """Confirm the authenticity of a customer's account number before sending money

    Args:
        account_name: Customer's first and last name registered with their bank
        account_number: Customer's account number
        account_type: bank_code: The bank code of the customer’s bank. You can fetch the bank codes by
            using Miscellaneous API wrapper ``.get_banks`` method.
        bank_code: The bank code of the customer’s bank
        country_code: Any value from the ``Country`` enum
        document_type: Customer’s mode of identity. any value from the
            ``DocumentType`` enum.
        document_number: Customer’s mode of identity number

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

    payload = {
        "account_name": account_name,
        "account_number": account_number,
        "account_type": account_type,
        "bank_code": bank_code,
        "country_code": country_code,
        "document_type": document_type,
    }
    url = self._parse_url("/bank/validate")

    return await self._handle_request(HTTPMethod.POST, url, payload)

Verification

Bases: BaseAPI

Provides a wrapper for paystack Verification API

The Verification API allows you to perform KYC processes. https://paystack.com/docs/api/verification/

Note

This feature is only available to businesses in Nigeria.

Source code in src/pypaystack2/api/verification.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Verification(BaseAPI):
    """Provides a wrapper for paystack Verification API

    The Verification API allows you to perform KYC processes.
    https://paystack.com/docs/api/verification/

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

    def resolve_account_number(
        self,
        account_number: str,
        bank_code: str,
    ) -> Response:
        """Confirm an account belongs to the right customer

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

        Args:
            account_number: Account Number
            bank_code: You can get the list of bank codes by calling the
                Miscellaneous API wrapper ``.get_banks`` method.

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """
        url = self._parse_url(
            f"/bank/resolve?account_number={account_number}&bank_code={bank_code}"
        )
        return self._handle_request(HTTPMethod.GET, url)

    def validate_account(
        self,
        account_name: str,
        account_number: str,
        account_type: AccountType,
        bank_code: str,
        country_code: Country,
        document_type: Document,
        document_number: Optional[str] = None,
    ) -> Response:
        """Confirm the authenticity of a customer's account number before sending money

        Args:
            account_name: Customer's first and last name registered with their bank
            account_number: Customer's account number
            account_type: bank_code: The bank code of the customer’s bank. You can fetch the bank codes by
                using Miscellaneous API wrapper ``.get_banks`` method.
            bank_code: The bank code of the customer’s bank
            country_code: Any value from the ``Country`` enum
            document_type: Customer’s mode of identity. any value from the
                ``DocumentType`` enum.
            document_number: Customer’s mode of identity number

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

        payload = {
            "account_name": account_name,
            "account_number": account_number,
            "account_type": account_type,
            "bank_code": bank_code,
            "country_code": country_code,
            "document_type": document_type,
            "document_number": document_number,
        }
        url = self._parse_url("/bank/validate")

        return self._handle_request(HTTPMethod.POST, url, payload)

    def resolve_card_bin(self, bin: str) -> Response:
        """Get more information about a customer's card

        Args:
            bin: First 6 characters of card


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

        url = self._parse_url(f"/decision/bin/{bin}")
        return self._handle_request(HTTPMethod.GET, url)

resolve_account_number(account_number, bank_code)

Confirm an account belongs to the right customer

Note

Feature Availability This feature is only available to businesses in Nigeria.

Parameters:

Name Type Description Default
account_number str

Account Number

 required
bank_code str

You can get the list of bank codes by calling the Miscellaneous API wrapper .get_banks method.

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def resolve_account_number(
    self,
    account_number: str,
    bank_code: str,
) -> Response:
    """Confirm an account belongs to the right customer

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

    Args:
        account_number: Account Number
        bank_code: You can get the list of bank codes by calling the
            Miscellaneous API wrapper ``.get_banks`` method.

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """
    url = self._parse_url(
        f"/bank/resolve?account_number={account_number}&bank_code={bank_code}"
    )
    return self._handle_request(HTTPMethod.GET, url)

resolve_card_bin(bin)

Get more information about a customer's card

Parameters:

Name Type Description Default
bin str

First 6 characters of card

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
def resolve_card_bin(self, bin: str) -> Response:
    """Get more information about a customer's card

    Args:
        bin: First 6 characters of card


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

    url = self._parse_url(f"/decision/bin/{bin}")
    return self._handle_request(HTTPMethod.GET, url)

validate_account(account_name, account_number, account_type, bank_code, country_code, document_type, document_number=None)

Confirm the authenticity of a customer's account number before sending money

Parameters:

Name Type Description Default
account_name str

Customer's first and last name registered with their bank

 required
account_number str

Customer's account number

 required
account_type AccountType

bank_code: The bank code of the customer’s bank. You can fetch the bank codes by using Miscellaneous API wrapper .get_banks method.

 required
bank_code str

The bank code of the customer’s bank

 required
country_code Country

Any value from the Country enum

 required
document_type Document

Customer’s mode of identity. any value from the DocumentType enum.

 required
document_number Optional[str]

Customer’s mode of identity number

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/verification.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def validate_account(
    self,
    account_name: str,
    account_number: str,
    account_type: AccountType,
    bank_code: str,
    country_code: Country,
    document_type: Document,
    document_number: Optional[str] = None,
) -> Response:
    """Confirm the authenticity of a customer's account number before sending money

    Args:
        account_name: Customer's first and last name registered with their bank
        account_number: Customer's account number
        account_type: bank_code: The bank code of the customer’s bank. You can fetch the bank codes by
            using Miscellaneous API wrapper ``.get_banks`` method.
        bank_code: The bank code of the customer’s bank
        country_code: Any value from the ``Country`` enum
        document_type: Customer’s mode of identity. any value from the
            ``DocumentType`` enum.
        document_number: Customer’s mode of identity number

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

    payload = {
        "account_name": account_name,
        "account_number": account_number,
        "account_type": account_type,
        "bank_code": bank_code,
        "country_code": country_code,
        "document_type": document_type,
        "document_number": document_number,
    }
    url = self._parse_url("/bank/validate")

    return self._handle_request(HTTPMethod.POST, url, payload)