Card Bin Lookup

This page provides detailed information about the Bank BIN Lookup and Address Verification API endpoints, explaining how to retrieve bank details using a BIN number and how to verify the validity of an address. These APIs are essential for ensuring the accuracy of financial and address-related data.

In this guide, you’ll find:

Instructions on how to retrieve bank information based on a BIN number.
Guidance on verifying the validity of an address, including checking state and zip code accuracy.
Example code for interacting with APIs in a payment system environment.

Sample Requests for Card Bin Lookup

Curl sample request to nonprod-atl

---curl --request GET
--url http://natl-ksvc-eos-payment.corp.pps.io/bank/v1/bin/52008282
--header 'Accept: /'
--header 'Accept-Encoding: gzip, deflate, br'
--header 'Connection: keep-alive'
--header 'User-Agent: EchoapiRuntime/1.1.0'
--header 'authorization: EOS_Some_tenant_token'
--header 'eos-replication-group: nonprod'

"/bank/v1/bin/{binNumber}": {
            "get": {
                "summary": "Retrieve the bank information based on the bin number provided",
                "description": "Retrieves a specific bank bin from the database and returns all related information. If the bin number cannot be located, a lookup will be attempted against https://lookup.binlist.net. The result of this lookup will be stored in the database for future retrieval.",
                "security": [{
                    "tenantToken": []
                }],
                "parameters": [{
                    "name": "binNumber",
                    "in": "path",
                    "required": true,
                    "allowEmptyValue": false,
                    "schema": {
                        "type": "string",
                        "minLength": 6,
                        "maxLength": 8,
                        "pattern": "^[0-9]{6,10}$"
                    }
                }],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/BankBin"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Bin number is missing or invalid."
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The provided bin number is not found."
                    }
                }
            }
        }

Sample Response

{
    "bank": {
        "name": "VISA BELGIUM",
        "phone": "011- 42658208",
        "www": "www.vfs-be-in.com"
    },
    "bin": "45066300",
    "brand": "visa",
    "country": {
        "abbreviation2": "BE",
        "iso": "056",
        "name": "Belgium"
    },
    "created": "2020-04-27T21:25:39.881Z",
    "creator": {
        "id": "system",
        "user": "system"
    },
    "id": "45066300",
    "modified": "2020-04-27T21:25:39.881Z",
    "modifier": {
        "id": "system",
        "user": "system"
    },
    "source": "lookup.binlist.net",
    "type": "credit"
}

Vortex EOS provides the ability to verify that a given address is an actual address and is not missing any parts.

Request

"/address/v1/verify": {
	"post": {
		"summary": "Verify the given address is valid",
		"description": "Verifies that the address given is a valid address.",
		"security": [
	{
		"tenantToken": []
	}
	],
    "parameter":{
  		"addressline1": "1366 Northgate Cir",
  		"addressline2": "#G-210-C",
  		"city": "Oviedo",
  		"countryCode": "US",
  		"state": "FL",
  		"zip": "32765"
}

Sample Response

// Valid response
{
    "result": []
}
// Invalid response
{
    "result": [
        {
            "code": "ST1",
            "message": "invalid state"
        },
        {
            "code": "ZC1",
            "message": "invalid zip code"
        }
    ]
}

Code example

// Card-batch get route
const {PaymentClient} = require('@pps/broker-client');
const client = new PaymentClient('EOS_TENANT_TOKEN', 'environment');

try {
await client.open();
const id = await client.rpc.cardBatch.get('some-external-id');
console.log(id);
} finally {
await client.close();
}