Getting Started
Events
- POSTmerchant_updateddeprecated
- POSTrefund_succeededdeprecated
- POSTrefund_faileddeprecated
- POSTuser_payout.initiateddeprecated
- POSTuser_payout.paiddeprecated
- POSTuser_payout.faileddeprecated
- POSTpayout_report_requesteddeprecated
- POSTdata_session_completeddeprecated
- POSTpayout_createddeprecated
- POSTpayout_updateddeprecated
- POST
curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/merchant_updated \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "merchant_updated",
"date": "<string>",
"payload": {
"id": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"legalName": "<string>",
"displayName": "<string>",
"email": "<string>",
"appId": "<string>",
"users": [
"<string>"
],
"plan": {
"dealType": "S",
"refundApplicationFee": true,
"applicationFeeShare": 1,
"applicationFixedFeeShare": 1,
"amountFreeTransactions": 1,
"monthlyInvoiceTotal": 1
},
"marketCapabilitySettings": [
{
"market": "AF",
"capabilities": [
"ais"
]
}
],
"platformType": "shopify",
"hasApiKey": true,
"internalApplicationName": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"category": "<string>",
"websiteUrl": "<string>",
"applicationFeeShare": 1,
"applicationFixedFeeShare": 1,
"payout": {
"verified": true,
"enabled": true,
"status": "pending",
"isPayoutsDataAvailable": true
},
"apps": [
{
"id": "<string>",
"platformType": "shopify",
"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,
"climateActionMode": {
"type": "transaction",
"amount": 0
},
"impactOffsetProjects": [],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"[email protected]"
]
}
}
},
"manuallyApproved": true
}
],
"impactAccount": true,
"pairedMerchantId": "<unknown>",
"blacklistedBankIds": [],
"blacklistedOpenBankingProvidersByMarket": [
{
"market": "AF",
"blacklistedOpenBankingProviders": [
"Token"
]
}
],
"themeName": "default",
"deletedAt": "<unknown>",
"ssoEnabled": true,
"shopLogo": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<unknown>",
"offsetProject": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 0
},
"impactOffsetProjects": [],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"[email protected]"
]
}
}
},
"manuallyApproved": true
}
}
'merchant_updated
Your merchant account has been updated
curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/merchant_updated \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "merchant_updated",
"date": "<string>",
"payload": {
"id": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"legalName": "<string>",
"displayName": "<string>",
"email": "<string>",
"appId": "<string>",
"users": [
"<string>"
],
"plan": {
"dealType": "S",
"refundApplicationFee": true,
"applicationFeeShare": 1,
"applicationFixedFeeShare": 1,
"amountFreeTransactions": 1,
"monthlyInvoiceTotal": 1
},
"marketCapabilitySettings": [
{
"market": "AF",
"capabilities": [
"ais"
]
}
],
"platformType": "shopify",
"hasApiKey": true,
"internalApplicationName": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"category": "<string>",
"websiteUrl": "<string>",
"applicationFeeShare": 1,
"applicationFixedFeeShare": 1,
"payout": {
"verified": true,
"enabled": true,
"status": "pending",
"isPayoutsDataAvailable": true
},
"apps": [
{
"id": "<string>",
"platformType": "shopify",
"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,
"climateActionMode": {
"type": "transaction",
"amount": 0
},
"impactOffsetProjects": [],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"[email protected]"
]
}
}
},
"manuallyApproved": true
}
],
"impactAccount": true,
"pairedMerchantId": "<unknown>",
"blacklistedBankIds": [],
"blacklistedOpenBankingProvidersByMarket": [
{
"market": "AF",
"blacklistedOpenBankingProviders": [
"Token"
]
}
],
"themeName": "default",
"deletedAt": "<unknown>",
"ssoEnabled": true,
"shopLogo": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"webhookUrl": "<string>",
"defaultWebhookSubscription": "<unknown>",
"offsetProject": "<string>",
"privacyUrl": "<string>",
"tosUrl": "<string>",
"buttonOnlyShopTrees": true,
"climateActionMode": {
"type": "transaction",
"amount": 0
},
"impactOffsetProjects": [],
"notificationSettings": {
"webhookFailure": {
"emailNotification": {
"active": true,
"emails": [
"[email protected]"
]
}
}
},
"manuallyApproved": true
}
}
'Body
Data of the webhook event
The unique id for the webhook.
merchant_updated The date of the webhook.
The updated merchant data.
Show child attributes
Show child attributes
The company’s legal name.
The customer-facing business name.
The email address of the account holder. This is only to make the account easier to identify to you.
Unique id of the merchant app.
Show child attributes
Show child attributes
The deal type of the merchant.
S, M, L, custom Refund the application fee.
The custom variable application Fee. For example, 0.05 for 5%.
x > 0The custom fixed application Fee in cents. For example, 20 for EUR 0.20.
x > 0The amount of free transactions per month. For example, 10 for 10 free transactions.
x > 0The monthly invoice total in cents. For example, 1000 for EUR 10.00.
x > 0Show child attributes
Show child attributes
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 ais, pis The Platform of the merchant.
shopify, woo_commerce, shopware, magento, other This is the name that will be displayed in the merchant dashboard.
The company’s phone number (used for verification).
The company’s mobile phone number (used for verification).
Show child attributes
Show child attributes
111AF, 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 The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.
The business’s publicly available website.
The custom variable application Fee. For example, 0.05 for 5%.
x > 0The custom fixed application Fee in cents. For example, 20 for EUR 0.20.
x > 0The apps corresponding to the merchant.
Show child attributes
Show child attributes
The Platform of the merchant.
shopify, woo_commerce, shopware, magento, other The Logo of the Shop. Only URLs are allowed.
Quote Callback requests will be sent to this URL on default.
Complete Callback requests will be sent to this URL on default.
The business’s publicly available website.
Users will be redirected her on default after a successful checkout.
Users will be redirected her on default after an unsuccessful checkout.
The default webhook url used to send events from Ivy.
The default project where Ivy will give money to per transaction.
The data and privacy rules of the merchant. Only valid URLs are accepted.
The Terms and Services of the merchant. Only valid URLs are accepted.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Token, TokenIvyLicence, Mock, Tink, TinkIvyLicence, Yapily, EnableBanking, Manual default, kraken, inpay, kucoin, kryptonim, telekom, okx The Logo of the Shop. Only URLs are allowed.
Quote Callback requests will be sent to this URL on default.
Complete Callback requests will be sent to this URL on default.
Users will be redirected her on default after a successful checkout.
Users will be redirected her on default after an unsuccessful checkout.
The default webhook url used to send events from Ivy.
The default project where Ivy will give money to per transaction.
The data and privacy rules of the merchant. Only valid URLs are accepted.
The Terms and Services of the merchant. Only valid URLs are accepted.
Show child attributes
Show child attributes
Response
OK
Was this page helpful?