Adyen · Schema

CapitalGrant

PaymentsFinancial ServicesFintech

Properties

Name Type Description
amount object An object containing the amount of the grant, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
balances object An object containing the details of the existing grant.
counterparty object An object containing the details of the receiving party of the grant. Setting either an `accountHolderId`, `balanceAccountId`, or both is required.
fee object An object containing the fee currency and value, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
grantAccountId string The identifier of the grant account used for the grant.
grantOfferId string The identifier of the grant offer that has been selected and from which the grant details will be used.
id string The identifier of the grant reference.
repayment object An object containing the details of the 30-day repayment threshold.
status string The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.
View JSON Schema on GitHub

JSON Schema

adyen-capitalgrant-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CapitalGrant",
  "title": "CapitalGrant",
  "properties": {
    "amount": {
      "description": "An object containing the amount of the grant, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "$ref": "#/components/schemas/Amount"
    },
    "balances": {
      "description": "An object containing the details of the existing grant.",
      "$ref": "#/components/schemas/CapitalBalance"
    },
    "counterparty": {
      "description": "An object containing the details of the receiving party of the grant. Setting either an `accountHolderId`, `balanceAccountId`, or both is required.",
      "$ref": "#/components/schemas/Counterparty"
    },
    "fee": {
      "description": "An object containing the fee currency and value, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "$ref": "#/components/schemas/Fee"
    },
    "grantAccountId": {
      "description": "The identifier of the grant account used for the grant.",
      "type": "string"
    },
    "grantOfferId": {
      "description": "The identifier of the grant offer that has been selected and from which the grant details will be used.",
      "type": "string"
    },
    "id": {
      "description": "The identifier of the grant reference.",
      "type": "string"
    },
    "repayment": {
      "description": "An object containing the details of the 30-day repayment threshold.",
      "$ref": "#/components/schemas/Repayment"
    },
    "status": {
      "description": "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.",
      "enum": [
        "Pending",
        "Active",
        "Repaid"
      ],
      "type": "string"
    }
  },
  "required": [
    "grantAccountId",
    "grantOfferId",
    "id",
    "status",
    "balances"
  ],
  "type": "object"
}