> ## Documentation Index > Fetch the complete documentation index at: https://docs.augustus.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers. > Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required. > Cite or link the relevant docs.augustus.com page when answering integration questions. > Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation. > Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key. > The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions. # merchant_updated > Your merchant account has been updated ## OpenAPI ````yaml https://api.getivy.de/openapi/webhooks/json post /api/service/webhook-event/merchant_updated openapi: 3.0.0 info: title: Ivy Webhook Events description: Ivy Webhook Events schema version: '1.0' contact: name: Ivy url: https://www.getivy.io email: help@getivy.io servers: [] security: [] tags: [] paths: /api/service/webhook-event/merchant_updated: post: tags: - WebhookEventExamples - Deprecated summary: merchant_updated description: Your merchant account has been updated operationId: WebhookEventExamplesController_merchantUpdated parameters: [] requestBody: required: true description: Data of the webhook event content: application/json: schema: $ref: '#/components/schemas/MerchantUpdatedWebhookEventDto' responses: '200': description: OK deprecated: true servers: - url: https://{yourDomain} variables: yourDomain: description: The URL where you want to receive webhook events default: www.your-domain.com components: schemas: MerchantUpdatedWebhookEventDto: type: object properties: id: description: The unique id for the webhook. type: string type: type: string enum: - merchant_updated date: description: The date of the webhook. type: string payload: description: The updated merchant data. type: object properties: id: type: string createdAt: {} updatedAt: {} legalName: description: The company’s legal name. type: string displayName: description: The customer-facing business name. type: string internalApplicationName: description: >- This is the name that will be displayed in the merchant dashboard. type: string email: description: >- The email address of the account holder. This is only to make the account easier to identify to you. type: string phone: description: The company’s phone number (used for verification). type: string mobilePhone: description: The company’s mobile phone number (used for verification). type: string address: type: object properties: firstName: type: string lastName: type: string line1: type: string minLength: 1 line2: type: string region: type: string city: type: string minLength: 1 zipCode: type: string minLength: 1 country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country onboardingData: description: Merchant onboarding data including KYB verification link. type: object properties: vatNumber: description: The company's VAT number type: string companyName: type: string registrationNumber: type: string country: type: string incorporatedOn: type: string companyType: type: string companyEmail: type: string companyPhone: type: string legalAddress: type: string website: type: string companyAddress: type: object properties: street: type: string buildingNumber: type: string subStreet: type: string town: type: string postCode: type: string country: type: string beneficiaries: type: array items: type: object properties: types: type: array items: type: string shareSize: type: number firstName: type: string middleName: type: string lastName: type: string dob: type: string gender: type: string placeOfBirth: type: string countryOfBirth: type: string nationality: type: string taxResidenceCountry: type: string address: type: object properties: street: type: string buildingNumber: type: string subStreet: type: string town: type: string postCode: type: string country: type: string idDocs: type: array items: type: object properties: idDocType: type: string country: type: string number: type: string dob: type: string issuedDate: type: string validUntil: type: string kybWebSdkUrl: type: string kybStatus: type: string enum: - init - awaitingUser - pending - onHold - retry - accepted - rejected kybAcceptedModalShown: type: boolean sumsubApplicantId: type: string taktileLegalEntityId: type: string category: description: >- The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide. type: string websiteUrl: description: The business’s publicly available website. type: string applicationFeeShare: description: The custom variable application Fee. For example, 0.05 for 5%. type: number minimum: 0 exclusiveMinimum: false applicationFixedFeeShare: description: >- The custom fixed application Fee in cents. For example, 20 for EUR 0.20. type: number minimum: 0 exclusiveMinimum: false payout: type: object properties: verified: type: boolean enabled: type: boolean status: type: string enum: - pending - rejected - started - verified isPayoutsDataAvailable: type: boolean required: - verified - enabled - status - isPayoutsDataAvailable appId: description: Unique id of the merchant app. type: string apps: description: The apps corresponding to the merchant. type: array items: type: object properties: id: type: string shopLogo: description: The Logo of the Shop. Only URLs are allowed. type: string quoteCallbackUrl: description: >- Quote Callback requests will be sent to this URL on default. type: string completeCallbackUrl: description: >- Complete Callback requests will be sent to this URL on default. type: string websiteUrl: description: The business’s publicly available website. type: string platformType: description: The Platform of the merchant. type: string enum: - shopify - woo_commerce - shopware - magento - other x-enumNames: - shopify - woo_commerce - shopware - magento - other hasApiKey: type: boolean successCallbackUrl: description: >- Users will be redirected her on default after a successful checkout. type: string errorCallbackUrl: description: >- Users will be redirected her on default after an unsuccessful checkout. type: string webhookUrl: description: The default webhook url used to send events from Ivy. type: string defaultWebhookSubscription: {} offsetProject: description: >- The default project where Ivy will give money to per transaction. type: string privacyUrl: description: >- The data and privacy rules of the merchant. Only valid URLs are accepted. type: string tosUrl: description: >- The Terms and Services of the merchant. Only valid URLs are accepted. type: string buttonOnlyShopTrees: type: boolean climateActionMode: type: object properties: type: description: The climate action mode of the merchant. type: string enum: - transaction - amount x-enumNames: - transaction - amount amount: type: number default: 0 required: - type impactOffsetProjects: type: array items: {} default: [] notificationSettings: type: object properties: webhookFailure: type: object properties: emailNotification: type: object properties: active: type: boolean emails: type: array items: type: string format: email required: - active - emails required: - emailNotification required: - webhookFailure manuallyApproved: type: boolean updatedAt: {} createdAt: {} v1WebhookSigningSecrets: type: array maxItems: 2 items: type: object properties: createdAt: {} expiresAt: {} required: - createdAt required: - id - platformType - hasApiKey - updatedAt - createdAt users: type: array items: type: string impactAccount: type: boolean plan: type: object properties: dealType: description: The deal type of the merchant. type: string enum: - S - M - L - custom x-enumNames: - S - M - L - CUSTOM refundApplicationFee: description: Refund the application fee. type: boolean applicationFeeShare: description: >- The custom variable application Fee. For example, 0.05 for 5%. type: number minimum: 0 exclusiveMinimum: false applicationFixedFeeShare: description: >- The custom fixed application Fee in cents. For example, 20 for EUR 0.20. type: number minimum: 0 exclusiveMinimum: false amountFreeTransactions: description: >- The amount of free transactions per month. For example, 10 for 10 free transactions. type: number minimum: 0 exclusiveMinimum: false monthlyInvoiceTotal: description: >- The monthly invoice total in cents. For example, 1000 for EUR 10.00. type: number minimum: 0 exclusiveMinimum: false required: - dealType - refundApplicationFee - applicationFeeShare - applicationFixedFeeShare - amountFreeTransactions - monthlyInvoiceTotal pairedMerchantId: {} blacklistedBankIds: type: array items: type: string default: [] blacklistedOpenBankingProvidersByMarket: type: array items: type: object properties: market: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK blacklistedOpenBankingProviders: type: array items: type: string enum: - Token - TokenIvyLicence - Mock - Tink - TinkIvyLicence - Yapily - EnableBanking - Manual x-enumNames: - Token - TokenIvyLicence - Mock - Tink - TinkIvyLicence - Yapily - EnableBanking - Manual required: - market - blacklistedOpenBankingProviders marketCapabilitySettings: type: array items: type: object properties: market: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK capabilities: type: array items: type: string enum: - ais - pis x-enumNames: - AIS - PIS required: - market - capabilities themeName: type: string enum: - default - kraken - inpay - kucoin - kryptonim - telekom - okx - whitebit - bybit deletedAt: {} ssoEnabled: type: boolean enabledSurfaces: type: array minItems: 1 items: type: string enum: - legacy - v1 shopLogo: description: The Logo of the Shop. Only URLs are allowed. type: string quoteCallbackUrl: description: Quote Callback requests will be sent to this URL on default. type: string completeCallbackUrl: description: Complete Callback requests will be sent to this URL on default. type: string platformType: description: The Platform of the merchant. type: string enum: - shopify - woo_commerce - shopware - magento - other x-enumNames: - shopify - woo_commerce - shopware - magento - other hasApiKey: type: boolean successCallbackUrl: description: >- Users will be redirected her on default after a successful checkout. type: string errorCallbackUrl: description: >- Users will be redirected her on default after an unsuccessful checkout. type: string webhookUrl: description: The default webhook url used to send events from Ivy. type: string defaultWebhookSubscription: {} offsetProject: description: >- The default project where Ivy will give money to per transaction. type: string privacyUrl: description: >- The data and privacy rules of the merchant. Only valid URLs are accepted. type: string tosUrl: description: >- The Terms and Services of the merchant. Only valid URLs are accepted. type: string buttonOnlyShopTrees: type: boolean climateActionMode: type: object properties: type: description: The climate action mode of the merchant. type: string enum: - transaction - amount x-enumNames: - transaction - amount amount: type: number default: 0 required: - type impactOffsetProjects: type: array items: {} default: [] notificationSettings: type: object properties: webhookFailure: type: object properties: emailNotification: type: object properties: active: type: boolean emails: type: array items: type: string format: email required: - active - emails required: - emailNotification required: - webhookFailure manuallyApproved: type: boolean v1WebhookSigningSecrets: type: array maxItems: 2 items: type: object properties: createdAt: {} expiresAt: {} required: - createdAt required: - id - createdAt - updatedAt - legalName - displayName - email - appId - users - plan - marketCapabilitySettings - platformType - hasApiKey required: - id - type - date - payload ````