Repository navigation
Add MiCA/EEA KYC support to TransakService - #11672
Draft
matteyusys wants to merge 2 commits into
Draft
matteyusys wants to merge 2 commits into
matteyusys wants to merge 2 commits into
Conversation
- Add submitMicaConsent and submitSourceOfIncome methods - Add TransakAdditionalRequirementOption type for structured option lists - Add MiCA/EEA metadata support to TransakAdditionalRequirement - Add termsIds to TransakBuyQuote for disclaimer identifiers - Add comprehensive tests for new functionality - Update CHANGELOG with breaking changes TRAM-4400 Co-authored-by: Matt I. <[email protected]>
Clean up code comments to match repo's normal level - remove inline comment that was just labeling self-documenting field names. Co-authored-by: Matt I. <[email protected]>
3 of 4 tasks
Contributor
🛑 Files requiring codeowner reviewTo merge this PR, you'll need to get approvals from the following owners. @MetaMask/money-movement (4 files)
@MetaMask/core-platform (expand for more) |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
This PR adds support for Transak's MiCA (Markets in Crypto-Assets) and EEA (European Economic Area) KYC requirements to the native Transak integration in
@metamask/ramps-controller.What changed and why?
Transak has introduced new KYC requirements for EEA users under MiCA regulations. These include:
termsIds(e.g.,MICA_EEA_BUY,MICA_EEA_SELL) to display MiCA-specific disclaimersWhat's included?
New API Methods:
submitMicaConsent(consentedAt: string)- Submits MiCA consent with an ISO 8601 timestampsubmitSourceOfIncome(monthlyVolume, sourceOfFundsType, employmentStatus, countryOfCitizenship)- Submits source of income detailsType Updates:
TransakAdditionalRequirementOption- New type for structured option lists with{ name, value }pairsTransakAdditionalRequirement.metadata- Now supports MiCA/EEA fields:sourceOfFundsTypeOptionsemploymentStatusOptionscountryOfCitizenshipOptionsTransakBuyQuote.termsIds- Optional array of disclaimer identifiersSubmitMicaConsentRequestandSubmitSourceOfIncomeRequest- Request body typesBreaking Changes:
TransakAdditionalRequirement.metadatafields are now optional, and new EEA-specific option fields useTransakAdditionalRequirementOption[]instead ofstring[]. Clients must check option types when handling additional requirements responses.Testing
CONSENTandSOURCE_OF_INCOMEform types ingetAdditionalRequirementstermsIdshandlingClient Usage
For MetaMask Mobile to consume this:
Install from this branch:
Or link locally for testing:
New public API:
TransakService.submitMicaConsent(consentedAt: string): Promise<void>TransakService.submitSourceOfIncome(monthlyVolume: string, sourceOfFundsType: string, employmentStatus: string, countryOfCitizenship: string): Promise<void>TransakAdditionalRequirementOptiontypeSubmitMicaConsentRequesttypeSubmitSourceOfIncomeRequesttypeTransakBuyQuote.termsIds?: string[]References
Checklist
Moved from #11636 (branch renamed from
cursor/mica-eea-kyc-support-7ad1); earlier review history is there.