Skip to content

Latest commit

 

History

History
281 lines (187 loc) · 6.82 KB

Verification.md

File metadata and controls

281 lines (187 loc) · 6.82 KB

paystack.Verification

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

Method HTTP request Description
avs GET /address_verification/states List States (AVS)
fetch_banks GET /bank Fetch Banks
list_countries GET /country List Countries
resolve_account_number GET /bank/resolve Resolve Account Number
resolve_card_bin GET /decision/bin/{bin} Resolve Card BIN

avs

Response avs(type=type, country=country, currency=currency)

List States (AVS)

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 States (AVS)

response = paystack.Verification.avs(
)

pprint(response)

Parameters

Name Type Description Notes
type str [optional]
country str [optional]
currency str [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]

fetch_banks

Response fetch_banks(country=country, pay_with_bank_transfer=pay_with_bank_transfer, use_cursor=use_cursor, per_page=per_page, next=next, previous=previous, gateway=gateway)

Fetch Banks

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'


# Fetch Banks

response = paystack.Verification.fetch_banks(
)

pprint(response)

Parameters

Name Type Description Notes
country str [optional]
pay_with_bank_transfer bool [optional]
use_cursor bool [optional]
per_page int [optional]
next str [optional]
previous str [optional]
gateway str [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]

list_countries

Response list_countries()

List Countries

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 Countries

response = paystack.Verification.list_countries()


pprint(response)

Parameters

This endpoint does not need any parameter.

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]

resolve_account_number

Response resolve_account_number(account_number=account_number, bank_code=bank_code)

Resolve Account Number

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'


# Resolve Account Number

response = paystack.Verification.resolve_account_number(
)

pprint(response)

Parameters

Name Type Description Notes
account_number int [optional]
bank_code int [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]

resolve_card_bin

Response resolve_card_bin(bin)

Resolve Card BIN

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'

bin = 'bin_example' # str | 

# Resolve Card BIN

response = paystack.Verification.resolve_card_bin(
    bin,
)

pprint(response)

Parameters

Name Type Description Notes
bin str

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]