Adyen · Schema

GrantOffer

PaymentsFinancial ServicesFintech

Properties

Name Type Description
accountHolderId string The identifier of the account holder to which the grant is offered.
amount object The principal amount of the grant.
contractType string The contract type of the grant offer. Possible value: **cashAdvance**, **loan**.
expiresAt string The end date of the grant offer validity period.
fee object Details of the fee configuration.
id string The unique identifier of the grant offer.
repayment object Details of the repayment configuration.
startsAt string The starting date of the grant offer validity period.
View JSON Schema on GitHub

JSON Schema

adyen-grantoffer-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GrantOffer",
  "title": "GrantOffer",
  "properties": {
    "accountHolderId": {
      "description": "The identifier of the account holder to which the grant is offered.",
      "type": "string"
    },
    "amount": {
      "description": "The principal amount of the grant.",
      "$ref": "#/components/schemas/Amount"
    },
    "contractType": {
      "description": "The contract type of the grant offer. Possible value: **cashAdvance**, **loan**.",
      "enum": [
        "cashAdvance",
        "loan"
      ],
      "type": "string"
    },
    "expiresAt": {
      "description": "The end date of the grant offer validity period.",
      "format": "date-time",
      "type": "string"
    },
    "fee": {
      "description": "Details of the fee configuration.",
      "$ref": "#/components/schemas/Fee"
    },
    "id": {
      "description": "The unique identifier of the grant offer.",
      "type": "string"
    },
    "repayment": {
      "description": "Details of the repayment configuration.",
      "$ref": "#/components/schemas/Repayment"
    },
    "startsAt": {
      "description": "The starting date of the grant offer validity period.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "accountHolderId"
  ],
  "type": "object"
}