Tag Inquiry

post

https://{FQDN}:{PORT}/v2/clients/{ClientID}/tags/inquiry

Returns whether a tag is registered, its type, and the Visa Alias Directory directories that hold it. A tag that isn't found returns resolvable false.

Send the returned type, and one of the returned directories as directory, on Query Tag and Create Transaction.

Venmo and PayPal paynames are looked up through Visa+ and return no directories.

Path Params

ClientID

string

required

22-character ClientID. Ask TabaPay Support if you need to specify a SubClientID.

Body Params

network

string

required

The network of the tag.
Supported Networks:

Visa

value

string

required

The tag to look up, one per request:

An email address
A phone number: digits, with or without a leading +
A native alias, such as a Cash App $cashtag
A payname, +name.domain

3 to 320 characters with no control characters. A phone number's leading + isn't counted.

Don't send type: the response tells you the tag's type.

directory

string

^[A-Za-z0-9._-]{1,36}$

Look only in this directory.

Optional. Not used for Venmo and PayPal paynames.

excludedDirectory

string

^[A-Za-z0-9._-]{1,36}$

Don't look in this directory.

Optional. Not used for Venmo and PayPal paynames.

userName

string

^[A-Za-z0-9._-]{1,50}$

Your ID for the sender, which Visa uses for risk analysis. 1 to 50 letters, digits, ., _ or -. Don't send personal information such as a name, email address or phone number.

Optional. Not used for Venmo and PayPal paynames.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Whether the tag was found, with its type and directories.

207One or more Failures occurred while processing the Request.

400The request was refused. EM names the field to fix.