openapi-directory/api/adyen.com/BalancePlatformConfigurationNotification-v1.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.1.0","info":{"contact":{"name":"Adyen Developer Experience team","url":"https://github.com/Adyen/adyen-openapi","x-twitter":"Adyen"},"description":"Adyen sends webhooks to inform your system about events that occur in your platform. These events include, for example, when an account holder's capabilities are updated, or when a sweep configuration is created or updated. \nWhen an event occurs, Adyen makes an HTTP POST request to a URL on your server and includes the details of the event in the request body.\n\nYou can use these webhooks to build your implementation. For example, you can use this information to update internal statuses when the status of a capability is changed.","termsOfService":"https://www.adyen.com/legal/terms-and-conditions","title":"Configuration webhooks","version":"1","x-apisguru-categories":["payment"],"x-logo":{"url":"https://twitter.com/Adyen/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/BalancePlatformConfigurationNotification-v1.json","version":"3.1"}],"x-providerName":"adyen.com","x-publicVersion":true,"x-serviceName":"BalancePlatformConfigurationNotification-v1"},"tags":[{"name":"Account holder"},{"name":"Balance account"},{"name":"Payment instrument"},{"name":"Card order"}],"components":{"examples":{"post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created":{"description":"Example webhook when an account holder was created with LEM API v1, v2","summary":"Account holder created with LEM API v1, v2","value":{"data":{"accountHolder":{"capabilities":{"issueCard":{"allowed":false,"enabled":true,"requested":true,"verificationStatus":"pending"},"receiveFromBalanceAccount":{"allowed":false,"enabled":true,"requested":true,"verificationStatus":"pending"},"receiveFromTransferInstrument":{"allowed":false,"enabled":true,"requested":true,"verificationStatus":"pending"},"sendToBalanceAccount":{"allowed":false,"enabled":true,"requested":true,"verificationStatus":"pending"},"sendToTransferInstrument":{"allowed":false,"enabled":true,"requested":true,"verificationStatus":"pending"}},"contactDetails":{"address":{"city":"Amsterdam","country":"NL","houseNumberOrName":"23","postalCode":"12345","street":"Teststreet 1"},"email":"test@adyen.com","phone":{"number":"0612345678","type":"Mobile"}},"description":"Shelly Eller","id":"AH32272223222B5CZW6QZ2V34","legalEntityId":"LE43319330319C8AYX89L2V59","reference":"YOUR_REFERENCE-2412C","status":"Active"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"test","type":"balancePlatform.accountHolder.created"}},"post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created-lem-v3":{"description":"Example webhook when an account holder was created with LEM API v3","summary":"Account holder created with LEM API v3","value":{"data":{"accountHolder":{"capabilities":{"sendToTransferInstrument":{"allowed":false,"enabled":true,"problems":[{"entity":{"id":"LE43319330319C8AYX89L2V59","type":"LegalEntity"},"verificationErrors":[{"code":2902,"message":"Terms Of Service forms are not accepted.","remediatingActions":[{"code":2902,"message":"Accept TOS"}],"type":"invalidInput"}]},{"entity":{"id":"SE576BH223222F5GJVKHH6BDT","type":"BankAccount"},"verificationErrors":[{"code":28037,"message":"'bankStatement' was missing.","remediatingActions":[{"code":1703,"message":"Upload a bank statement"}],"type":"dataMissing"}]},{"entity":{"id":"SE3222Z223222Q5J4D58K3DWP","type":"BankAccount"},"verificationErrors":[{"code":28037,"message":"'bankStatement' was missing.","remediatingActions":[{"code":1703,"message":"Upload a bank statement"}],"type":"dataMissing"}]},{"entity":{"id":"LE43319330319C8AYX89L2V59","type":"LegalEntity"},"verificationErrors":[{"code":28189,"message":"'UBO through control' was missing.","remediatingActions":[{"code":2151,"message":"Add 'organization.entityAssociations' of type 'uboThroughControl' to legal entity"}],"type":"dataMissing"},{"code":150,"message":"Organization details couldn't be verified","subErrors":[{"code":15016,"message":"The tax ID number couldn't be verified","remediatingActions":[{"code":1500,"message":"Update organization details"},{"code":1501,"message":"Upload a registration document"}],"type":"invalidInput"}],"type":"invalidInput"},{"code":28067,"message":"'Signatory' was missing.","remediatingActions":[{"code":2124,"message":"Add 'organization.entityAssociations' of type 'signatory' to legal entity"}],"type":"dataMissing"}]}],"requested":true,"transferInstruments":[{"allowed":false,"enabled":true,"id":"SE576BH223222F5GJVKHH6BDT","requested":true,"verificationStatus":"pending"},{"allowed":false,"enabled":true,"id":"SE3222Z223222Q5J4D58K3DWP","requested":true,"verificationStatus":"pending"}],"verificationStatus":"pending"}},"id":"AH32272223222B5CZW6QZ2V34","legalEntityId":"LE43319330319C8AYX89L2V59","reference":"YOUR_REFERENCE-2412C","status":"Active"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"live","type":"balancePlatform.accountHolder.created"}},"post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated":{"description":"Example webhook when an account holder was updated with LEM API v1, v2","summary":"Account holder updated with LEM API v1, v2","value":{"data":{"accountHolder":{"capabilities":{"sendToTransferInstrument":{"allowed":false,"enabled":true,"problems":[{"entity":{"id":"LE43319330319C8AYX89L2V59","type":"BankAccount"},"verificationErrors":[{"code":28037,"message":"'bankStatement' was missing.","remediatingActions":[{"code":1703,"message":"Upload a bank statement"}],"type":"dataMissing"}]}],"requested":true,"verificationStatus":"invalid"}},"description":"Shelly Eller","id":"AH32272223222B5CZW6QZ2V34","legalEntityId":"LE43319330319C8AYX89L2V59","reference":"YOUR_REFERENCE-2412C","status":"Active"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"test","type":"balancePlatform.accountHolder.updated"}},"post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated-lem-v3":{"description":"Example webhook when an account holder was updated with LEM API v3","summary":"Account holder updated with LEM API v3","value":{"data":{"accountHolder":{"capabilities":{"sendToTransferInstrument":{"allowed":false,"enabled":true,"problems":[{"entity":{"id":"LE43319330319C8AYX89L2V59","type":"LegalEntity"},"verificationErrors":[{"code":2902,"message":"Terms Of Service forms are not accepted.","remediatingActions":[{"code":2902,"message":"Accept TOS"}],"type":"invalidInput"}]},{"entity":{"id":"SE576BH223222F5GJVKHH6BDT","type":"BankAccount"},"verificationErrors":[{"code":28037,"message":"'bankStatement' was missing.","remediatingActions":[{"code":1703,"message":"Upload a bank statement"}],"type":"dataMissing"}]},{"entity":{"id":"SE3222Z223222Q5J4D58K3DWP","type":"BankAccount"},"verificationErrors":[{"code":28037,"message":"'bankStatement' was missing.","remediatingActions":[{"code":1703,"message":"Upload a bank statement"}],"type":"dataMissing"}]},{"entity":{"id":"LE43319330319C8AYX89L2V59","type":"LegalEntity"},"verificationErrors":[{"code":28189,"message":"'UBO through control' was missing.","remediatingActions":[{"code":2151,"message":"Add 'organization.entityAssociations' of type 'uboThroughControl' to legal entity"}],"type":"dataMissing"},{"code":150,"message":"Organization details couldn't be verified","subErrors":[{"code":15016,"message":"The tax ID number couldn't be verified","remediatingActions":[{"code":1500,"message":"Update organization details"},{"code":1501,"message":"Upload a registration document"}],"type":"invalidInput"}],"type":"invalidInput"},{"code":28067,"message":"'Signatory' was missing.","remediatingActions":[{"code":2124,"message":"Add 'organization.entityAssociations' of type 'signatory' to legal entity"}],"type":"dataMissing"}]}],"requested":true,"transferInstruments":[{"allowed":false,"enabled":true,"id":"SE576BH223222F5GJVKHH6BDT","requested":true,"verificationStatus":"pending"},{"allowed":false,"enabled":true,"id":"SE3222Z223222Q5J4D58K3DWP","requested":true,"verificationStatus":"pending"}],"verificationStatus":"pending"}},"id":"AH32272223222B5CZW6QZ2V34","legalEntityId":"LE43319330319C8AYX89L2V59","reference":"YOUR_REFERENCE-2412C","status":"Active"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"live","type":"balancePlatform.accountHolder.updated"}},"post-balancePlatform.balanceAccount.created-balancePlatform-balanceAccount-created":{"description":"Example webhook when a balance account was created","summary":"Balance account created","value":{"data":{"balanceAccount":{"accountHolderId":"AH3227C223222B5CZW72CCC73","defaultCurrencyCode":"EUR","id":"BA3227C223222B5CZW72VCC75","status":"Active"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"test","type":"balancePlatform.balanceAccount.created"}},"post-balancePlatform.balanceAccount.updated-balancePlatform-balanceAccount-updated":{"description":"Example webhook when a balance account was updated","summary":"Balance account updated","value":{"data":{"balanceAccount":{"accountHolderId":"AH3227C223222B5CZW72CCC73","defaultCurrencyCode":"EUR","id":"BA3227C223222B5CZW72VCC75","status":"Active","timeZone":"Europe/Amsterdam"},"balancePlatform":"YOUR_BALANCE_PLATFORM"},"environment":"test","type":"balancePlatform.balanceAccount.updated"}},"post-balancePlatform.balanceAccountSweep.created-balancePlatform-sweep-created":{"description":"Example webhook when a sweep was created","summary":"Sweep created","value":{"data":{"accountId":"BA3227C223222B5FTD99V8GRS","balancePlatform":"YOUR_BALANCE_PLATFORM","sweep":{"counterparty":{"balanceAccountId":"BA32272223222B5FTD2KR6TJD"},"currency":"EUR","id":"SWPC4227C224555B5FTD2NT2JV4WN5","schedule":{"type":"weekly"},"status":"active","targetAmount":{"currency":"EUR","value":0},"triggerAmount":{"currency":"EUR","value":0},"type":"push"}},"environment":"test","type":"balancePlatform.balanceAccountSweep.created"}},"post-balancePlatform.balanceAccountSweep.deleted-balancePlatform-sweep-deleted":{"description":"Example webhook when a sweep was deleted","summary":"Sweep deleted","value":{"data":{"accountId":"BA3227C223222B5FTD99V8GRS","balancePlatform":"YOUR_BALANCE_PLATFORM","sweep":{"counterparty":{"balanceAccountId":"BA32272223222B5FTD2KR6TJD"},"currency":"EUR","id":"SWPC4227C224555B5FTD2NT2JV4WN5","schedule":{"type":"weekly"},"status":"active","targetAmount":{"currency":"EUR","value":0},"triggerAmount":{"currency":"EUR","value":0},"type":"push"}},"environment":"test","type":"balancePlatform.balanceAccountSweep.deleted"}},"post-balancePlatform.balanceAccountSweep.updated-balancePlatform-sweep-updated":{"description":"Example webhook when a sweep was updated","summary":"Sweep updated","value":{"data":{"accountId":"BA3227C223222B5FTD99V8GRS","balancePlatform":"YOUR_BALANCE_PLATFORM","sweep":{"counterparty":{"balanceAccountId":"BA32272223222B5FTD2KR6TJD"},"currency":"EUR","id":"SWPC4227C224555B5FTD2NT2JV4WN5","schedule":{"type":"weekly"},"status":"inactive","targetAmount":{"currency":"EUR","value":0},"triggerAmount":{"currency":"EUR","value":0},"type":"push"}},"environment":"test","type":"balancePlatform.balanceAccountSweep.created"}},"post-balancePlatform.paymentInstrument.created-balancePlatform-paymentInstrument-created":{"description":"Example webhook when a card was created","summary":"Card created","value":{"data":{"balancePlatform":"YOUR_BALANCE_PLATFORM","paymentInstrument":{"balanceAccountId":"BA3227C223222B5CZW72VCC75","card":{"bin":"555544","brand":"mc","brandVariant":"mc","cardholderName":"Carl Holden","expiration":{"month":"04","year":"2024"},"formFactor":"virtual","lastFour":"2732","number":"4010100000000000000"},"description":"C. Holden - card","id":"PI32272223222B5CZW7BQ2V3T","issuingCountryCode":"GB","status":"Active","type":"card"}},"environment":"test","type":"balancePlatform.paymentInstrument.created"}},"post-balancePlatform.paymentInstrument.updated-balancePlatform-paymentInstrument-updated":{"description":"Example webhook when a card was updated","summary":"Card updated","value":{"data":{"balancePlatform":"YOUR_BALANCE_PLATFORM","paymentInstrument":{"balanceAccountId":"BA3227C223222B5CZW72VCC75","card":{"bin":"555544","brand":"mc","brandVariant":"mc","cardholderName":"Carl Holden","expiration":{"month":"04","year":"2024"},"formFactor":"virtual","lastFour":"2732","number":"4010100000000000000"},"description":"C. Holden - card","id":"PI32272223222B5CZW7BQ2V3T","issuingCountryCode":"GB","status":"Suspended","type":"card"}},"environment":"test","type":"balancePlatform.paymentInstrument.updated"}}},"schemas":{"AccountHolder":{"properties":{"balancePlatform":{"description":"The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.","type":"string"},"capabilities":{"additionalProperties":{"$ref":"#/components/schemas/AccountHolderCapability"},"description":"Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.","type":"object"},"contactDetails":{"$ref":"#/components/schemas/ContactDetails","deprecated":true,"description":"Contact details of the account holder."},"description":{"description":"Your description for the account holder, maximum 300 characters.","maxLength":300,"type":"string"},"id":{"description":"The unique identifier of the account holder.","type":"string"},"legalEntityId":{"description":"The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"A set of key and value pairs for general use.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.","type":"object"},"migratedAccountHolderCode":{"description":"The unique identifier of the migrated account holder in the classic integration.","type":"string"},"primaryBalanceAccount":{"description":"The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.","type":"string"},"reference":{"description":"Your reference for the account holder, maximum 150 characters.","maxLength":150,"type":"string"},"status":{"description":"The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This is the default status when creating an account holder. \n\n * **Inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. \n\n * **Suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. \n\n* **Closed**: The account holder is permanently deactivated by you. This action cannot be undone.","enum":["Active","Closed","Inactive","Suspended"],"type":"string"},"timeZone":{"description":"The time zone of the account holder. For example, **Europe/Amsterdam**.\nDefaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","type":"string"},"verificationDeadlines":{"description":"List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.","items":{"$ref":"#/components/schemas/VerificationDeadline"},"type":"array"}},"required":["legalEntityId","id"],"type":"object"},"AccountHolderCapability":{"properties":{"allowed":{"description":"Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.","type":"boolean"},"allowedLevel":{"description":"The capability level that is allowed for the account holder.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.","enum":["high","low","medium","notApplicable"],"type":"string"},"allowedSettings":{"$ref":"#/components/schemas/CapabilitySettings","description":"A JSON object containing the settings that are allowed for the account holder."},"enabled":{"description":"Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.","type":"boolean"},"problems":{"description":"Contains verification errors and the actions that you can take to resolve them.","items":{"$ref":"#/components/schemas/CapabilityProblem"},"type":"array"},"requested":{"description":"Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.","type":"boolean"},"requestedLevel":{"description":"The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.","enum":["high","low","medium","notApplicable"],"type":"string"},"requestedSettings":{"$ref":"#/components/schemas/CapabilitySettings","description":"A JSON object containing the settings that were requested for the account holder."},"transferInstruments":{"description":"Contains the status of the transfer instruments associated with this capability. ","items":{"$ref":"#/components/schemas/AccountSupportingEntityCapability"},"type":"array"},"verificationStatus":{"description":"The status of the verification checks for the capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n","enum":["invalid","pending","rejected","valid"],"type":"string"}},"type":"object"},"AccountHolderNotificationData":{"properties":{"accountHolder":{"$ref":"#/components/schemas/AccountHolder","description":"Contains information about the account holder resource that triggered the event."},"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"}},"type":"object"},"AccountHolderNotificationRequest":{"properties":{"data":{"$ref":"#/components/schemas/AccountHolderNotificationData","description":"Contains event details."},"environment":{"description":"The environment from which the webhook originated.\n\nPossible values: **test**, **live**.","type":"string"},"type":{"description":"Type of webhook.","enum":["balancePlatform.accountHolder.updated","balancePlatform.accountHolder.created"],"type":"string"}},"required":["environment","type","data"],"type":"object"},"AccountSupportingEntityCapability":{"properties":{"allowed":{"description":"Indicates whether the supporting entity capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.","type":"boolean"},"allowedLevel":{"description":"The capability level that is allowed for the account holder.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.","enum":["high","low","medium","notApplicable"],"type":"string"},"enabled":{"description":"Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.","type":"boolean"},"id":{"description":"The ID of the supporting entity.","type":"string"},"requested":{"description":"Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.","type":"boolean"},"requestedLevel":{"description":"The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.","enum":["high","low","medium","notApplicable"],"type":"string"},"verificationStatus":{"description":"The status of the verification checks for the supporting entity capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n","enum":["invalid","pending","rejected","valid"],"type":"string"}},"type":"object"},"Address":{"properties":{"city":{"description":"The name of the city. Maximum length: 3000 characters.","maxLength":3000,"type":"string"},"country":{"description":"The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.","type":"string"},"houseNumberOrName":{"description":"The number or name of the house. Maximum length: 3000 characters.","maxLength":3000,"type":"string"},"postalCode":{"description":"A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.","type":"string"},"stateOrProvince":{"description":"The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.","type":"string"},"street":{"description":"The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.","maxLength":3000,"type":"string"}},"required":["street","houseNumberOrName","city","postalCode","country"],"type":"object"},"Amount":{"properties":{"currency":{"description":"The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).","maxLength":3,"minLength":3,"type":"string"},"value":{"description":"The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).","format":"int64","type":"integer"}},"required":["value","currency"],"type":"object"},"Authentication":{"properties":{"email":{"description":"The email address where the one-time password (OTP) is sent.","type":"string"},"password":{"description":"The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters.\n\n* Characters between **a-z**, **A-Z**, and **0-9**\n\n* Special characters: **äöüßÄÖÜ+-*/ç%()=?!~#'\",;:$&àùòâôûáúó**","maxLength":30,"minLength":1,"type":"string"},"phone":{"$ref":"#/components/schemas/Phone","description":"The phone number where the one-time password (OTP) is sent.\n\nThis object must have:\n\n* A `type` set to **mobile**.\n\n* A `number` with a valid country code.\n\n* A `number` with more than 4 digits, excluding the country code.\n\n>Make sure to verify that the card user owns the phone number."}},"type":"object"},"Balance":{"properties":{"available":{"description":"The remaining amount available for spending.","format":"int64","type":"integer"},"balance":{"description":"The total amount in the balance.","format":"int64","type":"integer"},"currency":{"description":"The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.","type":"string"},"pending":{"description":"The amount pending to be paid out but not yet available in the balance.","format":"int64","type":"integer"},"reserved":{"description":"The amount reserved for payments that have been authorised, but have not been captured yet.","format":"int64","type":"integer"}},"required":["currency","balance","reserved","available"],"type":"object"},"BalanceAccount":{"properties":{"accountHolderId":{"description":"The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.","type":"string"},"balances":{"description":"List of balances with the amount and currency.","items":{"$ref":"#/components/schemas/Balance"},"type":"array"},"defaultCurrencyCode":{"description":"The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.","type":"string"},"description":{"description":"A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.","maxLength":300,"type":"string"},"id":{"description":"The unique identifier of the balance account.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"A set of key and value pairs for general use.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.","type":"object"},"migratedAccountCode":{"description":"The unique identifier of the account of the migrated account holder in the classic integration.","type":"string"},"paymentInstruments":{"description":"List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account.","items":{"$ref":"#/components/schemas/PaymentInstrumentReference"},"type":"array"},"platformPaymentConfiguration":{"$ref":"#/components/schemas/PlatformPaymentConfiguration","description":"Contains key-value pairs to the configure the settlement model in a balance account."},"reference":{"description":"Your reference for the balance account, maximum 150 characters.","maxLength":150,"type":"string"},"status":{"description":"The status of the balance account, set to **Active** by default. \n","enum":["Active","Closed","Inactive","Suspended"],"type":"string"},"timeZone":{"description":"The time zone of the balance account. For example, **Europe/Amsterdam**.\nDefaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","type":"string"}},"required":["accountHolderId","id"],"type":"object"},"BalanceAccountNotificationData":{"properties":{"balanceAccount":{"$ref":"#/components/schemas/BalanceAccount"},"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"}},"type":"object"},"BalanceAccountNotificationRequest":{"properties":{"data":{"$ref":"#/components/schemas/BalanceAccountNotificationData","description":"Contains event details."},"environment":{"description":"The environment from which the webhook originated.\n\nPossible values: **test**, **live**.","type":"string"},"type":{"description":"Type of webhook.","enum":["balancePlatform.balanceAccount.updated","balancePlatform.balanceAccount.created"],"type":"string"}},"required":["environment","type","data"],"type":"object"},"BalancePlatformNotificationResponse":{"properties":{"notificationResponse":{"description":"Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).","type":"string"}},"type":"object"},"BulkAddress":{"properties":{"city":{"description":"The name of the city.","type":"string"},"company":{"description":"The name of the company.","type":"string"},"country":{"description":"The two-character ISO-3166-1 alpha-2 country code. For example, **US**.","type":"string"},"email":{"description":"The email address.","type":"string"},"houseNumberOrName":{"description":"The house number or name.","type":"string"},"mobile":{"description":"The full telephone number.","type":"string"},"postalCode":{"description":"The postal code.\n\nMaximum length:\n\n* 5 digits for addresses in the US.\n\n* 10 characters for all other countries.","type":"string"},"stateOrProvince":{"description":"The two-letter ISO 3166-2 state or province code.\n\nMaximum length: 2 characters for addresses in the US.","type":"string"},"street":{"description":"The streetname of the house.","type":"string"}},"required":["country"],"type":"object"},"CapabilityProblem":{"properties":{"entity":{"$ref":"#/components/schemas/CapabilityProblemEntity","description":"Contains the type of the entity and the corresponding ID."},"verificationErrors":{"description":"Contains information about the verification error.","items":{"$ref":"#/components/schemas/VerificationError"},"type":"array"}},"type":"object"},"CapabilityProblemEntity":{"properties":{"documents":{"description":"List of document IDs to which the verification errors related to the capabilities correspond to.","items":{"type":"string"},"type":"array"},"id":{"description":"The ID of the entity.","type":"string"},"owner":{"$ref":"#/components/schemas/CapabilityProblemEntity-recursive","description":"Contains details about the owner of the entity that has an error."},"type":{"description":"Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**.","enum":["BankAccount","Document","LegalEntity"],"type":"string"}},"type":"object"},"CapabilityProblemEntity-recursive":{"properties":{"documents":{"description":"List of document IDs to which the verification errors related to the capabilities correspond to.","items":{"type":"string"},"type":"array"},"id":{"description":"The ID of the entity.","type":"string"},"type":{"description":"Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**.","enum":["BankAccount","Document","LegalEntity"],"type":"string"}},"type":"object"},"CapabilitySettings":{"properties":{"amountPerIndustry":{"additionalProperties":{"$ref":"#/components/schemas/Amount"},"description":"","type":"object"},"authorizedCardUsers":{"description":"","type":"boolean"},"fundingSource":{"description":"","items":{"enum":["credit","debit","prepaid"],"type":"string"},"type":"array"},"interval":{"description":"","enum":["daily","monthly","weekly"],"type":"string"},"maxAmount":{"$ref":"#/components/schemas/Amount","description":""}},"type":"object"},"Card":{"properties":{"authentication":{"$ref":"#/components/schemas/Authentication","description":"Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information."},"bin":{"description":"The bank identification number (BIN) of the card number.","type":"string"},"brand":{"description":"The brand of the physical or the virtual card.\nPossible values: **visa**, **mc**.","type":"string"},"brandVariant":{"description":"The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**.\n>Reach out to your Adyen contact to get the values relevant for your integration.","type":"string"},"cardholderName":{"description":"The name of the cardholder.\n Maximum length: 26 characters.","maxLength":26,"type":"string"},"configuration":{"$ref":"#/components/schemas/CardConfiguration","description":"Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object."},"cvc":{"description":"The CVC2 value of the card.\n> The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.","type":"string"},"deliveryContact":{"$ref":"#/components/schemas/Contact","description":"The delivery contact (name and address) for physical card delivery."},"expiration":{"$ref":"#/components/schemas/Expiry","description":"The expiration date of the card."},"formFactor":{"description":"The form factor of the card.\nPossible values: **virtual**, **physical**.","enum":["physical","unknown","virtual"],"type":"string"},"lastFour":{"description":"Last last four digits of the card number.","type":"string"},"number":{"description":"The primary account number (PAN) of the card.\n> The PAN is masked by default and returned only for single-use virtual cards.","type":"string"},"threeDSecure":{"description":"Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n>Reach out to your Adyen contact to get the values relevant for your integration.","type":"string"}},"required":["formFactor","cardholderName","brand","brandVariant","number"],"type":"object"},"CardConfiguration":{"properties":{"activation":{"description":"Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.","type":"string"},"activationUrl":{"description":"Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. \n\nMaximum length: 255 characters.","maxLength":255,"type":"string"},"bulkAddress":{"$ref":"#/components/schemas/BulkAddress","description":"Overrides the shipment bulk address defined in the `configurationProfileId`."},"cardImageId":{"description":"The ID of the card image. This is the image that will be printed on the full front of the card.","type":"string"},"carrier":{"description":"Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.","type":"string"},"carrierImageId":{"description":"The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.","type":"string"},"configurationProfileId":{"description":"The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them.\n\nFor example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.","type":"string"},"currency":{"description":"The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.","type":"string"},"envelope":{"description":"Overrides the envelope design ID defined in the `configurationProfileId`. ","type":"string"},"insert":{"description":"Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.","type":"string"},"language":{"description":"The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.","type":"string"},"logoImageId":{"description":"The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.","type":"string"},"pinMailer":{"description":"Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.","type":"string"},"shipmentMethod":{"description":"Overrides the logistics company defined in the `configurationProfileId`.","type":"string"}},"required":["configurationProfileId"],"type":"object"},"CardOrderItem":{"properties":{"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"},"card":{"$ref":"#/components/schemas/CardOrderItemDeliveryStatus","description":"The status of the card delivery.\n\nPossible values: **created**, **rejected**, **processing**, **produced**, **shipped**, **delivered**, **notApplicable**, **unknown**. "},"cardOrderItemId":{"description":"The unique identifier of the card order item.","type":"string"},"creationDate":{"description":"The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.","format":"date-time","type":"string"},"id":{"description":"The ID of the resource.","type":"string"},"paymentInstrumentId":{"description":"The unique identifier of the payment instrument related to the card order item.","type":"string"},"pin":{"$ref":"#/components/schemas/CardOrderItemDeliveryStatus","description":"Contains information about the status of the PIN delivery."},"shippingMethod":{"description":"The shipping method used to deliver the card or the PIN.","type":"string"}},"type":"object"},"CardOrderItemDeliveryStatus":{"properties":{"errorMessage":{"description":"An error message.","type":"string"},"status":{"description":"The status of the PIN delivery.","enum":["created","delivered","notApplicable","processing","produced","rejected","shipped","unknown"],"type":"string"},"trackingNumber":{"description":"The tracking number of the PIN delivery.","type":"string"}},"type":"object"},"CardOrderNotificationRequest":{"properties":{"data":{"$ref":"#/components/schemas/CardOrderItem","description":"Contains event details."},"environment":{"description":"The environment from which the webhook originated.\n\nPossible values: **test**, **live**.","type":"string"},"type":{"description":"Type of webhook.","enum":["balancePlatform.cardorder.created","balancePlatform.cardorder.updated"],"type":"string"}},"required":["environment","type","data"],"type":"object"},"Contact":{"properties":{"address":{"$ref":"#/components/schemas/Address","description":"The address of the contact."},"email":{"description":"The e-mail address of the contact.","type":"string"},"fullPhoneNumber":{"description":"The phone number of the contact provided as a single string.  It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"","type":"string"},"name":{"$ref":"#/components/schemas/Name","description":"The name of the contact."},"personalData":{"$ref":"#/components/schemas/PersonalData","description":"Personal data of the contact."},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber","description":"The phone number of the contact."},"webAddress":{"description":"The URL of the website of the contact.","type":"string"}},"type":"object"},"ContactDetails":{"properties":{"address":{"$ref":"#/components/schemas/Address","description":"The address of the account holder."},"email":{"description":"The email address of the account holder.","type":"string"},"phone":{"$ref":"#/components/schemas/Phone","description":"The phone number of the account holder."},"webAddress":{"description":"The URL of the account holder's website.","type":"string"}},"required":["email","phone","address"],"type":"object"},"Expiry":{"properties":{"month":{"description":"The month in which the card will expire.","type":"string"},"year":{"description":"The year in which the card will expire.","type":"string"}},"type":"object"},"IbanAccountIdentification":{"additionalProperties":false,"properties":{"formFactor":{"default":"physical","description":"The form factor of bank account.","type":["string","null"]},"iban":{"description":"The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.","type":"string"},"type":{"default":"iban","description":"**iban**","enum":["iban"],"type":"string"}},"required":["type","iban"],"type":"object"},"Name":{"properties":{"firstName":{"description":"The first name.","maxLength":80,"type":"string"},"lastName":{"description":"The last name.","maxLength":80,"type":"string"}},"required":["firstName","lastName"],"type":"object"},"PaymentInstrument":{"properties":{"balanceAccountId":{"description":"The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.","type":"string"},"bankAccount":{"description":"Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**.","oneOf":[{"$ref":"#/components/schemas/IbanAccountIdentification"},{"$ref":"#/components/schemas/USLocalAccountIdentification"}]},"card":{"$ref":"#/components/schemas/Card","description":"Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**."},"description":{"description":"Your description for the payment instrument, maximum 300 characters.","maxLength":300,"type":"string"},"id":{"description":"The unique identifier of the payment instrument.","type":"string"},"issuingCountryCode":{"description":"The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.","type":"string"},"paymentInstrumentGroupId":{"description":"The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.","type":"string"},"reference":{"description":"Your reference for the payment instrument, maximum 150 characters.","maxLength":150,"type":"string"},"status":{"description":"The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **Active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**:  The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable for physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ","enum":["Active","Closed","Inactive","Lost","Requested","Stolen","Suspended","blocked","discarded"],"type":"string"},"type":{"description":"Type of payment instrument.\n\nPossible value: **card**, **bankAccount**. ","enum":["bankAccount","card"],"type":"string"}},"required":["balanceAccountId","issuingCountryCode","type","id"],"type":"object"},"PaymentInstrumentNotificationData":{"properties":{"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument","description":"Contains information about the payment instrument resource that triggered the event."}},"type":"object"},"PaymentInstrumentReference":{"properties":{"id":{"description":"The unique identifier of the payment instrument.","type":"string"}},"required":["id"],"type":"object"},"PaymentNotificationRequest":{"properties":{"data":{"$ref":"#/components/schemas/PaymentInstrumentNotificationData","description":"Contains event details."},"environment":{"description":"The environment from which the webhook originated.\n\nPossible values: **test**, **live**.","type":"string"},"type":{"description":"Type of webhook.","enum":["balancePlatform.paymentInstrument.created","balancePlatform.paymentInstrument.updated"],"type":"string"}},"required":["environment","type","data"],"type":"object"},"PersonalData":{"properties":{"dateOfBirth":{"description":"The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).","type":"string"},"idNumber":{"description":"An ID number of the person.","type":"string"},"nationality":{"description":"The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').","maxLength":2,"minLength":2,"type":"string"}},"type":"object"},"Phone":{"properties":{"number":{"description":"The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**.","type":"string"},"type":{"description":"Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n","enum":["Landline","Mobile"],"type":"string"}},"required":["number","type"],"type":"object"},"PhoneNumber":{"properties":{"phoneCountryCode":{"description":"The two-character ISO-3166-1 alpha-2 country code of the phone number.\nFor example, **US** or **NL**.","type":"string"},"phoneNumber":{"description":"The phone number.\nThe inclusion of the phone number country code is not necessary.","type":"string"},"phoneType":{"description":"The type of the phone number.\nPossible values: **Landline**, **Mobile**, **SIP**, **Fax**.","enum":["Fax","Landline","Mobile","SIP"],"type":"string"}},"type":"object"},"PlatformPaymentConfiguration":{"properties":{"salesDayClosingTime":{"description":"Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends.\n\nPossible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.\n\nDefault value: **\"00:00\"**.","format":"time","type":"string"},"settlementDelayDays":{"description":"Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available.\n\nPossible values: **0** to **10**, or **null**.\n* Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).\n* Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).\n\nDefault value: **null**.","format":"int32","type":"integer"}},"type":"object"},"RemediatingAction":{"properties":{"code":{"description":"The remediating action code.","type":"string"},"message":{"description":"A description of how you can resolve the verification error.","type":"string"}},"type":"object"},"Resource":{"properties":{"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"},"creationDate":{"description":"The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.","format":"date-time","type":"string"},"id":{"description":"The ID of the resource.","type":"string"}},"type":"object"},"SweepConfigurationNotificationData":{"properties":{"accountId":{"description":"The unique identifier of the balance account for which the sweep was configured.","type":"string"},"balancePlatform":{"description":"The unique identifier of the balance platform.","type":"string"},"sweep":{"$ref":"#/components/schemas/SweepConfigurationV2","description":"Contains information about the sweep resource that triggered the event."}},"type":"object"},"SweepConfigurationNotificationRequest":{"properties":{"data":{"$ref":"#/components/schemas/SweepConfigurationNotificationData","description":"Contains event details."},"environment":{"description":"The environment from which the webhook originated.\n\nPossible values: **test**, **live**.","type":"string"},"type":{"description":"Type of webhook.","enum":["balancePlatform.balanceAccountSweep.created","balancePlatform.balanceAccountSweep.updated","balancePlatform.balanceAccountSweep.deleted"],"type":"string"}},"required":["environment","type","data"],"type":"object"},"SweepConfigurationV2":{"properties":{"counterparty":{"$ref":"#/components/schemas/SweepCounterparty","description":"The destination or the source of the funds, depending on the sweep `type`.\n\nEither a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required."},"currency":{"description":"The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**.\n\nThe sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).","type":"string"},"description":{"description":"The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.\n\nIf the message is longer after replacing placeholders, the message will be cut off at 140 characters.","type":"string"},"id":{"description":"The unique identifier of the sweep.","type":"string"},"reason":{"description":"The reason for disabling the sweep.","enum":["amountLimitExceeded","approved","balanceAccountTemporarilyBlockedByTransactionRule","counterpa