Get a capital account
Returns a list of grants with status and outstanding balances.
Query Parameters
The counterparty account holder id.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK
The request has succeeded.
Show moreShow lessgrantsarray[object]The unique identifier of the grant.
amountobjectAn object containing the amount of the grant, in minor units.
valueintegerThe amount of the transaction, in minor units.
balancesobjectAn object containing the details of the existing grant.
currencystringThe three-character ISO currency code.
feeintegerFee amount.
principalintegerPrincipal amount.
totalintegerTotal amount. A sum of principal amount and fee amount.
counterpartyobjectAn object containing the details of the receiving party of the grant. Setting either an
accountHolderId,balanceAccountId, or both is required.accountHolderIdstringThe identifier of the receiving account holder. The payout will default to the primary balance account of this account holder if no
balanceAccountIdis provided.balanceAccountIdstringThe identifier of the balance account that belongs to the receiving account holder.
transferInstrumentIdstringThe identifier of the transfer instrument that belongs to the legal entity of the account holder.
feeobjectAn object containing the fee currency and value, in minor units.
amountobjectAn object containing the fee amount.
valueintegerThe amount of the transaction, in minor units.
grantAccountIdstringThe identifier of the grant account used for the grant.
grantOfferIdstringThe identifier of the grant offer that has been selected and from which the grant details will be used.
idstringThe identifier of the grant reference.
repaymentobjectAn object containing the details of the 30-day repayment threshold.
basisPointsintegerThe repayment that is deducted daily from incoming net volume, in basis points.
termobjectAn object containing the details of the configuration for repayment term.
estimatedDaysintegerThe estimated term for repaying the grant, in days.
maximumDaysintegerThe maximum term for repaying the grant, in days. Only applies when
contractTypeis loan.thresholdobjectAn object containing the details of the 30-day repayment threshold.
amountobjectThe amount to be repaid on a 30-day basis.
valueintegerThe amount of the transaction, in minor units.
statusstringThe current status of the grant. Possible values: Pending, Active, Repaid.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
404 - Not Found
The payment was not found
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.