China Banks

The China Banks is similar to the Banks endpoint, just for Chinese based banking institutions.

Data Types

ChinaBankResponse

KeyValue
typechina-banks
idUUID
Attributes
nameString
cn_nameString
llp_idString
created-atTimestamp
updated-atTimestamp

ChinaBankResponse Example

{
  "data": {
    "type": "china-banks",
    "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
    "attributes": {
      "name": "Bank of China",
      "cn_name": "中国银行",
      "llp_id": "1040000"
    }
  }
}

GET/v1/china-banks

List China Banks

This endpoint retrieves a paginated list of China Banks. By default, a maximum of thirty China Banks are shown per page.

This endpoint returns an array of ChinaBankResponse objects.

Request

GET
/v1/china-banks
    curl --request GET \
          --url https://api.opentransact.com/v1/china-banks \
          --header 'Authorization: Basic {API_KEY}'

Response

{
  "data": [
    {
      "type": "china-banks",
      "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
      "attributes": {
        "name": "Bank of China",
        "cn_name": "中国银行",
        "llp_id": "1040000",
        "created-at": "2022-06-21T23:34:04Z",
        "updated-at": "2022-06-21T23:34:04Z"
      }
    },
    ... // 5 more China Banks
  ],
  "meta": {
    "page-count": 2,
    "count": 36,
    "current-page": 1
  },
  "links": {
    "self": "https://api.opentransact.com/v1/china-banks?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "first": "https://api.opentransact.com/v1/china-banks?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "next": "https://api.opentransact.com/v1/china-banks?page%5Bnumber%5D=2&page%5Bsize%5D=30",
    "last": "https://api.opentransact.com/v1/china-banks?page%5Bnumber%5D=2&page%5Bsize%5D=30"
  }
}

GET/v1/china-banks/:id

Show a China Bank

This endpoint retrieves a China Bank by providing its ID.

This endpoint returns a ChinaBankResponse object.

Request

GET
/v1/china-banks/Nc6yKKMpcxiiFxp6
  curl --request GET \
        --url https://api.opentransact.com/v1/china-banks/{CHINA_BANK_ID} \
        --header 'Authorization: Basic {API_KEY}'

Response

{
  "data": {
    "type": "china-banks",
    "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
    "attributes": {
      "name": "Bank of China",
      "cn_name": "中国银行",
      "llp_id": "1040000",
      "created_at": "2024-05-01T00:00:00Z",
      "updated_at": "2024-05-01T00:00:00Z"
    }
  }
}

Was this page helpful?