ADadyen
Grant offers

Get a grant offer

Changed on

Returns the details of a single grant offer.

get/grantOffers/{grantOfferId}

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/grantOffers/{grantOfferId}
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

Path parameters

grantOfferIdstring required

The unique identifier of the grant offer.

Response

OK - the request has succeeded.

accountHolderIdstring required

The identifier of the account holder to which the grant is offered.

contractType'cashAdvance' | 'loan'

The contract type of the grant offer. Possible value: cashAdvance, loan.

expiresAtstring date-time

The end date of the grant offer validity period.

idstring

The unique identifier of the grant offer.

startsAtstring date-time

The starting date of the grant offer validity period.

Changes

  • v2dd6159049c95Revision changes
    • breaking

      the / response property's maxLength was unset from 3 for the response status

    • breaking

      the // response property's maxLength was unset from 3 for the response status

    • breaking

      the /// response property's maxLength was unset from 3 for the response status

    • breaking

      the / response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the // response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the /// response property's minLength was decreased from 3 to 0 for the response status

  • v27ab1c2b70cc4Revision changes
    • info

      endpoint deprecated