{"title":"Static financing offers","category":"default","creationDate":1778252958,"content":"

Limited availability<\/strong><\/span><\/span>
\nVariable repayment terms (90, 180, and 360 days) for financing offers are currently in a pilot phase. To request access, reach out to your Adyen contact.<\/p>\n

\n

Adyen supports static financing offers through the Capital API<\/a>. Based on their processing history, users may receive up to nine offers with fixed financing amounts and repayment terms of 90, 180, and 360 days. You can then show these predefined offers in your user interface (UI).<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n\n\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nYou must have an Adyen for Platforms integration that supports Capital.<\/td>\n<\/tr>\n
API credentials<\/strong><\/td>\nYou must have a Balance Platform API key<\/a> (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]<\/strong><\/span>) to access the Capital API<\/a>.Your API credential must have the following roles:
  • Balance Platform Capital Configuration role<\/strong><\/li>
  • Balance Platform Capital Grant Initiation role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Capabilities<\/strong><\/td>\nMake sure that your user have the following capability<\/a>:
  • getGrantOffers<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n
Limitations<\/strong><\/td>\nThe grant offer remains valid for seven days. After this period, a new offer is generated for an account holder if they still meet the qualification criteria. The amount of the grant offer may differ from one offer to another.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nBefore you begin, make sure you followed our compliance guidelines for Capital<\/a> when creating user interfaces, marketing materials, and other processes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Get static offers available to an account holder<\/h2>\n
\n

This API request also returns static offers created using the dynamic offers flow<\/a>.<\/p>\n<\/div><\/div>\n

To get static offers available to your user:<\/p>\n

    \n
  1. \n

    Make a GET \/grantOffers<\/a> request with the receiving accountHolderId<\/a> as a query parameter.<\/p>\n

  2. \n

    In the response, review the grantOffers<\/a> object, which contains the following parameters for each static offer returned.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    accountHolderId<\/a><\/td>\nThe unique identifier of the receiving account holder.<\/td>\n<\/tr>\n
    amount<\/a><\/td>\nAn object containing the amount of the grant, in minor units<\/a>.<\/td>\n<\/tr>\n
    contractType<\/a><\/td>\nThe legal type of the grant offer. Possible values: loan<\/strong><\/span>, cashAdvance<\/strong><\/span>.<\/td>\n<\/tr>\n
    expiresAt<\/a><\/td>\nThe expiration date and time of the offer validity period.<\/td>\n<\/tr>\n
    fee<\/a><\/td>\nAn object containing the fee currency and value, in minor units<\/a>.<\/td>\n<\/tr>\n
    id<\/a><\/td>\nThe unique identifier of the static offer.<\/td>\n<\/tr>\n
    repayment<\/a><\/td>\nAn object containing the details of the repayment configuration.<\/td>\n<\/tr>\n
    repayment.basisPoints<\/a><\/td>\nThe repayment amount, in basis points<\/a>, that is deducted daily from your user's incoming net volume.<\/td>\n<\/tr>\n
    repayment.term.estimatedDays<\/a><\/td>\nThe estimated term for repaying the grant, in days.<\/td>\n<\/tr>\n
    repayment.term.maximumDays<\/a><\/td>\nThe maximum term for repaying the grant, in days. Only returned when contractType<\/code> is loan<\/strong><\/span>.<\/td>\n<\/tr>\n
    repayment.threshold<\/a><\/td>\nAn object containing the details of the minimum threshold amount that your user must repay every 30-day period.<\/td>\n<\/tr>\n
    startsAt<\/a><\/td>\nThe starting date and time of the offer validity period.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    The following example shows three static offers for each available repayment term for the account holder AH00000000000000000000001<\/strong>.<\/p>\n

    \n<\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n

    Get a specific static offer<\/h2>\n
    \n

    This API request also returns static offers created using the dynamic offers flow<\/a>.<\/p>\n<\/div><\/div>\n

    To get the details of a specific static offer:<\/p>\n

      \n
    1. \n

      Make a GET \/grantOffers\/{id}<\/a> request, specifying the id<\/a> in the path.<\/p>\n

    2. \n

      In the response, note an object containing all the information about the offer.<\/p>\n

      \n<\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n

      Get notified about a static offer created<\/h2>\n

      You can get updates every time a new static offer is created for an account holder by subscribing to the balancePlatform.balanceAccountHolder.capitalOffer.created<\/a> webhook.<\/p>\n

      The webhook includes information about the offer, such as:<\/p>\n