Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Grants API

The Grants API from Adyen — 2 operation(s) for grants.

Adyen Grants API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Grants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

3 operations 2 paths 13 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Grants API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Grants 3
GET
/grants
Adyen Get a Capital Account
get-grants 1 param → 200400401403404422500
POST
/grants
Adyen Request a Grant Payout
post-grants body → 200400401403404422500
GET
/grants/{id}
Adyen Get Grant Reference Details
get-grants-id 1 param → 200400401403404422500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CapitalGrant (9 properties), RestServiceError (9 properties), CapitalBalance (4 properties), CapitalGrantInfo (3 properties). Each schema is shown below with its type and property counts.

Fee
object
1 property 1 required
Repayment
object
3 properties 1 required
RepaymentTerm
object
2 properties 1 required
RestServiceError
object
9 properties 5 required
CapitalBalance
object
4 properties 4 required
Amount
object
2 properties 2 required
Counterparty
object
3 properties
CapitalGrant
object
9 properties 5 required
ThresholdRepayment
object
1 property 1 required
JSONObject
object
CapitalGrantInfo
object
3 properties 2 required
CapitalGrants
object
1 property 1 required
InvalidField
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-grants-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API