跳到主要内容
FinCode

API reference

Every V1 endpoint at a glance.

本文档适用于 API V1。

Data API

Authenticated with an API key: Authorization: Bearer sk_...

MethodPathDescription
GET/v1/iban/validate?iban=Validate an IBAN.
GET/v1/iban/{iban}Validate an IBAN and resolve the bank (SWIFT/BIC, local-first).
GET/v1/swift/{code}Look up a SWIFT/BIC code.
GET/v1/routing/{number}Look up a US routing number.
GET/v1/sort-code/{code}Look up a UK sort code.
GET/v1/bsb/{code}Look up an Australian BSB.
GET/v1/ifsc/{code}Look up an Indian IFSC.
GET/v1/cnaps/{code}Look up a China CNAPS code.
GET/v1/bin/{bin}Look up a card BIN/IIN (brand, type and issuer).
GET/v1/banksList financial institutions.
GET/v1/banks/{id}Get one institution.
GET/v1/banks/search?q=Search institutions by name.
GET/v1/banks/by-slug/{slug}Get one institution by its URL slug.
GET/v1/banks/{id}/branchesList branches of an institution.
GET/v1/countriesList countries.
GET/v1/countries/{code}Get one country.
GET/v1/countries/{code}/iban-formatGet the IBAN format for a country.
GET/v1/lookup?q=Universal identifier lookup.

Developer portal

Account, organization, API key, billing and usage endpoints. Authenticated with a JWT access token from POST /v1/auth/login: Authorization: Bearer <access_token>.

MethodPathDescription
POST/v1/auth/registerCreate an account and its personal organization.
POST/v1/auth/loginExchange email and password for access and refresh tokens.
POST/v1/auth/refreshRotate a refresh token; the presented token is revoked.
POST/v1/auth/logoutRevoke the presented refresh token.
GET/v1/auth/meCurrent account profile and organizations.
POST/v1/auth/password-reset/requestRequest a single-use password reset token.
POST/v1/auth/password-reset/confirmConsume a reset token and set a new password.
GET/v1/organizationsOrganizations of the current account.
GET/v1/organizations/{id}Get one organization.
GET/v1/organizations/{id}/membersList members of an organization.
POST/v1/organizations/{id}/membersAdd a member by email (OWNER or ADMIN).
PATCH/v1/organizations/{id}/members/{memberId}Change a member role (OWNER only).
DELETE/v1/organizations/{id}/members/{memberId}Remove a member (OWNER or ADMIN).
POST/v1/api-keysCreate an API key; the plaintext key is returned once.
GET/v1/api-keysList API keys of the organization.
DELETE/v1/api-keys/{id}Revoke an API key (idempotent).
POST/v1/api-keys/{id}/rotateRevoke and replace an API key.
GET/v1/usageUsage summary with quota for the current month.
GET/v1/usage/endpointsPer-endpoint request counts and error rates.
GET/v1/usage/dailyDaily request counts for charts.
GET/v1/usage/keysPer-API-key request totals.
GET/v1/billingSubscription, plan and entitlement summary.
POST/v1/billing/checkoutStart a subscription checkout for a plan (OWNER only).
POST/v1/billing/subscriptions/{subscriptionId}/confirmConfirm a checkout after approval (OWNER only).
POST/v1/billing/subscriptions/{subscriptionId}/reviseUpgrade or downgrade a subscription (OWNER only).
POST/v1/billing/subscriptions/{subscriptionId}/cancelCancel a subscription (OWNER only).
GET/v1/billing/invoices?subscription_id=Invoices of a subscription.

Base URL

http
Production: https://api.ecommica.com/v1
Development: http://localhost:8080/v1