Sign in
Capital

Request a grant payout

Requests the payout of the selected grant offer.

post/grants

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

grantAccountIdstring required

The identifier of the grant account used for the grant.

grantOfferIdstring required

The identifier of the grant offer that has been selected and from which the grant details will be used.

Response

OK - the request has succeeded.

grantAccountIdstring required

The identifier of the grant account used for the grant.

grantOfferIdstring required

The identifier of the grant offer that has been selected and from which the grant details will be used.

idstring required

The identifier of the grant reference.

status'Pending' | 'Active' | 'Repaid' | 'Failed' | 'WrittenOff' | 'Revoked' required

The current status of the grant. Possible values: Pending, Active, Repaid, WrittenOff, Failed, Revoked.

Changes

Changed in 12 of the 51 revisions of this API.62213

  • v3514d1ed036e12See the full diff
    • ○

      api tag Capital added

      api-tag-added

    • ○

      api tag Capital (deprecated) removed

      api-tag-removed

  • v32188d062ff1b62See the full diff
    • ▲

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

      response-property-max-length-unset

    • ▲

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

      response-property-max-length-unset

    • ▲

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

      response-property-max-length-unset

    • ▲

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

      response-property-min-length-decreased

    • ▲

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

      response-property-min-length-decreased

    • ▲

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

      response-property-min-length-decreased

    • ○

      api tag Capital (deprecated) added

      api-tag-added

    • ○

      api tag Capital removed

      api-tag-removed

  • v32a8ee40b9ac31See the full diff
    • ●

      removed the request property /

      request-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3bc888fe170cf3See the full diff
    • ●

      added the new Failed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new Revoked enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WrittenOff enum value to the response property for the response status

      response-property-enum-value-added

  • v36f904aa6b8033See the full diff
    • ○

      removed the Failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Revoked enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the WrittenOff enum value from the response property for the response status

      response-property-enum-value-removed

  • v3bc888fe170cf3See the full diff
    • ●

      added the new Failed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new Revoked enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WrittenOff enum value to the response property for the response status

      response-property-enum-value-added

  • v36f904aa6b8033See the full diff
    • ○

      removed the Failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Revoked enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the WrittenOff enum value from the response property for the response status

      response-property-enum-value-removed

  • v3bc888fe170cf3See the full diff
    • ●

      added the new Failed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new Revoked enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WrittenOff enum value to the response property for the response status

      response-property-enum-value-added

  • v3b53fe3b6fff61See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • v3ec02d539f7541See the full diff
    • ○

      the endpoint scheme security clientKey was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog