HomeSupportStatusSign in ->

Visa

What kind of data I will get

The Termination Inquiry API enables Acquirers to identify Merchants and Agents previously terminated by other Acquirers, retrieving termination details directly from the Terminated Listing Database.

Input

Attribute
Type
Description
Required

city

string

The city of the merchant's or agent's registered address. Example: "St Albans"

Yes

countryOrRegion

string

The country or region of the merchant's or agent's registered address. Example: "JP"

Yes

streetAddress

string

The street details of the merchant's or agent's registered address that should include, in this order as applicable: building number/name, street number and name, shop number, floor number. Example: "80 Wood Street"

Yes

stateOrProvince

string

The state or province of the merchant's or agent's registered address. Example: "CA"

No

zipOrPostalCode

string

The postal code or zip code for the merchant's or agent's registered address. Example: "SA82GF"

No

businessPhoneNumber

string

Business phone number of the merchant's or agent.

Yes

category

string

Business Category of the Terminated Record. Possible values:

  • INDEPENDENT_SALES_ORGANIZATION

  • MERCHANT

  • PAYMENT_FACILITATOR

  • MARKETPLACE

  • STAGED_DIGITAL_WALLET_OPERATOR

  • SPONSORED_MERCHANT

Yes

dbaName

string

The “Doing-Business-As” Name that the merchant or agent operates under. Example: "Snap Photoshop Ltd"

Yes

principal

array<object>

Principals of the terminated record.

Yes

tradeOverInternet

boolean

An indicator identifying if the merchant or agent trades over the Internet.

Yes

businessEmailAddress

string

The primary email address registered for the merchant or agent.

No

businessRegistrationNumber

string

A Business Registration Number such as Commercial Registration, Ministry of Commerce certificate number or equivalent registration number for the merchant or agent. Example: "452349600005"

No

merchantCategoryCode

string

No

legalName

string

The parent or holding company legally registered name if this name is different from the Trading Name/DBA Name. For a sole proprietor, this field shall be omitted.

Example: "Snap Photoshop Ltd"

No

taxId

string

A Tax Identification Code registered for the merchant or agent; for example, a Value Added Tax (VAT) Number in the UK or a Federal Tax ID Number in US. Example: "GB123456789"

No

webAddress

string

Web address of the merchant or agent. Example: ["https://u.nu"]

Yes

account

object

Financial account of the terminated record.

No

Principal Input

Attribute
Type
Description
Required

name

string

The name of the individual that is registered as the merchant or agent principal/owner.

Yes

businessEmailAddress

string

The merchant or agent principal's/owner’s corporate/business email address.

No

businessPhoneNumber

string

The merchant or agent principal's/owner’s corporate/business contact number.

No

driverLicenseNumber

string

The merchant or agent principal's/owner’s driver license number.

No

passportNumber

string

The merchant or agent principal's/owner's passport number.

No

principalID

string

The merchant or agent principal's/owner’s id.

No

residentIDOrNationalID

string

The merchant or agent principal's/owner’s resident ID number or National ID number.

No

ssn

string

The merchant or agent principal's/owner’s social security number.

No

Financial Account Input

Attribute
Type
Description
Required

financialAccountNumber

string

A code assigned by a financial institution to uniquely identify a customer account within the financial institution.

No

financialInstitutionID

string

A unique code that identifies a Financial Institution; for example, Sort Code, SWIFT, Routing Number.

No

intBankAccountNumber

string

An International Bank Account Number that can be verified by a checksum.

No

Input example

{
  "city": "St Albans",
  "countryOrRegion": "AT",
  "streetAddress": "80 Wood Street",
  "businessPhoneNumber": "+861071111223",
  "category": "MERCHANT",
  "dbaName": "Snap Photoshop Ltd",
  "principal": {
      "name": "Bill Smith"
  },
  "webAddress": "https://u.nu",
  "tradeOverInternet": true
}

Output

Attribute
Type
Description

searchTerminatedResponse

object

Object containing response from Visa

status

object

Status of the response

Status

Attribute
Type
Description

statusCode

string

Status Code.

Example: "API000"

statusDescription

string

Example: "Success"

SearchTerminatedResponse

Attribute
Type
Description

possibleMatches

array<object>

Possible matches returned in response.

searchRequestRef

object

Search request reference.

Search Request Ref

Attribute
Type
Description

acquirerBID

string

Visa assigned Business Identifier (BID) of the Acquirer for the Search request.

Example: "10048640"

acquirerCountryOrRegion

string

The country or region of the Acquirer for the Search request.

Example: "JP"

globalSearch

boolean

An indicator identifying if the inquiry is worldwide or regional based. True means Global Search and False means Regional Search.

searchRequestRefID

string

A system-generated Search request reference id.

Example: "SRCH123412"

terminatedRecordSearchCriteria

object

Search criteria used in request to find terminated merchants.

Terminated Record Search Criteria

Attribute
Type
Description

address

object

Address of the merchant.

businessPhoneNumbers

array<string>

Business phone numbers of the merchant. Example: ["+871231123123"]

category

string

Business Category of the Terminated Record defined as follows: 0 = Merchant 1 = Payment Facilitator 2 = Independent Sales Organization 3 = Marketplace 4 = Staged Digital Wallet Operator 5 = Sponsored Merchant

DBAName

string

The “Doing-Business-As” Name that the merchant or agent operates under.

principals

array<object>

Individuals registered as the merchant or agent principal/owner.

tradeOverInternet

boolean

An indicator identifying if the merchant or agent trades over the Internet.

businessEmailAddress

string

The primary email address registered for the merchant or agent.

businessRegistrationNumber

string

A Business Registration Number such as Commercial Registration, Ministry of Commerce certificate number or equivalent registration number for the merchant or agent.

financialAccts

array<object>

Financial accounts of the merchant.

legalName

string

The parent or holding company legally registered name if this name is different from the Trading Name/DBA Name. For a sole proprietor, this field shall be omitted.

merchantCategoryCodes

array<string>

Merchant category codes. Example: ["5411"]

taxID

string

A Tax Identification Code registered for the merchant or agent; for example, a Value Added Tax (VAT) Number in the UK or a Federal Tax ID Number in US.

webAddresses

array<string>

Web addresses of the merchant.

Address

Attribute
Type
Description

city

string

The city of the merchant's or agent's registered address.

countryOrRegion

string

The country or region of the merchant's or agent's registered address.

streetAddress

string

The street details of the merchant's or agent's registered address that should include, in this order as applicable: building number/name, street number and name, shop number, floor number.

stateOrProvince

string

The state or province of the merchant's or agent's registered address.

zipOrPostalCode

string

The postal code or zip code for the merchant's or agent's registered address.

Principal

Attribute
Type
Description

name

string

The name of the individual that is registered as the merchant or agent principal/owner.

businessEmailAddress

string

The merchant or agent principal's/owner’s corporate/business email address.

businessPhoneNumber

string

The merchant or agent principal's/owner’s corporate/business contact number.

driverLicenseNumber

string

The merchant or agent principal's/owner’s driver license number.

passportNumber

string

The merchant or agent principal's/owner's passport number.

principalID

string

The merchant or agent principal's/owner’s id.

residentIDOrNationalID

string

The merchant or agent principal's/owner’s resident ID number or National ID number.

SSN

string

The merchant or agent principal's/owner’s social security number.

Financial Acct

Attribute
Type
Description

financialAccountNumber

string

A code assigned by a financial institution to uniquely identify a customer account within the financial institution.

financialInstitutionID

string

A unique code that identifies a Financial Institution; for example, Sort Code, SWIFT, Routing Number.

intBankAccountNumber

string

An International Bank Account Number that can be verified by a checksum.

Possible Matches

Attribute
Type
Description

matchedRecords

array<object>

Matched records returned in the response.

totalCount

integer

Number of possibly matched records returned in the response.

Matched Record

Attribute
Type
Description

acquirerBID

string

Visa assigned Business Identifier (BID) of the Acquirer for the terminated contract.

acquirerCountryOrRegion

string

The country or region of the Acquirer for the terminated contract.

acquirerName

string

Name of the Acquirer for the terminated contract.

terminatedRecord

object

terminatedRecordMatch

object

terminatedRefID

string

A system-generated terminated record reference identification number.

Terminated Record

Attribute
Type
Description

address

object

Address of the terminated record

businessPhoneNumbers

array<string>

Example: ["+861071111222"]

cardAcceptorIDs

array<string>

Example: ["12345678910111"]

category

string

Business Category of the Terminated Record defined as follows: 0 = Merchant 1 = Payment Facilitator 2 = Independent Sales Organization 3 = Marketplace 4 = Staged Digital Wallet Operator 5 = Sponsored Merchant

Example: "1"

contractEndDate

string

The date on which the merchant's or agent's contract agreement was terminated.

Example: "2019-11-14"

contractStartDate

string

The date on which the merchant's or agent's contract agreement was granted.

Example: "2019-11-01"

DBAName

string

The “Doing-Business-As” Name that the merchant or agent operates under.

Example: "Snap Photoshop Ltd"

incorportationStatus

string

The incorporation status registered for the merchant or agent defined as follows: 1 = Individual/Sole Proprietor 2 = Partnership 3 = Corporation 4 = Medical or Legal Corporation 5 = Association / Estate / Trust 6 = Non-Profit Organization -1 = Unknown (returned for legacy listings)

Example: "3"

primaryListingReason

string

The primary reason for the termination of the merchant's or agent's contract.

Example: "29-Bankruptcy/Liquidation/Insolvency"

principals

array<object>

Principals of the terminated record.

tradeInternationally

boolean

An indicator identifying if the merchant or agent trades across international borders or territories.

Example: true

tradeOverInternet

boolean

An indicator identifying if the merchant or agent trades over the Internet.

Example: false

acquirerAssignedMerchantID

string

A unique Merchant Identification Number assigned by the Acquirer. Mandatory for Merchant.

Example: "36654773"

businessEmailAddress

string

The primary email address registered for the merchant or agent.

Example: "billsmith@snapphoto.com"

businessRegistrationNumber

string

A Business Registration Number such as Commercial Registration, Ministry of Commerce certificate number or equivalent registration number for the merchant or agent.

Example: "452349600005"

financialAccts

array<object>

Financial accounts of terminated record.

legalName

string

The parent or holding company legally registered name if this name is different from the Trading Name/DBA Name. For a sole proprietor, this field shall be omitted.

Example: "Snap Photoshop Ltd"

merchantCategoryCodes

array<string>

Example: ["5411"]

paymentFacilitatorBID

string

The business ID as registered with Visa to uniquely identify a payment facilitator.

Example: "10000108"

paymentFacilitatorCountryOrRegion

string

The country or region of the payment facilitator.

Example: "JP"

secondaryListingReason

string

The secondary reason for the termination of the merchant's or agent's contract.

Example: "34-Merchant Identity Theft"

taxID

string

A Tax Identification Code registered for the merchant or agent; for example, a Value Added Tax (VAT) Number in the UK or a Federal Tax ID Number in US. Example: "GB123456789"

webAddresses

array<string>

Web addresses of terminated object. Example: ["https://u.nu"]

Terminated Record Match

Attribute
Type
Description

addressMatch

object

The object containing indicator of the address match.

businessEmailAddress

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

businessPhoneNumbers

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

businessRegistrationNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

DBAName

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

financialAcctsMatch

array<object>

The object containing indicator of the financial accounts match.

legalName

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

merchantCategoryCodes

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

principalsMatch

array<object>

The object containing indicator of the principals match.

taxID

string

he indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

tradeOverInternet

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

webAddresses

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

Address Match

Attribute
Type
Description

city

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

countryOrRegion

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

streetAddress

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

stateOrProvince

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

zipOrPostalCode

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

Financial Accts Match

Attribute
Type
Description

financialAccountNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

financialInstitutionID

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

intBankAccountNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

Principals Match

Attribute
Type
Description

name

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

businessEmailAddress

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

businessPhoneNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

driverLicenseNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

passportNumber

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

principalID

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

residentIDOrNationalID

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

SSN

string

The indicator of the match type for the data field. N = No Match E = Exact Match P = Partial Match

Example: "N"

Output example

{
    "status": {
        "statusCode": "API0000",
        "stausDescription": "SUCCESS"
    },
    "searchTerminatedResponse": {
        "possibleMatches": {
            "matchedRecords": [
                {
                    "acquirerBID": "ACQ123",
                    "acquirerCountryOrRegion": "Country1",
                    "acquirerName": "Acquirer1",
                    "terminatedRecord": {
                        "address": {
                            "city": "Dummy City",
                            "countryOrRegion": "Dummy Country",
                            "streetAddress": "123 Dummy Street",
                            "stateOrProvince": "Dummy State",
                            "zipOrPostalCode": "12345"
                        },
                        "businessPhoneNumbers": [
                            "123-456-7890",
                            "987-654-3210"
                        ],
                        "cardAcceptorIDs": [
                            "CardID1",
                            "CardID2"
                        ],
                        "category": "Category1",
                        "contractEndDate": "2023-12-31",
                        "contractStartDate": "2020-01-01",
                        "DBAName": "DBAName1",
                        "incorportationStatus": "Active",
                        "primaryListingReason": "Reason1",
                        "principals": [
                            {
                                "name": "Principal2",
                                "businessEmailAddress": "principal2@example.com",
                                "businessPhoneNumber": "555-5678",
                                "driverLicenseNumber": "DL654321",
                                "passportNumber": "PP012345",
                                "principalId": "P456",
                                "residentIdOrNationalId": "R456",
                                "ssn": "987-65-4321"
                            }
                        ],
                        "tradeInternationally": true,
                        "tradeOverInternet": true,
                        "acquirerAssignedMerchantID": "MerchantID1",
                        "businessEmailAddress": "business1@example.com",
                        "businessRegistrationNumber": "123456789",
                        "financialAccts": [
                            {
                                "financialAccountNumber": "FAN123456",
                                "financialInstitutionId": "FI123",
                                "intBankAccountNumber": "INTBANK789"
                            },
                            {
                                "financialAccountNumber": "FAN654321",
                                "financialInstitutionId": "FI456",
                                "intBankAccountNumber": "INTBANK012"
                            }
                        ],
                        "legalName": "LegalName1",
                        "merchantCategoryCodes": [
                            "MCC123",
                            "MCC456"
                        ],
                        "paymentFacilitatorBID": "PF123",
                        "paymentFacilitatorCountryOrRegion": "Country1",
                        "secondaryListingReason": "Reason2",
                        "taxID": "987-65-4321",
                        "webAddresses": [
                            "http://www.example1.com",
                            "https://www.sample1.com"
                        ]
                    },
                    "terminatedRecordMatch": {
                        "addressMatch": {
                            "street": "456 Oak St",
                            "city": "City2",
                            "state": "State2",
                            "zipCode": "54321",
                            "country": "Country2"
                        },
                        "businessEmailAddress": "business2@example.com",
                        "businessPhoneNumbers": "555-9876",
                        "businessRegistrationNumber": "987654321",
                        "DBAName": "DBAName2",
                        "financialAcctsMatch": [
                            {
                                "financialAccountNumber": "FAN987654",
                                "financialInstitutionId": "FI789",
                                "intBankAccountNumber": "INTBANK456"
                            },
                            {
                                "financialAccountNumber": "FAN321098",
                                "financialInstitutionId": "FI654",
                                "intBankAccountNumber": "INTBANK789"
                            }
                        ],
                        "legalName": "LegalName2",
                        "merchantCategoryCodes": "MCC789",
                        "principalsMatch": [
                            {
                                "name": "Principal3",
                                "businessEmailAddress": "principal3@example.com",
                                "businessPhoneNumber": "555-9876",
                                "driverLicenseNumber": "DL789012",
                                "passportNumber": "PP345678",
                                "principalId": "P789",
                                "residentIdOrNationalId": "R789",
                                "ssn": "987-65-4321"
                            }
                        ],
                        "taxID": "123-45-6789",
                        "tradeOverInternet": "true",
                        "webAddresses": [
                            "http://www.example2.com",
                            "https://www.sample2.com"
                        ]
                    },
                    "terminatedRefID": "RefID1"
                }
            ],
            "totalCount": 1
        },
        "searchRequestRef": {
            "searchRequestRefID": "SearchRefID1",
            "acquirerBID": "ACQ123",
            "acquirerCountryOrRegion": "Country1",
            "globalSearch": true,
            "terminatedRecordSearchCriteria": {
                "address": {
                    "city": "Dummy City",
                    "countryOrRegion": "Dummy Country",
                    "streetAddress": "123 Dummy Street",
                    "stateOrProvince": "Dummy State",
                    "zipOrPostalCode": "12345"
                },
                "businessPhoneNumbers": [
                    "123-456-7890",
                    "987-654-3210"
                ],
                "category": "Dummy Category",
                "DBAName": "Dummy DBA Name",
                "principals": [
                    {
                        "name": "Principal1",
                        "businessEmailAddress": "principal1@example.com",
                        "businessPhoneNumber": "555-1234",
                        "driverLicenseNumber": "DL123456",
                        "passportNumber": "PP789012",
                        "principalId": "P123",
                        "residentIdOrNationalId": "R123",
                        "ssn": "123-45-6789"
                    }
                ],
                "tradeOverInternet": true,
                "businessEmailAddress": "business@example.com",
                "businessRegistrationNumber": "123456789",
                "financialAccts": [
                    {
                        "financialAccountNumber": "FAN123456",
                        "financialInstitutionId": "FI123",
                        "intBankAccountNumber": "INTBANK789"
                    },
                    {
                        "financialAccountNumber": "FAN654321",
                        "financialInstitutionId": "FI456",
                        "intBankAccountNumber": "INTBANK012"
                    }
                ],
                "legalName": "Dummy Legal Name",
                "merchantCategoryCodes": [
                    "MCC123",
                    "MCC456"
                ],
                "taxID": "987-65-4321",
                "webAddresses": [
                    "http://www.example.com",
                    "https://www.sample.com"
                ]
            },
            "retroAlertIfNoMatch": false
        }
    }
}
PreviousVerificationsNextKYB

Last updated