Skip to main content
POST
/
api
/
service
/
webhook-event
/
merchant_updated
merchant_updated
curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/merchant_updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "date": "<string>",
  "payload": {
    "id": "<string>",
    "createdAt": "<unknown>",
    "updatedAt": "<unknown>",
    "legalName": "<string>",
    "displayName": "<string>",
    "email": "<string>",
    "appId": "<string>",
    "users": [
      "<string>"
    ],
    "plan": {
      "refundApplicationFee": true,
      "applicationFeeShare": 1,
      "applicationFixedFeeShare": 1,
      "amountFreeTransactions": 1,
      "monthlyInvoiceTotal": 1
    },
    "marketCapabilitySettings": [
      {
        "capabilities": []
      }
    ],
    "hasApiKey": true,
    "internalApplicationName": "<string>",
    "phone": "<string>",
    "mobilePhone": "<string>",
    "onboardingData": {
      "vatNumber": "<string>",
      "companyName": "<string>",
      "registrationNumber": "<string>",
      "country": "<string>",
      "incorporatedOn": "<string>",
      "companyType": "<string>",
      "companyEmail": "<string>",
      "companyPhone": "<string>",
      "legalAddress": "<string>",
      "website": "<string>",
      "companyAddress": {
        "street": "<string>",
        "buildingNumber": "<string>",
        "subStreet": "<string>",
        "town": "<string>",
        "postCode": "<string>",
        "country": "<string>"
      },
      "beneficiaries": [
        {
          "types": [
            "<string>"
          ],
          "shareSize": 123,
          "firstName": "<string>",
          "middleName": "<string>",
          "lastName": "<string>",
          "dob": "<string>",
          "gender": "<string>",
          "placeOfBirth": "<string>",
          "countryOfBirth": "<string>",
          "nationality": "<string>",
          "taxResidenceCountry": "<string>",
          "address": {
            "street": "<string>",
            "buildingNumber": "<string>",
            "subStreet": "<string>",
            "town": "<string>",
            "postCode": "<string>",
            "country": "<string>"
          },
          "idDocs": [
            {
              "idDocType": "<string>",
              "country": "<string>",
              "number": "<string>",
              "dob": "<string>",
              "issuedDate": "<string>",
              "validUntil": "<string>"
            }
          ]
        }
      ],
      "kybWebSdkUrl": "<string>",
      "kybAcceptedModalShown": true,
      "sumsubApplicantId": "<string>"
    },
    "category": "<string>",
    "websiteUrl": "<string>",
    "applicationFeeShare": 1,
    "applicationFixedFeeShare": 1,
    "apps": [
      {
        "id": "<string>",
        "hasApiKey": true,
        "updatedAt": "<unknown>",
        "createdAt": "<unknown>",
        "shopLogo": "<string>",
        "quoteCallbackUrl": "<string>",
        "completeCallbackUrl": "<string>",
        "websiteUrl": "<string>",
        "successCallbackUrl": "<string>",
        "errorCallbackUrl": "<string>",
        "webhookUrl": "<string>",
        "defaultWebhookSubscription": "<unknown>",
        "offsetProject": "<string>",
        "privacyUrl": "<string>",
        "tosUrl": "<string>",
        "buttonOnlyShopTrees": true,
        "impactOffsetProjects": [],
        "manuallyApproved": true,
        "v1WebhookSigningSecrets": [
          {
            "createdAt": "<unknown>",
            "expiresAt": "<unknown>"
          }
        ]
      }
    ],
    "impactAccount": true,
    "pairedMerchantId": "<unknown>",
    "blacklistedBankIds": [],
    "blacklistedOpenBankingProvidersByMarket": [
      {
        "blacklistedOpenBankingProviders": []
      }
    ],
    "deletedAt": "<unknown>",
    "ssoEnabled": true,
    "enabledSurfaces": [],
    "shopLogo": "<string>",
    "quoteCallbackUrl": "<string>",
    "completeCallbackUrl": "<string>",
    "successCallbackUrl": "<string>",
    "errorCallbackUrl": "<string>",
    "webhookUrl": "<string>",
    "defaultWebhookSubscription": "<unknown>",
    "offsetProject": "<string>",
    "privacyUrl": "<string>",
    "tosUrl": "<string>",
    "buttonOnlyShopTrees": true,
    "impactOffsetProjects": [],
    "manuallyApproved": true,
    "v1WebhookSigningSecrets": [
      {
        "createdAt": "<unknown>",
        "expiresAt": "<unknown>"
      }
    ]
  }
}
'

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.

Body

application/json

Data of the webhook event

​
id
string
required

The unique id for the webhook.

​
type
enum<string>
required
Available options:
merchant_updated
​
date
string
required

The date of the webhook.

​
payload
object
required

The updated merchant data.

Response

200

OK