{ "openapi": "3.0.0", "info": { "title": "fincodesapi.com API", "version": "2.0" }, "servers": [ { "url": "https://api.fincodesapi.com/" } ], "paths": { "/v2/iban/{iban}": { "get": { "tags": [ "IBAN" ], "summary": "IBAN lookup", "description": "Returns a single IBAN number information including it's BIC code", "operationId": "getIbanById", "parameters": [ { "name": "iban", "in": "path", "description": "IBAN code to return", "required": true, "schema": { "type": "string" }, "example": "FR1420041010050500013M02606" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Iban" } }, "type": "object" } } } }, "400": { "description": "Invalid IBAN" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/iban": { "post": { "tags": [ "IBAN" ], "summary": "IBAN lookup with Verification of Payee (VoP) for SEPA IBANs", "description": "Verifies the payee name against the IBAN account holder and returns the IBAN information, including it's BIC code, with the match result", "operationId": "verificationOfPayee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "iban", "payee_name" ], "properties": { "iban": { "description": "IBAN code to verify", "type": "string", "example": "DE75512108001245126199" }, "payee_name": { "description": "Payee name to match against the account holder", "type": "string", "example": "John Doe" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/IbanVop" } }, "type": "object" } } } }, "400": { "description": "Invalid IBAN" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" }, "402": { "description": "Insufficient VoP balance" }, "403": { "description": "VoP is not enabled for your account" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/bic/{bic}": { "get": { "tags": [ "BIC" ], "summary": "BIC lookup", "description": "Returns a single BIC code information", "operationId": "getBicById", "parameters": [ { "name": "bic", "in": "path", "description": "BIC code to return", "required": true, "schema": { "type": "string" }, "example": "NATAAU33033" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Bic" } }, "type": "object" } } } }, "400": { "description": "Invalid BIC/SWIFT" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/rtn/{rtn}": { "get": { "tags": [ "US ABA/RTN" ], "summary": "ABA/RTN lookup", "description": "Returns a single US ABA/RTN information", "operationId": "getRtnById", "parameters": [ { "name": "rtn", "in": "path", "description": "US ABA/RTN to return", "required": true, "schema": { "type": "string" }, "example": "026003780" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Rtn" } }, "type": "object" } } } }, "400": { "description": "Invalid US Routing Number. Routing Number format XXXXXXXXX" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/crn/{crn}": { "get": { "tags": [ "Canada Routing Number" ], "summary": "CRN lookup", "description": "Returns a single CRN number information", "operationId": "getCrnById", "parameters": [ { "name": "crn", "in": "path", "description": "Canada Routing Number to return", "required": true, "schema": { "type": "string" }, "example": "24182-001" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Crn" } }, "type": "object" } } } }, "400": { "description": "Invalid Canada Routing Number. Routing Number format XXXXX-YYY or 0YYYXXXXX" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/bsb/{bsb}": { "get": { "tags": [ "Australia BSB" ], "summary": "BSB lookup", "description": "Returns a single BSB number information", "operationId": "getBsbById", "parameters": [ { "name": "bsb", "in": "path", "description": "BSB number to return", "required": true, "schema": { "type": "string" }, "example": "082-024" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Bsb" } }, "type": "object" } } } }, "400": { "description": "Invalid BSB. BSB format XXX-YYY or XXXYYY" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/ncc/{ncc}": { "get": { "tags": [ "New Zealand NCC" ], "summary": "NCC lookup", "description": "Returns a single NCC code information", "operationId": "getNccById", "parameters": [ { "name": "ncc", "in": "path", "description": "NCC code to return", "required": true, "schema": { "type": "string" }, "example": "082-024" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Ncc" } }, "type": "object" } } } }, "400": { "description": "Invalid NCC. NCC format XXYYYY" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/ifsc/{ifsc}": { "get": { "tags": [ "India IFSC" ], "summary": "IFSC lookup", "description": "Returns a single IFSC code information", "operationId": "getIfscById", "parameters": [ { "name": "ifsc", "in": "path", "description": "IFSC code to return", "required": true, "schema": { "type": "string" }, "example": "ABHY0065022" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Ifsc" } }, "type": "object" } } } }, "400": { "description": "Invalid IFSC. IFSC format XXXX0YYYYYY" }, "401": { "$ref": "#/components/responses/401" }, "404": { "description": "Not found" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v2/clabe/{clabe}": { "get": { "tags": [ "Mexico CLABE" ], "summary": "CLABE lookup", "description": "Returns a single CLABE number information", "operationId": "getClabeById", "parameters": [ { "name": "clabe", "in": "path", "description": "CLABE code to return", "required": true, "schema": { "type": "string" }, "example": "002010077777777771" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "$ref": "#/components/schemas/success" }, "data": { "$ref": "#/components/schemas/Clabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/401" }, "400": { "description": "Invalid CLABE. Must be exactly 18 digits long. / Invalid CLABE. Checksum is incorrect" }, "404": { "description": "Bank not found / City not found" } }, "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "success": { "description": "Success", "type": "boolean", "example": true }, "pagination": { "properties": { "page_count": { "description": "Total pages count", "type": "integer", "example": 3 }, "current_page": { "description": "Current page", "type": "integer", "example": 1 }, "has_next_page": { "description": "Has next page", "type": "boolean", "example": true }, "has_prev_page": { "description": "Has previous page", "type": "boolean", "example": false }, "count": { "description": "Total items count", "type": "integer", "example": 232 }, "limit": { "description": "Items per page", "type": "integer", "example": 100, "nullable": true } }, "type": "object" }, "Bic": { "properties": { "id": { "description": "BIC code", "type": "string", "example": "HKBAAU2SBNE" }, "bank": { "$ref": "#/components/schemas/Bank" }, "country": { "$ref": "#/components/schemas/Country" }, "city": { "$ref": "#/components/schemas/City" }, "branch_name": { "description": "Branch name", "type": "string", "example": "Brisbane Branch" }, "branch_code": { "description": "Branch code", "type": "string", "example": "BNE" }, "address": { "description": "Address", "type": "string", "example": "Hongkongbank Building, 300 Queen Street" }, "postcode": { "description": "Postcode", "type": "string", "example": "4000" } }, "type": "object" }, "Iban": { "properties": { "id": { "description": "IBAN code", "type": "string", "example": "FR1420041010050500013M02606" }, "account_number": { "description": "Account number", "type": "string", "example": "0500013M02606" }, "national_bank_code": { "description": "National bank code", "type": "string", "example": "20041" }, "national_branch_code": { "description": "National branch code", "type": "string", "example": "01005" }, "bic": { "$ref": "#/components/schemas/Bic" }, "country": { "$ref": "#/components/schemas/Country" } }, "type": "object" }, "IbanVop": { "allOf": [ { "properties": { "payee_name_match": { "description": "Payee name match result", "type": "string", "enum": [ "MATCH", "CLOSE_MATCH", "NO_MATCH", "NOT_APPLICABLE", "BANK_UNAVAILABLE" ], "example": "MATCH", "nullable": true } }, "type": "object" }, { "$ref": "#/components/schemas/Iban" } ] }, "Ach": { "description": "Ach Entity", "properties": { "new_id": { "description": "Institution's new routing number resulting from a merger or renumber", "type": "string", "example": null, "nullable": true }, "servicing_frb_id": { "description": "Servicing Fed's main office routing number", "type": "string", "example": "021001208" }, "address": { "description": "Delivery Address", "type": "string", "example": "60 WALL STREET" }, "postcode": { "description": "Zipcode (including extension) in the delivery address", "type": "string", "example": "10005-0000" }, "phone": { "description": "Contact telephone number", "type": "string", "example": "201 593-7610" }, "record_type_code": { "description": "The code indicating the RTN number to be used to route or send ACH items to the RFI. 0 = Institution is a Federal Reserve Bank. 1 = Send items to customer routing number. 2 = Sent items to customer using new routing number field", "type": "integer", "example": 1 }, "is_main_office": { "description": "Main office (true) or branch (false)", "type": "boolean", "example": true }, "change_date": { "description": "Date of last change to CRF information (YYYY-MM-DD)", "type": "string", "example": "2021-01-11", "nullable": true }, "bank": { "$ref": "#/components/schemas/Bank" }, "city": { "$ref": "#/components/schemas/City" } }, "type": "object" }, "Bank": { "description": "Bank Entity", "properties": { "id": { "description": "Bank ID", "type": "string", "example": "d7744803-1288-4955-9f53-05eb26bbef8e" }, "country_id": { "description": "ISO 3166-1 alpha-2 country code", "type": "string", "example": "AU" }, "code": { "description": "4 letters bank code", "type": "string", "example": "NATA" }, "name": { "description": "Bank name", "type": "string", "example": "NATIONAL AUSTRALIA BANK LIMITED" } }, "type": "object" }, "Bsb": { "description": "Bsb Entity", "properties": { "id": { "description": "BSB code", "type": "string", "example": "082-024" }, "bank": { "$ref": "#/components/schemas/Bank" }, "branch_name": { "description": "Branch name", "type": "string", "example": "World Square" }, "address": { "description": "Address", "type": "string", "example": "Shp 10-33 Upp Gnd Lvl 686 George St" }, "suburb": { "description": "Suburb", "type": "string", "example": "Sydney" }, "state": { "description": "State", "type": "string", "example": "NSW" }, "postcode": { "description": "Postcode", "type": "string", "example": "2000" }, "peh": { "description": "Payment System. P = Paper, E = Electronic, H = High Value", "type": "string", "example": "PEH" } }, "type": "object" }, "City": { "description": "City Entity", "properties": { "id": { "description": "City ID", "type": "string", "example": "006d7479-8f26-4364-ab78-7e856d048b15" }, "country_id": { "description": "ISO 3166-1 alpha-2 country code", "type": "string", "example": "AU" }, "name": { "description": "City name", "type": "string", "example": "Sydney" } }, "type": "object" }, "Clabe": { "description": "Clabe Entity", "properties": { "id": { "description": "CLABE number", "type": "string", "example": "002010077777777771" }, "account_number": { "description": "Account number", "type": "string", "example": "07777777777" }, "city_code": { "description": "City code", "type": "string", "example": "010" }, "bank": { "$ref": "#/components/schemas/Bank" }, "cities": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } }, "type": "object" }, "Country": { "description": "Country Entity", "properties": { "id": { "description": "ISO 3166-1 alpha-2 country code", "type": "string", "example": "AU" }, "name": { "description": "Country name", "type": "string", "example": "Australia" } }, "type": "object" }, "Crn": { "description": "Crn Entity", "properties": { "id": { "description": "Canada Routing Number code", "type": "string", "example": "24182-001" }, "bank": { "$ref": "#/components/schemas/Bank" }, "branch_name": { "description": "Branch name", "type": "string", "example": "King & University" }, "address": { "description": "Address", "type": "string", "example": "200 King St. W." }, "city": { "description": "City", "type": "string", "example": "Toronto" }, "province": { "description": "Province", "type": "string", "example": "ON" }, "postcode": { "description": "Postcode", "type": "string", "example": "M5H 3T4" }, "institution_type": { "description": "Institution type. 1 = Banks, 2 = Credit Unions and Caisses Populaires, 3 = Trust Companies, Loan Companies and Other Deposit-taking Institutions", "type": "number", "example": "1" } }, "type": "object" }, "Ifsc": { "description": "Ifsc Entity", "properties": { "id": { "description": "IFSC code", "type": "string", "example": "ABHY0065022" }, "bank": { "$ref": "#/components/schemas/Bank" }, "branch_name": { "description": "Branch name", "type": "string", "example": "CBD BELAPUR" }, "branch_code": { "description": "Branch code", "type": "string", "example": "065022" }, "address": { "description": "Address", "type": "string", "example": "SECTOR-3, CHANAKYA SHOPPING CENTRE, BELAPUR (CBD), NAVI MUMBAI-400614" }, "district": { "description": "District", "type": "string", "example": "GREATER MUMBAI" }, "city": { "description": "City", "type": "string", "example": "MUMBAI" }, "state": { "description": "State", "type": "string", "example": "MAHARASHTRA" }, "std": { "description": "STD", "type": "string", "example": "22" }, "phone": { "description": "Phone", "type": "string", "example": "27572179" } }, "type": "object" }, "Ncc": { "description": "Ncc Entity", "properties": { "id": { "description": "NCC code", "type": "string", "example": "010338" }, "bank": { "$ref": "#/components/schemas/Bank" }, "branch_name": { "description": "Branch name", "type": "string", "example": "Kaitaia" }, "branch_code": { "description": "Branch code", "type": "string", "example": "0338" }, "address": { "description": "Address", "type": "string", "example": "107-109 Commerce Street" }, "city": { "description": "City", "type": "string", "example": "Kaitaia" }, "postcode": { "description": "Postcode", "type": "string", "example": "0410" }, "std": { "description": "STD", "type": "string", "example": "(09)" }, "phone": { "description": "Phone", "type": "string", "example": "0800 269 296" }, "fax": { "description": "Fax", "type": "string", "example": "408-1112" }, "pob_number": { "description": "PO Box Number", "type": "string", "example": "PO Box 18" }, "pob_location": { "description": "PO Box Location", "type": "string", "example": "Shortland Street, Auckland" }, "pob_postcode": { "description": "PO Box Postcode", "type": "string", "example": "1140" } }, "type": "object" }, "Rtn": { "description": "Rtn Entity", "properties": { "id": { "description": "ABA/RTN", "type": "string", "example": "026003780" }, "ach": { "$ref": "#/components/schemas/Ach" }, "wire": { "$ref": "#/components/schemas/Wire" } }, "type": "object" }, "Wire": { "description": "Wire Entity", "properties": { "telegraphic_name": { "description": "Telegraphic Name", "type": "string", "example": "DEUTSCHE BK NY" }, "is_funds_transfer_allowed": { "description": "Funds Transfer Status", "type": "boolean", "example": true }, "is_settlement_only": { "description": "Funds Settlement-Only Status", "type": "boolean", "example": false }, "is_securities_transfer_allowed": { "description": "Book-Entry Securities Transfer Status", "type": "boolean", "example": true }, "change_date": { "description": "Date of Last Revision (YYYY-MM-DD)", "type": "string", "example": null, "nullable": true }, "bank": { "$ref": "#/components/schemas/Bank" }, "city": { "$ref": "#/components/schemas/City" } }, "type": "object" } }, "responses": { "401": { "description": "API Key (X-Api-Key header) is missing or invalid" } }, "parameters": { "page": { "name": "page", "in": "query", "description": "Current page", "required": false, "schema": { "type": "integer", "minimum": 1 } }, "limit": { "name": "limit", "in": "query", "description": "Items per page (max 100)", "required": false, "schema": { "type": "integer", "maximum": 1, "minimum": 100 } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "X-Api-Key", "in": "header" } } } }