{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:openfintech/get-banks":{"get":{"operationId":"finance_openfintech_get_banks","summary":"List of banks","description":"GET /banks","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[sort_code]","in":"query","required":false,"description":"Filtering by banks code.","schema":{"type":"string","description":"Filtering by banks code."}},{"name":"filter[code]","in":"query","required":false,"description":"Filtering by code.","schema":{"type":"string","description":"Filtering by code."}},{"name":"filter[status]","in":"query","required":false,"description":"Filtration by status.","schema":{"type":"array","description":"Filtration by status."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | status | -status | | sort_code | -sort_code |","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | status | -status | | sort_code | -sort_code |"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-banks-id":{"get":{"operationId":"finance_openfintech_get_banks_id","summary":"Bank by ID","description":"GET /banks/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-countries":{"get":{"operationId":"finance_openfintech_get_countries","summary":"List of countries","description":"GET /countries","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[region]","in":"query","required":false,"description":"Filtration by region.","schema":{"type":"array","description":"Filtration by region."}},{"name":"filter[sub_region]","in":"query","required":false,"description":"Filtration by sub region.","schema":{"type":"array","description":"Filtration by sub region."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | area | -area | | population | -population | | region | -region | |…","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | area | -area | | population | -population | | region | -region | |…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-countries-id":{"get":{"operationId":"finance_openfintech_get_countries_id","summary":"Country by ID","description":"GET /countries/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-currencies":{"get":{"operationId":"finance_openfintech_get_currencies","summary":"List of currencies","description":"GET /currencies","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[search]","in":"query","required":false,"description":"Full text search with name, code, type, code_iso_alpha3, code_jsons_alpha, code_estandards_alpha, category.","schema":{"type":"string","description":"Full text search with name, code, type, code_iso_alpha3, code_jsons_alpha, code_estandards_alpha, category."}},{"name":"filter[code_iso_alpha3]","in":"query","required":false,"description":"Filtering by ISO code.","schema":{"type":"string","description":"Filtering by ISO code."}},{"name":"filter[code_iso_numeric3]","in":"query","required":false,"description":"Filtering by ISO number.","schema":{"type":"integer","description":"Filtering by ISO number."}},{"name":"filter[code_estandards_alpha]","in":"query","required":false,"description":"Filtering by estandards code.","schema":{"type":"string","description":"Filtering by estandards code."}},{"name":"filter[currency_type]","in":"query","required":false,"description":"Filtration by currency type.","schema":{"type":"array","description":"Filtration by currency type."}},{"name":"filter[category]","in":"query","required":false,"description":"Filtration by category.","schema":{"type":"array","description":"Filtration by category."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | type | -type | | category | -category | | code | -code | | code_iso_alpha3 |…","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | type | -type | | category | -category | | code | -code | | code_iso_alpha3 |…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-currencies-id":{"get":{"operationId":"finance_openfintech_get_currencies_id","summary":"Currency by ID","description":"GET /currencies/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-deposit-methods":{"get":{"operationId":"finance_openfintech_get_deposit_methods","summary":"List of deposit methods","description":"GET /deposit-methods","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[search]","in":"query","required":false,"description":"Full text search with id, name, code, category.","schema":{"type":"string","description":"Full text search with id, name, code, category."}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}},{"name":"filter[code]","in":"query","required":false,"description":"Filtering by code.","schema":{"type":"string","description":"Filtering by code."}},{"name":"filter[processor_name]","in":"query","required":false,"description":"Filtering by processor_name.","schema":{"type":"string","description":"Filtering by processor_name."}},{"name":"filter[category]","in":"query","required":false,"description":"Filtering by category.","schema":{"type":"array","description":"Filtering by category."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | processor_name | -processor_name | | category | -category |","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | processor_name | -processor_name | | category | -category |"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-deposit-methods-id":{"get":{"operationId":"finance_openfintech_get_deposit_methods_id","summary":"Deposit method by ID","description":"GET /deposit-methods/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-exchangers":{"get":{"operationId":"finance_openfintech_get_exchangers","summary":"List of exchangers","description":"GET /exchangers","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}},{"name":"filter[status]","in":"query","required":false,"description":"Filtration by status.","schema":{"type":"array","description":"Filtration by status."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | status | -status | | wmid | -wmid | | rate_type | -rate_type | |…","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | status | -status | | wmid | -wmid | | rate_type | -rate_type | |…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-exchangers-id":{"get":{"operationId":"finance_openfintech_get_exchangers_id","summary":"Exchanger by ID","description":"GET /exchangers/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-merchant-industries":{"get":{"operationId":"finance_openfintech_get_merchant_industries","summary":"List of merchant industries","description":"GET /merchant-industries","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-merchant-industries-id":{"get":{"operationId":"finance_openfintech_get_merchant_industries_id","summary":"Merchant industry by ID","description":"GET /merchant-industries/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-organizations":{"get":{"operationId":"finance_openfintech_get_organizations","summary":"List of organizations","description":"GET /organizations","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[search]","in":"query","required":false,"description":"Full text search with id, name, code.","schema":{"type":"string","description":"Full text search with id, name, code."}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}},{"name":"filter[code]","in":"query","required":false,"description":"Filtering by code.","schema":{"type":"string","description":"Filtering by code."}},{"name":"filter[status]","in":"query","required":false,"description":"Filtration by status.","schema":{"type":"array","description":"Filtration by status."}},{"name":"filter[industries]","in":"query","required":false,"description":"Filtering by industries.","schema":{"type":"string","description":"Filtering by industries."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | status | -status | | description | -description |","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | status | -status | | description | -description |"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-organizations-id":{"get":{"operationId":"finance_openfintech_get_organizations_id","summary":"Organization by ID","description":"GET /organizations/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-payment-methods":{"get":{"operationId":"finance_openfintech_get_payment_methods","summary":"List of payment methods","description":"GET /payment-methods","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[search]","in":"query","required":false,"description":"Full text search with id, name, code, category.","schema":{"type":"string","description":"Full text search with id, name, code, category."}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}},{"name":"filter[code]","in":"query","required":false,"description":"Filtering by code.","schema":{"type":"string","description":"Filtering by code."}},{"name":"filter[processor_name]","in":"query","required":false,"description":"Filtering by processor_name.","schema":{"type":"string","description":"Filtering by processor_name."}},{"name":"filter[category]","in":"query","required":false,"description":"Filtering by category.","schema":{"type":"array","description":"Filtering by category."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | processor_name | -processor_name | | category | -category |","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code | | processor_name | -processor_name | | category | -category |"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-payment-methods-id":{"get":{"operationId":"finance_openfintech_get_payment_methods_id","summary":"Payment method by ID","description":"GET /payment-methods/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-payment-providers":{"get":{"operationId":"finance_openfintech_get_payment_providers","summary":"List of payment providers","description":"GET /payment-providers","tags":["finance"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Current page number.","schema":{"type":"integer","description":"Current page number."}},{"name":"page[size]","in":"query","required":false,"description":"Page size. *Default value: 100*","schema":{"type":"integer","description":"Page size. *Default value: 100*"}},{"name":"filter[search]","in":"query","required":false,"description":"Full text search with id, code, name.","schema":{"type":"string","description":"Full text search with id, code, name."}},{"name":"filter[name]","in":"query","required":false,"description":"Filtering by name.","schema":{"type":"string","description":"Filtering by name."}},{"name":"filter[code]","in":"query","required":false,"description":"Filtering by code.","schema":{"type":"string","description":"Filtering by code."}},{"name":"filter[types]","in":"query","required":false,"description":"Filtering by types.","schema":{"type":"array","description":"Filtering by types."}},{"name":"filter[sales_channels]","in":"query","required":false,"description":"Filtering by sales channels.","schema":{"type":"array","description":"Filtering by sales channels."}},{"name":"filter[features]","in":"query","required":false,"description":"Filtering by features.","schema":{"type":"array","description":"Filtering by features."}},{"name":"sort","in":"query","required":false,"description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code |","schema":{"type":"array","description":"Sort params: | ASC | DESC | |-----|------| | name | -name | | code | -code |"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:openfintech/get-payment-providers-id":{"get":{"operationId":"finance_openfintech_get_payment_providers_id","summary":"Payment provider by ID","description":"GET /payment-providers/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID.","schema":{"type":"string","description":"Unique ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}