Webhook-Event
Merchant Updated
Webhook-Subscription
Webhook-Event
Merchant Updated
Your merchant account has been updated
POST
/
webhook-event
/
merchant-updated
curl --request POST \
--url https://{yourDomain}/webhook-event/merchant-updated \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "test",
"date": "<string>",
"payload": {
"id": "<string>",
"websiteUrl": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"shopLogo": "<string>",
"platformType": "shopify",
"hasApiKey": true,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<string>",
"offsetProject": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"impactOffsetProjects": [
"<string>"
],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
},
"merchantOrderConfirmation": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
}
},
"manuallyApproved": true,
"pairedMerchantId": "<string>",
"legalName": "<string>",
"displayName": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": null
},
"category": "<string>",
"payout": {
"status": "started",
"verified": true,
"enabled": true,
"isPayoutsDataAvailable": true
},
"blacklistedBankIds": [],
"appId": "<string>",
"apps": [
{
"id": "<string>",
"websiteUrl": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"shopLogo": "<string>",
"platformType": "shopify",
"hasApiKey": true,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<string>",
"offsetProject": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"impactOffsetProjects": [
"<string>"
],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
},
"merchantOrderConfirmation": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
}
},
"manuallyApproved": true
}
],
"users": [
"<string>"
],
"plan": {
"dealType": "custom",
"applicationFeeShare": 123,
"applicationFixedFeeShare": 123,
"refundApplicationFee": true,
"amountFreeTransactions": 123,
"monthlyInvoiceTotal": 123
},
"applicationFeeShare": 123,
"applicationFixedFeeShare": 123,
"marketCapabilitySettings": [
{
"market": "AF",
"capabilities": [
"pis"
]
}
],
"impactAccount": true,
"deletedAt": "2023-11-07T05:31:56Z"
}
}'Body
application/json
Data of the webhook event
The unique id for the webhook.
The type of the webhook.
Available options:
test, merchant_updated, merchant_app_updated, order_created, order_updated, refund_succeeded, refund_failed, payout_report_requested, data_session_completed, checkout_session_created, checkout_session_updated, checkout_session_expired, checkout_session_completed, payout_created, payout_updated, mandate_setup_started, mandate_setup_succeeded, mandate_setup_failed, mandate_revoked, user_payout.failed, user_payout.paid, user_payout.initiated The date of the webhook.
The payload is the merchant that was updated.
Available options:
shopify, woo_commerce, shopware, magento, other list of blacklisted bank ids
Available options:
custom, S, M, L Available options:
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 Available options:
pis, ais Use defaultWebhookSubscription.url instead
The country code in ISO 3166-1 alpha-2 format.
Available options:
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 Available options:
shopify, woo_commerce, shopware, magento, other Use defaultWebhookSubscription.url instead
Moved to merchant.plan
Moved to merchant.plan
Response
200
OK
curl --request POST \
--url https://{yourDomain}/webhook-event/merchant-updated \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "test",
"date": "<string>",
"payload": {
"id": "<string>",
"websiteUrl": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"shopLogo": "<string>",
"platformType": "shopify",
"hasApiKey": true,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<string>",
"offsetProject": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"impactOffsetProjects": [
"<string>"
],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
},
"merchantOrderConfirmation": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
}
},
"manuallyApproved": true,
"pairedMerchantId": "<string>",
"legalName": "<string>",
"displayName": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": null
},
"category": "<string>",
"payout": {
"status": "started",
"verified": true,
"enabled": true,
"isPayoutsDataAvailable": true
},
"blacklistedBankIds": [],
"appId": "<string>",
"apps": [
{
"id": "<string>",
"websiteUrl": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"shopLogo": "<string>",
"platformType": "shopify",
"hasApiKey": true,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<string>",
"offsetProject": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"impactOffsetProjects": [
"<string>"
],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
},
"merchantOrderConfirmation": {
"emailNotification": {
"active": true,
"emails": [
"<string>"
]
}
}
},
"manuallyApproved": true
}
],
"users": [
"<string>"
],
"plan": {
"dealType": "custom",
"applicationFeeShare": 123,
"applicationFixedFeeShare": 123,
"refundApplicationFee": true,
"amountFreeTransactions": 123,
"monthlyInvoiceTotal": 123
},
"applicationFeeShare": 123,
"applicationFixedFeeShare": 123,
"marketCapabilitySettings": [
{
"market": "AF",
"capabilities": [
"pis"
]
}
],
"impactAccount": true,
"deletedAt": "2023-11-07T05:31:56Z"
}
}'