> For the complete documentation index, see [llms.txt](https://developer.algbralabs.com/partner-banking/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.algbralabs.com/partner-banking/concepts/investments.md).

# Investments

## GET /v1/partner/investments/product-variants

> Get all product variants

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/product-variants":{"get":{"operationId":"InvestmentController_getProductVariants","summary":"Get all product variants","parameters":[{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of product variants per page.","schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of product variants available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerProductVariantResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number"},"itemCount":{"type":"number"},"itemsPerPage":{"type":"number"},"totalItems":{"type":"number"},"totalPages":{"type":"number"}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"Pagination":{"type":"object","properties":{}},"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product variant"},"name":{"type":"string","description":"Name of the financial product variant"},"duration":{"type":"number","description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"grossRate":{"type":"number","description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"validFrom":{"format":"date-time","type":"string","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of maturity time"},"eligibleCountries":{"type":"array","description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"deleted":{"type":"boolean","description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product"},"name":{"type":"string","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"]},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"]},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"]},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product provider"},"name":{"type":"string","description":"Name of the product provider"},"region":{"type":"string","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the business schedule"},"region":{"type":"string","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","description":"Monday of week"},"tuesday":{"type":"boolean","description":"Tuesday of week"},"wednesday":{"type":"boolean","description":"Wednesday of week"},"thursday":{"type":"boolean","description":"Thursday of week"},"friday":{"type":"boolean","description":"Friday of week"},"saturday":{"type":"boolean","description":"Saturday of week"},"sunday":{"type":"boolean","description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```

## GET /v1/partner/investments/product-variants/{productVariantId}

> Get product variant

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/product-variants/{productVariantId}":{"get":{"operationId":"InvestmentController_getProductVariant","summary":"Get product variant","parameters":[{"name":"productVariantId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the product details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerProductVariantResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product variant"},"name":{"type":"string","description":"Name of the financial product variant"},"duration":{"type":"number","description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"grossRate":{"type":"number","description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"validFrom":{"format":"date-time","type":"string","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of maturity time"},"eligibleCountries":{"type":"array","description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"deleted":{"type":"boolean","description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product"},"name":{"type":"string","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"]},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"]},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"]},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product provider"},"name":{"type":"string","description":"Name of the product provider"},"region":{"type":"string","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the business schedule"},"region":{"type":"string","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","description":"Monday of week"},"tuesday":{"type":"boolean","description":"Tuesday of week"},"wednesday":{"type":"boolean","description":"Wednesday of week"},"thursday":{"type":"boolean","description":"Thursday of week"},"friday":{"type":"boolean","description":"Friday of week"},"saturday":{"type":"boolean","description":"Saturday of week"},"sunday":{"type":"boolean","description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```

## GET /v1/partner/investments/subscriptions

> Get all subscriptions

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/subscriptions":{"get":{"operationId":"InvestmentController_getSubscriptions","summary":"Get all subscriptions","parameters":[{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of subscriptions per page.","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"customerIds","required":true,"in":"query","description":"Filter by customerIds.","schema":{"type":"array","items":{"type":"string"}}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of subscriptions available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number"},"itemCount":{"type":"number"},"itemsPerPage":{"type":"number"},"totalItems":{"type":"number"},"totalPages":{"type":"number"}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"Pagination":{"type":"object","properties":{}},"PartnerSubscriptionResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the subscription","format":"uuid"},"amount":{"type":"number","description":"Subscription amount in minor units (e.g. 129 for £1.29)"},"currencyCode":{"type":"string","description":"Currency code","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"primaryAccountId":{"type":"string","description":"Parent account id","format":"uuid"},"virtualAccountId":{"type":"string","description":"Virtual account id","format":"uuid"},"customerId":{"type":"string","description":"Customer id","format":"uuid"},"productVariantId":{"type":"string","description":"Product variant id"},"productVariant":{"description":"Product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductVariantResponse"}]},"collectionDate":{"format":"date-time","type":"string","description":"Settlement date"},"placementDate":{"format":"date-time","type":"string","description":"Settlement date"},"maturityDate":{"format":"date-time","type":"string","description":"Settlement date"},"settlementDate":{"format":"date-time","type":"string","description":"Settlement date"},"returns":{"type":"number","description":"Expected return amount in minor units (e.g. 129 for £1.29)"},"co2Avoided":{"type":"number","description":"Describes how much co2 avoided"},"cleanWaterImpacted":{"type":"number","description":"Describes how much clean water generated"},"state":{"type":"string","description":"Investment state","enum":["UNKNOWN","PENDING","CREATED","EARLY_WITHDRAWAL","COMPLETED","FAILED"]},"progress":{"type":"number","description":"Progressed percentage of the investment period lifecycle for this subscription"},"activities":{"description":"Activities related with subscription","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityResponse"}},"createDate":{"format":"date-time","type":"string","description":"Create date"},"updateDate":{"format":"date-time","type":"string","description":"Update date"}},"required":["id","amount","currencyCode","primaryAccountId","virtualAccountId","customerId","productVariantId","collectionDate","placementDate","maturityDate","settlementDate","returns","createDate"]},"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product variant"},"name":{"type":"string","description":"Name of the financial product variant"},"duration":{"type":"number","description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"grossRate":{"type":"number","description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"validFrom":{"format":"date-time","type":"string","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of maturity time"},"eligibleCountries":{"type":"array","description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"deleted":{"type":"boolean","description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product"},"name":{"type":"string","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"]},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"]},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"]},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product provider"},"name":{"type":"string","description":"Name of the product provider"},"region":{"type":"string","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the business schedule"},"region":{"type":"string","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","description":"Monday of week"},"tuesday":{"type":"boolean","description":"Tuesday of week"},"wednesday":{"type":"boolean","description":"Wednesday of week"},"thursday":{"type":"boolean","description":"Thursday of week"},"friday":{"type":"boolean","description":"Friday of week"},"saturday":{"type":"boolean","description":"Saturday of week"},"sunday":{"type":"boolean","description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerProductActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the activity","format":"uuid"},"phase":{"type":"string","description":"Phase","enum":["FUNDS_COLLECTION","FUNDS_PLACEMENT","FUNDS_SETTLEMENT","EARLY_WITHDRAWAL"]},"processingStatus":{"type":"string","description":"Processing status","enum":["INITIALIZED","ACCEPTED","FAILED","REINITIALIZED"]},"provisionRequest":{"description":"Provision request","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionRequest"}},"provisionResult":{"description":"Provision result","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionResult"}},"createDate":{"format":"date-time","type":"string","description":"Create date"}},"required":["id","phase","processingStatus","createDate"]},"PartnerProductActivityProvisionRequest":{"type":"object","properties":{"expectedReturnsPaymentId":{"type":"string","format":"uuid"},"reason":{"type":"string","enum":["COLLECTION","PLACEMENT","SETTLEMENT","EXPECTED_RETURN","CANCEL_EXPECTED_RETURN","ACTUAL_RETURN"]}},"required":["reason"]},"PartnerProductActivityProvisionResult":{"type":"object","properties":{"success":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/Error"},"paymentId":{"type":"string","format":"uuid"}},"required":["success"]},"Error":{"type":"object","properties":{}},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```

## POST /v1/partner/investments/subscriptions

> Create subscription

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/subscriptions":{"post":{"operationId":"InvestmentController_subscribeToProduct","summary":"Create subscription","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreateSubscriptionRequest"}}}},"responses":{"201":{"description":"Returns the subscription details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"PartnerCreateSubscriptionRequest":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID that will be the account owner.","format":"uuid"},"idempotencyKey":{"type":"string","description":"A unique idempotency key to prevent duplicate subscription.","format":"uuid"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","format":"uuid","nullable":true},"primaryAccountId":{"type":"string","description":"The primary account id under which the virtual account will be created.","format":"uuid"},"productVariantId":{"type":"string","description":"The product variant id which will be subscribed."},"amount":{"type":"number","description":"Amount in minor units (e.g. 129 for £1.29)"}},"required":["customerId","idempotencyKey","primaryAccountId","productVariantId","amount"]},"PartnerSubscriptionResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the subscription","format":"uuid"},"amount":{"type":"number","description":"Subscription amount in minor units (e.g. 129 for £1.29)"},"currencyCode":{"type":"string","description":"Currency code","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"primaryAccountId":{"type":"string","description":"Parent account id","format":"uuid"},"virtualAccountId":{"type":"string","description":"Virtual account id","format":"uuid"},"customerId":{"type":"string","description":"Customer id","format":"uuid"},"productVariantId":{"type":"string","description":"Product variant id"},"productVariant":{"description":"Product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductVariantResponse"}]},"collectionDate":{"format":"date-time","type":"string","description":"Settlement date"},"placementDate":{"format":"date-time","type":"string","description":"Settlement date"},"maturityDate":{"format":"date-time","type":"string","description":"Settlement date"},"settlementDate":{"format":"date-time","type":"string","description":"Settlement date"},"returns":{"type":"number","description":"Expected return amount in minor units (e.g. 129 for £1.29)"},"co2Avoided":{"type":"number","description":"Describes how much co2 avoided"},"cleanWaterImpacted":{"type":"number","description":"Describes how much clean water generated"},"state":{"type":"string","description":"Investment state","enum":["UNKNOWN","PENDING","CREATED","EARLY_WITHDRAWAL","COMPLETED","FAILED"]},"progress":{"type":"number","description":"Progressed percentage of the investment period lifecycle for this subscription"},"activities":{"description":"Activities related with subscription","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityResponse"}},"createDate":{"format":"date-time","type":"string","description":"Create date"},"updateDate":{"format":"date-time","type":"string","description":"Update date"}},"required":["id","amount","currencyCode","primaryAccountId","virtualAccountId","customerId","productVariantId","collectionDate","placementDate","maturityDate","settlementDate","returns","createDate"]},"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product variant"},"name":{"type":"string","description":"Name of the financial product variant"},"duration":{"type":"number","description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"grossRate":{"type":"number","description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"validFrom":{"format":"date-time","type":"string","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of maturity time"},"eligibleCountries":{"type":"array","description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"deleted":{"type":"boolean","description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product"},"name":{"type":"string","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"]},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"]},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"]},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product provider"},"name":{"type":"string","description":"Name of the product provider"},"region":{"type":"string","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the business schedule"},"region":{"type":"string","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","description":"Monday of week"},"tuesday":{"type":"boolean","description":"Tuesday of week"},"wednesday":{"type":"boolean","description":"Wednesday of week"},"thursday":{"type":"boolean","description":"Thursday of week"},"friday":{"type":"boolean","description":"Friday of week"},"saturday":{"type":"boolean","description":"Saturday of week"},"sunday":{"type":"boolean","description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerProductActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the activity","format":"uuid"},"phase":{"type":"string","description":"Phase","enum":["FUNDS_COLLECTION","FUNDS_PLACEMENT","FUNDS_SETTLEMENT","EARLY_WITHDRAWAL"]},"processingStatus":{"type":"string","description":"Processing status","enum":["INITIALIZED","ACCEPTED","FAILED","REINITIALIZED"]},"provisionRequest":{"description":"Provision request","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionRequest"}},"provisionResult":{"description":"Provision result","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionResult"}},"createDate":{"format":"date-time","type":"string","description":"Create date"}},"required":["id","phase","processingStatus","createDate"]},"PartnerProductActivityProvisionRequest":{"type":"object","properties":{"expectedReturnsPaymentId":{"type":"string","format":"uuid"},"reason":{"type":"string","enum":["COLLECTION","PLACEMENT","SETTLEMENT","EXPECTED_RETURN","CANCEL_EXPECTED_RETURN","ACTUAL_RETURN"]}},"required":["reason"]},"PartnerProductActivityProvisionResult":{"type":"object","properties":{"success":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/Error"},"paymentId":{"type":"string","format":"uuid"}},"required":["success"]},"Error":{"type":"object","properties":{}},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```

## GET /v1/partner/investments/subscriptions/{subscriptionId}

> Get subscription

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/subscriptions/{subscriptionId}":{"get":{"operationId":"InvestmentController_getSubscription","summary":"Get subscription","parameters":[{"name":"subscriptionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the subscription details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"PartnerSubscriptionResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the subscription","format":"uuid"},"amount":{"type":"number","description":"Subscription amount in minor units (e.g. 129 for £1.29)"},"currencyCode":{"type":"string","description":"Currency code","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"primaryAccountId":{"type":"string","description":"Parent account id","format":"uuid"},"virtualAccountId":{"type":"string","description":"Virtual account id","format":"uuid"},"customerId":{"type":"string","description":"Customer id","format":"uuid"},"productVariantId":{"type":"string","description":"Product variant id"},"productVariant":{"description":"Product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductVariantResponse"}]},"collectionDate":{"format":"date-time","type":"string","description":"Settlement date"},"placementDate":{"format":"date-time","type":"string","description":"Settlement date"},"maturityDate":{"format":"date-time","type":"string","description":"Settlement date"},"settlementDate":{"format":"date-time","type":"string","description":"Settlement date"},"returns":{"type":"number","description":"Expected return amount in minor units (e.g. 129 for £1.29)"},"co2Avoided":{"type":"number","description":"Describes how much co2 avoided"},"cleanWaterImpacted":{"type":"number","description":"Describes how much clean water generated"},"state":{"type":"string","description":"Investment state","enum":["UNKNOWN","PENDING","CREATED","EARLY_WITHDRAWAL","COMPLETED","FAILED"]},"progress":{"type":"number","description":"Progressed percentage of the investment period lifecycle for this subscription"},"activities":{"description":"Activities related with subscription","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityResponse"}},"createDate":{"format":"date-time","type":"string","description":"Create date"},"updateDate":{"format":"date-time","type":"string","description":"Update date"}},"required":["id","amount","currencyCode","primaryAccountId","virtualAccountId","customerId","productVariantId","collectionDate","placementDate","maturityDate","settlementDate","returns","createDate"]},"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product variant"},"name":{"type":"string","description":"Name of the financial product variant"},"duration":{"type":"number","description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"grossRate":{"type":"number","description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"]},"validFrom":{"format":"date-time","type":"string","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"description":"Unit of maturity time"},"eligibleCountries":{"type":"array","description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant"},"deleted":{"type":"boolean","description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product"},"name":{"type":"string","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"]},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"]},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"]},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product provider"},"name":{"type":"string","description":"Name of the product provider"},"region":{"type":"string","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the business schedule"},"region":{"type":"string","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","description":"Monday of week"},"tuesday":{"type":"boolean","description":"Tuesday of week"},"wednesday":{"type":"boolean","description":"Wednesday of week"},"thursday":{"type":"boolean","description":"Thursday of week"},"friday":{"type":"boolean","description":"Friday of week"},"saturday":{"type":"boolean","description":"Saturday of week"},"sunday":{"type":"boolean","description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerProductActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the activity","format":"uuid"},"phase":{"type":"string","description":"Phase","enum":["FUNDS_COLLECTION","FUNDS_PLACEMENT","FUNDS_SETTLEMENT","EARLY_WITHDRAWAL"]},"processingStatus":{"type":"string","description":"Processing status","enum":["INITIALIZED","ACCEPTED","FAILED","REINITIALIZED"]},"provisionRequest":{"description":"Provision request","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionRequest"}},"provisionResult":{"description":"Provision result","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionResult"}},"createDate":{"format":"date-time","type":"string","description":"Create date"}},"required":["id","phase","processingStatus","createDate"]},"PartnerProductActivityProvisionRequest":{"type":"object","properties":{"expectedReturnsPaymentId":{"type":"string","format":"uuid"},"reason":{"type":"string","enum":["COLLECTION","PLACEMENT","SETTLEMENT","EXPECTED_RETURN","CANCEL_EXPECTED_RETURN","ACTUAL_RETURN"]}},"required":["reason"]},"PartnerProductActivityProvisionResult":{"type":"object","properties":{"success":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/Error"},"paymentId":{"type":"string","format":"uuid"}},"required":["success"]},"Error":{"type":"object","properties":{}},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```

## GET /v1/partner/investments/product-variants/{productVariantId}/returns

> Get product variant returns

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/investments/product-variants/{productVariantId}/returns":{"get":{"operationId":"InvestmentController_getProductVariantReturns","summary":"Get product variant returns","parameters":[{"name":"productVariantId","required":true,"in":"path","schema":{"type":"string"}},{"name":"amount","required":true,"in":"query","description":"Amount in minor units (e.g. 129 for £1.29)","schema":{"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns calculated product return details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerProductVariantReturnsResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Amount lower than product's minimum amount. Try greater value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}}},"components":{"schemas":{"PartnerProductVariantReturnsResponse":{"type":"object","properties":{"principal":{"type":"number","description":"Principal amount used for return calculation."},"collectionDate":{"format":"date-time","type":"string","description":"Estimated collection date."},"placementDate":{"format":"date-time","type":"string","description":"Estimated placement date."},"maturityDate":{"format":"date-time","type":"string","description":"Estimated maturity date."},"settlementDate":{"format":"date-time","type":"string","description":"Estimated settlement date."},"returns":{"type":"number","description":"Calculated return amount."},"co2Avoided":{"type":"number","description":"Estimated CO2 avoided.","nullable":true},"cleanWaterImpacted":{"type":"number","description":"Estimated clean water impacted.","nullable":true}},"required":["principal","collectionDate","placementDate","maturityDate","settlementDate","returns"]},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]}}}}
```