Get all available dynamic offers

get/dynamicOffers

API Version

Returns a list of all dynamic offers available for accountHolderId specified as a query parameter.

Endpoint destination URL

Query Parameters

Required

Optional

The type of financing that the offer is for. If the value is not specified, returns all available types.

Possible values: businessFinancing

Min length: 1

The unique identifier of the account holder that the dynamic offer is for.

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.
dynamicOffersarray[object]
Contains a list of available dynamic offers for the specified account holder.
accountHolderIdstring
The unique identifier of the account holder that the dynamic offer is for.
contractTypestring
The contract type of the offer.

Possible values:

loan

cashAdvance

expiresAtstring
The expiration date and time of the offer validity period.
financingTypestring
The type of financing that the offer is for.

Possible values: businessFinancing.
idstring
The unique identifier of the dynamic offer.
maximumAmountobject
The maximum financing amount available to the account holder under this offer.
currencystring
The three-character ISO currency code of the amount.
valueinteger
The numeric value of the amount, in minor units.
minimumAmountobject
The minimum financing amount available to the account holder under this offer.
currencystring
The three-character ISO currency code of the amount.
valueinteger
The numeric value of the amount, in minor units.
repaymentobject
Contains information about the repayment configuration of the grant.
termobject
Contains information about the time period in which your user must repay the total amount of the grant.
estimatedDaysinteger
The estimated duration of the repayment term, in days.
maximumDaysinteger
The maximum duration of the repayment term, in days. Only applies when contractType is loan.
startsAtstring
The starting date and time of the offer validity period.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get all available dynamic offers

HTTP Responses

200 - OK

422 - Unprocessable Entity