Yedpay

Description (Bank Code List)

Show the bank code information(GET)

Queries

In order to search you can add in the url the follow parameters

  • institution_name
  • clearing_code
  • search_bank (Search institution_name and clearing_code)

End Point

https://api.yedpay.com/v1/bankinfo/bank-codes

Variable

# Name Type Description

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description

Response

# Name Type Description
1 success Boolean Request Bank Code List Success or Fail
2 data Array Include all Bank Information (clearing code, institution name etc...)
3 meta Array Include all Pagination's Information (total, count, total_pages, etc..)

Success Response - data

# Name Type Description
1 institution_name String Name of the bank
2 clearing_code String Bank code of the bank

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "institution_name": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                        "clearing_code": "xxx"                        
                    },
                    {
                        "institution_name": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                        "clearing_code": "xxx"                        
                    },

                ],
                "meta": {
                    "pagination": {
                        "total": 2,
                        "count": 2,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

v1.34.0-20200317 © The Payment Cards Group Limited. All rights reserved.