Issuing: Balance Platform API (ranked 34 of 5138)https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/Issuing_Balance_Platform_API_56035a63_4b7c_41b6_921c_e45b9615f18c_yaml.yaml
The Balance Platform API enables you to create a platform, onboard users as account holders, create balance accounts, and issue cards.
For information about use cases, refer to Adyen Issuing.
Your Adyen contact will provide your API credential and an API key. To connect to the API, add an
X-API-Key header with the API key as the value, for example:
curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ...
Alternatively, you can use the username and password to connect to the API using basic authentication. For example:
curl -H "Content-Type: application/json" \ -U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \ ...
Balance Platform API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
https://balanceplatform-api-test.adyen.com/bcl/v1 ` ...
- Name: Adyen Developer Experience team
- Name: email@example.com
- Contact API maintainers
The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.
- OWASP issues detected: API7:2023
The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.
- The median response time of the API is 60.8 ms .
Get p50 under 220 ms to get a 4/5 score.
The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.
- Self compliance: response objects matched the declared response types.
- Server errors: the server did not return any 5xx error.
The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.
- Respects OpenAPI 3.1.0 schema specification.
- Contains comments and summaries.
- Contains examples.
- Does not contain duplicated objects.
The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!