Skip to main content
POST
Blacklist Query

Headers

api-key
string
required

Your Payvessel public API key

api-secret
string
required

Your Payvessel secret

Content-Type
enum<string>
required

Request content type

Available options:
application/json

Body

application/json
phone_number
string
required

Customer phone number

Example:

"08012345678"

bvn_no
string
required

Customer BVN

Example:

"22123456789"

nin
string
required

Customer NIN

Example:

"12345678901"

Response

Blacklist query response

success
boolean
required
Example:

true

message
string
required
Example:

"Blacklist query completed successfully"

data
object
required
charges
object
required