You designed your implementation<\/a> with your Adyen contact.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nHow it works<\/h2>\n
Integrating Capital consists of the following steps:<\/p>\n
\n- Review your account structure<\/a><\/li>\n
- Complete the integration checklist for Adyen for Platforms<\/a><\/li>\n
- Test your API keys<\/a><\/li>\n
- Set up webhooks<\/a><\/li>\n
- Implement Capital features<\/a><\/li>\n
- Go live<\/a><\/li>\n<\/ol>\n
1. Review your account structure<\/h2>\n
Before you start the integration process, you must be familiar with the account structure for Capital<\/a>. You need this information to building the different parts of your implementation.<\/p>\nEvery integration that includes Capital must have at least the following resources:<\/p>\n
\n- Company account<\/strong>: Represents your core business entity and holds your merchant accounts.<\/li>\n
- Merchant account<\/strong>: The account where we process payments for your users. You can have multiple merchant accounts.<\/li>\n
- Balance platform<\/strong>: The accounting system in which you manage your users and funds.<\/li>\n
- Account holder<\/strong>: Specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).<\/li>\n
- Balance account<\/strong>: Holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.<\/li>\n
- Legal entity<\/strong>: Contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.<\/li>\n
- Transfer instrument<\/strong>: Your user's verified bank account where they can receive payouts.<\/li>\n
- Grant account<\/strong>: allows you to track the total amount of outstanding receivables that Adyen has in relation to grants in your balance platform.<\/li>\n
- Grant references<\/strong>: tracks the balances related to specific grants. These references are created when a grant is paid out.<\/li>\n<\/ul>\n
Before integrating Capital, you must complete the integration steps for either the marketplace<\/a> or platform<\/a> model of Adyen for Platforms.<\/p>\n3. Test your API keys<\/h2>\n
To make API requests related to Capital, you can use the same API credentials that you generated for your marketplace<\/a> or platform<\/a>. If needed, you can generate your API credentials<\/a> and assign roles to them in your Customer Area<\/a>.<\/p>\nMake sure that you have the following API credentials and roles.<\/p>\n
\n\n\n| API<\/th>\n | Credential<\/th>\n | Roles<\/th>\n<\/tr>\n<\/thead>\n |
\n\n| Capital API<\/a> Configuration API<\/a><\/td>\n | ws@BalancePlatform.[YourBalancePlatform]<\/strong><\/span>Use this API credential to make grant requests and disburse grants, create resources such as account holders and balance accounts, and request user capabilities.<\/td>\n- Balance Platform BCL role<\/strong><\/li>
- Balance Platform Capital Configuration Role<\/strong><\/li>
- Balance Platform Capital Grant Initiation role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
\n| Legal Entity Management API<\/a><\/td>\n | ws_[123456]@Scope.Company_[YourCompanyAccount]<\/strong><\/span>Use this API credential to create and manage legal entities that contain the information required for verification checks.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n4. Set up webhooks<\/h2>\nAdyen sends webhooks to notify you of business financing-related events in your balance platform. For more details, see Webhook structures and types for Capital<\/a>.<\/p>\nTo configure webhooks:<\/p>\n \n- Set up webhook endpoints<\/a> on your server and build the logic for acknowledging webhooks.<\/li>\n
- Configure webhooks<\/a> in your Customer Area.<\/li>\n
- Secure webhooks<\/a> with HMAC signing.<\/li>\n<\/ol>\n
5. Implement Capital features<\/h2>\nYou can implement Capital features in two ways:<\/p>\n \n- By using capital components<\/li>\n
- By using the Capital API<\/li>\n<\/ul>\n\n
\n \n \n <\/tabs>\n <\/div>\n<\/div>\n\n6. Go live<\/h2>\nTo take your Capital integration live:<\/p>\n \n- Replicate your test account setup in your live account<\/strong>: The Capital setup from your test account for Adyen for Platforms is not<\/em> automatically replicated in your live account.<\/li>\n
- Update your code base<\/strong><\/li>\n
- Switch to live API credentials<\/strong>
\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.<\/li>\n- Switch from test to live endpoints<\/strong>
\nChange the endpoints from test<\/code> to live<\/code>. For example, https:\/\/balanceplatform-api-test.adyen.com\/<\/code> to
\nhttps:\/\/balanceplatform-api-live.adyen.com\/<\/code>.<\/li>\n- Run end-to-end tests<\/strong>\n
\n- Live API credentials: Make your first live API requests to make sure that your live API credentials are working.<\/li>\n
- Grant account: Create a grant account in your live environment.<\/li>\n
- Grant offers: Confirm that you can get grant offers for users with the required capability<\/a>.<\/li>\n
- Pay out grants: Confirm that grant amounts are correctly paid out to the corresponding balance accounts or transfer instruments.<\/li>\n
- Webhooks: Confirm that you can receive and accept webhooks in the live environment.<\/li>\n<\/ul><\/li>\n<\/ol>","url":"https:\/\/docs.adyen.com\/pt\/capital\/integration-checklist","articleFields":{"description":"An overview of the steps from signing up for Capital to going live.","feedback_component":true,"id":"25142879","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"26-10-2022 11:36","next_steps":[{"title":"Integrate with components","description":"Learn how to integrate our prebuilt UI components to accelerate your Capital integration process.","url":"\/capital\/terms-of-service","required":false},{"title":"Integrate using APIs","description":"Learn how to use our APIs to build your Capital integration from scratch.","url":"\/capital\/make-grant-request","required":false},{"title":"Manage access for your team","description":"Learn how to manage your integration in your Customer Area.","url":"\/capital\/manage-access","required":false}],"parameters":{"model":"platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/capital\/integration-checklist","title":"Integration checklist","content":"This page explains the steps to integrate Adyen Capital into your existing Adyen for Platforms integration.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have an Adyen for Platforms integration.\n\n\nLimitations\nYour user must operate in one of the supported countries\/regions.\n\n\nSetup steps\nBefore you begin, make sure: You contacted us to register your interest for Capital.You designed your implementation with your Adyen contact.\n\n\n\nHow it works\nIntegrating Capital consists of the following steps:\n\nReview your account structure\nComplete the integration checklist for Adyen for Platforms\nTest your API keys\nSet up webhooks\nImplement Capital features\nGo live\n\n1. Review your account structure\nBefore you start the integration process, you must be familiar with the account structure for Capital. You need this information to building the different parts of your implementation.\nEvery integration that includes Capital must have at least the following resources:\n\nCompany account: Represents your core business entity and holds your merchant accounts.\nMerchant account: The account where we process payments for your users. You can have multiple merchant accounts.\nBalance platform: The accounting system in which you manage your users and funds.\nAccount holder: Specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).\nBalance account: Holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.\nLegal entity: Contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.\nTransfer instrument: Your user's verified bank account where they can receive payouts.\nGrant account: allows you to track the total amount of outstanding receivables that Adyen has in relation to grants in your balance platform.\nGrant references: tracks the balances related to specific grants. These references are created when a grant is paid out.\n\n2. Complete the integration checklist for Adyen for Platforms\nBefore integrating Capital, you must complete the integration steps for either the marketplace or platform model of Adyen for Platforms.\n3. Test your API keys\nTo make API requests related to Capital, you can use the same API credentials that you generated for your marketplace or platform. If needed, you can generate your API credentials and assign roles to them in your Customer Area.\nMake sure that you have the following API credentials and roles.\n\n\n\nAPI\nCredential\nRoles\n\n\n\n\n Capital API Configuration API\nws@BalancePlatform.[YourBalancePlatform]Use this API credential to make grant requests and disburse grants, create resources such as account holders and balance accounts, and request user capabilities.\nBalance Platform BCL roleBalance Platform Capital Configuration RoleBalance Platform Capital Grant Initiation role\n\n\n Legal Entity Management API\nws_[123456]@Scope.Company_[YourCompanyAccount]Use this API credential to create and manage legal entities that contain the information required for verification checks.\n\n\n\n4. Set up webhooks\nAdyen sends webhooks to notify you of business financing-related events in your balance platform. For more details, see Webhook structures and types for Capital.\nTo configure webhooks:\n\nSet up webhook endpoints on your server and build the logic for acknowledging webhooks.\nConfigure webhooks in your Customer Area.\nSecure webhooks with HMAC signing.\n\n5. Implement Capital features\nYou can implement Capital features in two ways:\n\nBy using capital components\nBy using the Capital API\n\n\n\n \n \n \n \n\n\n6. Go live\nTo take your Capital integration live:\n\nReplicate your test account setup in your live account: The Capital setup from your test account for Adyen for Platforms is not automatically replicated in your live account.\nUpdate your code base\nSwitch to live API credentials\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.\nSwitch from test to live endpoints\nChange the endpoints from test to live. For example, https:\/\/balanceplatform-api-test.adyen.com\/ to\nhttps:\/\/balanceplatform-api-live.adyen.com\/.\nRun end-to-end tests\n\nLive API credentials: Make your first live API requests to make sure that your live API credentials are working.\nGrant account: Create a grant account in your live environment.\nGrant offers: Confirm that you can get grant offers for users with the required capability.\nPay out grants: Confirm that grant amounts are correctly paid out to the corresponding balance accounts or transfer instruments.\nWebhooks: Confirm that you can receive and accept webhooks in the live environment.\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Capital","lvl2":"Integration checklist"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/capital","lvl2":"\/pt\/capital\/integration-checklist"},"levels":3,"category":"","category_color":"","tags":["Integration","checklist"]}}
|
| |