Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-061066160.9 KB
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.