Sokin Embedded API
    • Getting Started
      • Sokin Definitions
      • Guides
        • Authentication
        • Receiving Payments
        • FX Payments
        • Payments
        • Unfunded Payments
        • Unfunded FX Payments
        • Webhooks
        • Corporate Onboarding
          • Data Requirements
          • Step 1: Create a corporate profile
          • Step 2: Add associates
          • Step 3: Add a parent entity (if applicable)
          • Step 4: Upload company documents
          • Step 5: Upload associate documents
          • Conditional Step: Upload Parent Entity documents (if applicable)
          • Step 6: Finalise onboarding submission
          • Uploading supporting documents using Pre-signed URLs
          • Onboarding Reference Data
          • Onboarding Models
            • Data-Only model
            • Supported Jurisdictions & National ID Requirements
        • Sokin MCP
          • Sokin MCP - Setup and Usage Guide
          • Sokin MCP - Tool Guide
          • Sokin MCP - Technical Docs
    • Authentication
      • Get Token
      • Schemas
        • TokenResponse
    • Corporates
      • v2025-12-01
        • Create a new Corporate
        • Add a parent entity (corporate associate) to an onboarding request
        • Add an associate to a corporate onboarding request
        • Request pre-signed URLs for onboarding document uploads
        • Request pre-signed URLs for parent entity document uploads
        • Request pre-signed URLs for associate document uploads
        • Finalise corporate onboarding submission
      • Schemas
        • CreateCorporateRequest
        • UboDetails
        • OwnershipType
        • AssociateDocumentPresignedUrlResponse
        • AddOnboardingDocumentsRequest
        • MessageResponse
        • AssociateDocumentPresignedUrlResponseItem
        • ErrorDetail
        • CorporateAssociateType
        • ErrorResponse
        • PresignedUrlResponse
        • AddressTypeEnum
        • FinaliseSubmissionRequest
        • AddParentEntityRequest
        • CreateCorporateResponse
        • AssociateIdentityType
        • ApiResponse[AddOnboardingDocumentsResponse]
        • CorporateCategories
        • AddOnboardingDocumentsResponse
        • ApiResponse[CorporateDetailResponse]
        • ApiResponse[AddAssociateDocumentsResponse]
        • AddParentEntityDocumentsRequest
        • AddAssociateDocumentsResponse
        • AddParentEntityResponse
        • AddIndividualAssociateRequest
        • ApiResponse[CreateCorporateResponse]
        • AddIndividualAssociateResponse
        • CorporateDetailResponse
        • AssociateType
        • ApiResponse[AddParentEntityResponse]
        • NumericRange
        • ApiResponse[AddIndividualAssociateResponse]
        • MoneyRange
        • AddAssociateDocumentsRequest
        • FinaliseSubmissionResponse
        • AssociateIdentityType
    • Corporate Currency Accounts
      • v2025-12-01
        • Get Corporate Currency Accounts
        • Get Cca Ledger Items
        • Get Corporate Currency Account By Reference
      • Schemas
        • GetCCAByReferenceResponse
        • GetCCAsResponseItem
        • PaginatedApiResponse[GetCCALedgerItemsResponseItem]
        • ErrorDetail
        • PageInfo
        • SearchCCALedgersResponseItem
        • PaginationInfo
        • GetCCAUnifiedBalanceResponse
        • PaginatedApiResponse[SearchCCALedgersResponseItem]
        • ErrorResponse
        • ApiResponse[GetCCAUnifiedBalanceResponse]
        • SearchCCALedgersRequest
        • PaginatedApiResponse[GetCCAsResponseItem]
        • ApiResponse[GetCCAByReferenceResponse]
        • PaginationInfo
        • SearchCCALedgersPagination
        • GetCCAByReferenceResponsePayInDetail
        • CurrencyCode
        • GetCCALedgerItemsResponseItem
        • PaginationInfo
    • Beneficiaries
      • v2025-12-01
        • Get Beneficiary Schema
        • Create Beneficiary
        • Get Beneficiary List
        • Get Beneficiary Details
        • Delete Beneficiary
        • Validate Beneficiary
        • Validate Beneficiaries
        • Acknowledge Validation Mismatch
        • List Financial Institutions
        • List Financial Institution Branches
      • Schemas
        • AcknowledgeValidationMismatchRequest
        • ValidationType
        • ProviderBankIdentifierRequest
        • ErrorDetail
        • FinancialInstitutionReferenceResponse
        • AcknowledgeValidationMismatchResponse
        • ApiResponse[AcknowledgeValidationMismatchResponse]
        • ApiResponse[list[FinancialInstitutionReferenceResponse]]
        • AcknowledgedValidationMismatchDestinationResponse
        • DeleteBeneficiaryData
        • AddressResponse
        • BeneficiarySchemaFieldCondition
        • StateOrProvince
        • ApiResponse[list[BankCountryCurrencyResponse]]
        • PageInfo
        • BeneficiarySchemaField
        • BeneficiaryValidationResultResponse
        • StateOrProvince
        • ApiResponse[BeneficiaryResponse]
        • BeneficiaryField
        • RegionalHints
        • BeneficiaryStatus
        • DestinationResponse
        • ValidationStatus
        • BeneficiaryType
        • PaymentMethodType
        • CreateBeneficiaryRequest
        • PaginatedApiResponse[FinancialInstitutionBranchReferenceResponse]
        • ValidateBeneficiariesRequest
        • ApiResponse[ValidateBatchBeneficiariesResponse]
        • CompanyDetailsResponse
        • SchemaFieldVisibility
        • FieldErrorResponse
        • RoutingScheme
        • StateOrProvince
        • ValidateBeneficiaryRequest
        • ErrorResponse
        • FieldType
        • VirtualAccountDestinationRequest
        • ApiResponse[DeleteBeneficiaryData]
        • SokinInternalDestinationRequest
        • GetBeneficiaryFieldsResponse
        • BeneficiaryResponse
        • ApiResponse[ValidateBeneficiaryResponse]
        • FinancialInstitutionBranchReferenceResponse
        • IdentifierType
        • IndividualDetailsRequest
        • SchemaFieldType
        • CurrencyCode
        • TransactionTypeEnum
        • CryptoDestinationRequest
        • AccountType
        • BeneficiaryValidationPayload
        • ApiResponse[GetBeneficiaryFieldsResponse]
        • AccountNumberType
        • PatchBeneficiaryRequest
        • BankAccountCategory
        • ApiResponse[GetBeneficiarySchemaResponse]
        • PaginatedApiResponse[BeneficiaryResponse]
        • ApiResponse[list[BankCountryResponse]]
        • AddressRequest
        • PaginationInfo
        • BankCountryCurrencyResponse
        • PaginationInfo
        • ValidateBatchBeneficiariesResponse
        • PaymentRail
        • CreateExternalBeneficiaryData
        • FinancialInstitutionRequest
        • ApiResponse[CreateExternalBeneficiaryData]
        • CompanyDetailsRequest
        • BankCountryResponse
        • CreateExternalBeneficiaryRequest
        • BankAccountDestinationRequest
        • IndividualDetailsResponse
        • BeneficiarySchemaCondition
        • BeneficiaryDestinationValidationResult
        • BeneficiaryEntityType
        • GetBeneficiarySchemaResponse
        • ETransferDestinationRequest
        • ValidateBeneficiaryResponse
        • RoutingCodeRequest
        • ApiResponse[BeneficiaryDetails]
        • BeneficiaryListItem
        • PaginatedApiResponse[BeneficiaryListItem]
        • PaginationInfo
        • PaginatedBeneficiaryFieldsResponse
        • BeneficiaryDetails
        • ApiResponse[ListFinancialInstitutionsResponse]
        • ListFinancialInstitutionsResponse
    • Instruction Requests
      • v2025-12-01
        • Create Payment Instruction Request
        • Create Fx Instruction Request
        • Create Fx Payment Instruction Request
        • Create Sokin Direct Instruction Request
        • Get Instruction Request By Reference
        • List Payment Purposes
      • Schemas
        • CreatePaymentInstructionRequest
        • InstructionType
        • CreateInstructionRequestResponse
        • CreateSokinDirectInstructionRequest
        • ValidateInstructionCreationResponse
        • ApiResponse[CreateInstructionRequestResponse]
        • ErrorResponse
        • ErrorDetail
        • CreateFXInstructionRequest
        • CreateUnfundedFxPaymentInstructionRequest
        • FeeBreakdownResponse
        • ApiResponse[list[str]]
        • GetInstructionRequestResponse
        • ApiResponse[GetInstructionRequestResponse]
        • PaymentPurpose
        • CreateFxPaymentInstructionRequest
        • ApiResponse[ValidateInstructionCreationResponse]
        • CreateUnfundedPaymentInstructionRequest
        • ValidateInstructionCreationRequest
    • Instructions
      • v2025-12-01
        • Get Instruction By Reference
      • Schemas
        • GetInstructionResponse
        • PaginatedApiResponse[InstructionListResponseItem]
        • ApiResponse[GetInstructionResponse]
        • PaginationInfo
        • ErrorResponse
        • ErrorDetail
        • PageInfo
        • InstructionListResponseItem
        • PaginationInfo
    • Foreign Exchange
      • v2025-12-01
        • Get Fx Rate
      • v2026-08-01
        • Request FX Quote
        • Get FX Quote
      • Schemas
        • ApiResponse[FxRateData]
        • FixedSide
        • FxRateRequest
        • FXValidityPeriod
        • FxRateData
        • ApiResponse[GetQuoteResponse]
        • ErrorResponse
        • ErrorDetail
        • GetQuoteResponse
        • FXTenorType
        • FxQuoteStatus
        • ApiResponse[CreateQuoteResponse]
        • CurrencyCode
        • RequestFxQuoteRequest
        • CreateQuoteResponse
    • Payment Acceptance
      • Payment Acceptance
    • Boost
      • 2026-07-01
        • Boost Products
          • List Boost Products
          • Get Boost Product
        • Boost Deposit Requests
          • List Boost deposit requests
          • Open a Boost deposit request
        • Boost Maturities
          • List Boost maturities
          • Get a Boost maturity by external reference
          • Open a Boost withdrawal
        • Sokin Boost Accounts
          • List Sokin Boost Accounts
          • List Easy Access Boost recent activity
          • List Fixed Term Boosts (Your Terms)
          • Get a Sokin Boost Account by external reference
          • Update the auto-renewal setting of a Sokin Boost Account
      • Schemas
        • PaginationInfo
        • ApiResponse[CreateBoostRequestResponse]
        • BoostSummaryProductType
        • ProductResponse
        • MaturityStatus
        • GetSokinBoostAccountSummaryResponse
        • InterestPaymentFrequency
        • CreateBoostRequest
        • ApiResponse[MaturityResponse]
        • ProductRateResponse
        • CreateBoostRequestResponse
        • WithdrawalKind
        • ApiResponse[GetSokinBoostAccountResponse]
        • ProductRateVersionResponse
        • BoostRequestVersionResponse
        • MaturityType
        • PaginatedApiResponse[SokinBoostAccountListItemResponse]
        • ProductRateStatus
        • CreateWithdrawalRequest
        • SokinBoostAccountStatus
        • TermType
        • BoostRequestResponse
        • ApiResponse[CreateWithdrawalResponse]
        • ErrorDetail
        • BoostSource
        • SokinBoostAccountLedgerItemSubtype
        • ErrorResponse
        • ApiResponse[SokinBoostAccountStatisticsResponse]
        • CurrencyCode
        • MaturityResponse
        • FixedTermBoostStatus
        • ProductLifecycleVersionResponse
        • BoostRequestStatus
        • ApiResponse[UpdateSokinBoostAccountAutoRenewalResponse]
        • PaginationInfo
        • PaginatedApiResponse[BoostRequestResponse]
        • EasyAccessBoostActivityResponse
        • ApiResponse[ProductResponse]
        • SokinBoostAccountListItemResponse
        • PaginatedApiResponse[ProductResponse]
        • SokinBoostAccountStatisticsResponse
        • ProductStatus
        • PaginatedApiResponse[MaturityResponse]
        • CurrencyAmountResponse
        • CreateWithdrawalResponse
        • BoostSummaryProductResponse
        • SokinBoostAccountType
        • FixedTermBoostResponse
        • UpdateSokinBoostAccountAutoRenewalRequest
        • ApiResponse[GetSokinBoostAccountSummaryResponse]
        • PaginatedApiResponse[FixedTermBoostResponse]
        • UpdateSokinBoostAccountAutoRenewalResponse
        • PaginatedApiResponse[EasyAccessBoostActivityResponse]
        • GetSokinBoostAccountResponse
    • Webhooks
      • v2025-12-01
        • Create Subscription
        • Update Subscription
        • Get Subscription By Id
        • Delete Subscription
        • Update Subscription Status
        • List Notification Logs
        • Retry Notification
      • Schemas
        • ApiResponse[UpdateSubscriptionResponse]
        • PaginationInfo
        • SubscriptionCreateOrUpdate
        • NotificationStatus
        • NotificationAttemptResponse
        • SubscribableWebhookEventType
        • SubscriptionStatusUpdate
        • ApiResponse[CreateSubscriptionResponse]
        • UpdateSubscriptionResponse
        • PaginatedApiResponse[NotificationLogResponse]
        • PaginationInfo
        • ErrorResponse
        • ErrorDetail
        • PageInfo
        • CreateSubscriptionResponse
        • NotificationLogResponse
        • WebhookSubscription

    ProductResponse(ProductResponse)

    A Boost savings product a customer can open, including its current rate.
    Operators with detailed read access additionally receive the product status and lifecycle changelog,
    every attached rate with its full changelog, and internal operational fields.

    {
        "externalReference": "string",
        "name": "string",
        "currency": "AED",
        "termType": "EasyAccess",
        "termDays": 0,
        "interestPaymentFrequency": "Monthly",
        "netRate": "string",
        "rateEffectiveFrom": "2019-08-24",
        "status": "Created",
        "interestProviderReference": "string",
        "dayCountBasis": 0,
        "rates": [
            {
                "externalReference": "string",
                "netRate": "string",
                "grossRate": "string",
                "feeRate": "string",
                "effectiveFrom": "2019-08-24",
                "status": "Scheduled",
                "isCancelRateAvailable": true,
                "changelog": [
                    {
                        "netRate": "string",
                        "grossRate": "string",
                        "feeRate": "string",
                        "effectiveFrom": "2019-08-24",
                        "status": "Scheduled",
                        "createdBy": "string",
                        "createdAt": "2019-08-24T14:15:22.123Z"
                    }
                ]
            }
        ],
        "lifecycleChangelog": [
            {
                "status": "Created",
                "name": "string",
                "createdBy": "string",
                "createdAt": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
    Built with