\n| balancePlatform.incomingTransfer.updated<\/a><\/td>\n | Funds were added to a balance account because of a refund or a funds transfer.
Possible values: Refunded<\/strong>, IncomingTransfer<\/strong><\/td>\n<\/tr>\n\n| balancePlatform.outgoingTransfer.created<\/a><\/td>\n | Funds were deducted from a balance account because of a payment capture or a funds transfer.
Possible statuses: Captured<\/strong>, OutgoingTransfer<\/strong><\/td>\n<\/tr>\n\n| balancePlatform.outgoingTransfer.updated<\/a><\/td>\n | There was an update after funds were deducted from a balance account. For example, the funds transfer to a transfer instrument failed.
Possible statuses: TransferConfirmed<\/strong>, TransferSentOut<\/strong>, or TransferFailed<\/strong><\/td>\n<\/tr>\n\n| balancePlatform.payment.created<\/a><\/td>\n | A payment authorisation, a refund, or a funds transfer has been initiated.
Possible statuses: Authorised<\/strong>, Refused<\/strong>, Error<\/strong><\/td>\n<\/tr>\n\n| balancePlatform.payment.updated<\/a><\/td>\n | A payment authorisation has expired or has been cancelled.
Possible statuses: Expired<\/strong>, Cancelled<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/webhook-types","articleFields":{"description":"Learn which webhook types are sent for each event.","section_label":"Webhooks","cache_enable":false,"parameters":{"model":"marketplace","directoryPath":"\/marketplaces"},"next_steps_description":"Learn which webhooks are sent for different scenarios.","next_steps":[{"title":"Payout events","description":"Webhooks for funds movements related to payouts.","url":"\/marketplaces\/payout-to-users\/notification-webhooks","required":false},{"title":"Fund transfer events","description":"Webhooks for funds movements related to fund transfers within your marketplace.","url":"\/marketplaces\/internal-fund-transfers\/notification-webhooks","required":false}],"feedback_component":true},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/webhook-types","title":"Webhook structures and types for marketplaces","content":"Webhooks are typically sent when:\n\nA resource was created or updated.\nA request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).\nThere was a funds movement (funds added to or deducted from balance accounts).\n\nYou can subscribe to the following webhooks:\n\nConfiguration\nPayment method\nTransfer\nNegative balance warning\nReport\n\nYou can also differentiate the events based on the type. Some webhook types also include a data.status field that informs you of the outcome of the event.\nWebhook structure\nIn general, the body of a webhook contains the following objects.\n\n\n\nParameter\nData type\nDescription\n\n\n\n\ndata\nObject\nObject that contains information about the event.\n\n\nenvironment\nString\nThe environment where the transaction was processed—test or live.\n\n\ntype\nString\nThe event type.\n\n\n\nThe information contained in the data object varies and depends on the webhook type. You can find the full schema for each type in API Explorer.\nBelow is an example request body for a webhook of type balancePlatform.accountHolder.created.\n\n \n\nConfiguration webhooks\nConfiguration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.\n\n \n\n\n\nType\nDescription\n\n\n\n\nbalancePlatform.accountHolder.created\nAn account holder was successfully created.\n\n\nbalancePlatform.accountHolder.updated\nAn account holder was successfully updated.\n\n\nbalancePlatform.balanceAccount.created\nA balance account was successfully created.\n\n\n balancePlatform.balanceAccount.updated\nA balance account was successfully updated.\n\n\nbalancePlatform.paymentInstrument.created\nA payment instrument, such as a debit card or an Adyen business account, was successfully created.\n\n\nbalancePlatform.paymentInstrument.updated\nA payment instrument, such as a debit card or an Adyen business account, was successfully updated.\n\n\nbalancePlatform.balanceAccountSweep.created\nA balance account sweep was successfully created.\n\n\n balancePlatform.balanceAccountSweep.deleted\nA balance account sweep was successfully deleted.\n\n\nbalancePlatform.balanceAccountSweep.updated\nA balance account sweep was successfully updated.\n\n\nbalancePlatform.score.triggered\nA risk signal was triggered for the account holder. Reach out to your Adyen contact to enable sending this webhook type to your server.\n\n\n\n\n\n\nPayment method webhooks\nPayment method webhooks inform your system about payment method creation and removal requests, and the removal of a payment method request.\n\n\n\nType\nDescription\n\n\n\n\n paymentMethod.created\nA payment method creation request has been processed. The content informs you on the final state of the request.\n\n\n paymentMethodRequest.scheduledForRemoval\nA payment method request is scheduled for removal. A request to add a payment method will be removed in 30 days. To make sure the payment method is added, provide the missing KYC information.\n\n\n paymentMethodRequest.removed\nA request to add a payment method is removed. You must make another request to add a payment method.\n\n\n\nTransfer webhooks\nTransfer webhooks inform your system about incoming and outgoing transfers in your marketplace.\n\n\n\nType\nDescription\n\n\n\n\n balancePlatform.transfer.created\nA transfer request was created to credit funds to or deduct funds from a balance account in your marketplace. The content informs you of the event that triggered the transfer request, such as a payment or refund.\n\n\n balancePlatform.transfer.updated\nA transfer request's status changed.\n\n\n\n\nYou can identify transfer webhooks sent for different events by checking the following parameters and values:\n\n\n\nEvent\n category\n type\n counterparty\n\n\n\n\nPayment or capture\nplatformPayment\ncapture\n\n\n\nRefund\nplatformPayment\nrefund\n\n\n\nChargeback\nplatformPayment\nchargeback\n\n\n\nPayout\nbank\nbankTransfer\ntransferInstrumentId\n\n\nInternal transfer\ninternal\ninternalTransfer\nbalanceAccountId\n\n\nThird-party bank transfer\nbank\nbankTransfer\nbankAccount\n\n\n\nBalance webhooks\nBalance webhooks inform your system about balance changes that occur in the balance accounts of your balance platform.\n\n \n\n\n\nType\nDescription\n\n\n\n\nbalancePlatform.balanceAccount.balance.updated\nA balance change occurred in a balance account of your balance platform.\n\n\n\n\n\n\nNegative balance compensation warning webhooks\nNegative balance compensation warning webhooks inform your system when a balance account in your marketplace has a negative balance, so you can take action.\n\n\n\nType\nDescription\n\n\n\n\n balancePlatform.negativeBalanceCompensationWarning.scheduled\nA balance account in your marketplace has had a negative balance for more than 20 days, and an automatic transfer from your marketplace's liable balance account is scheduled to compensate that negative balance.\n\n\n\nReport webhooks\nReport webhooks inform your system when a report is generated and ready to be downloaded.\n\n\n\nType\nDescription\n\n\n\n\n balancePlatform.report.created\nA report was generated and is ready to be downloaded.\n\n\n\nPayment webhooks (deprecated)\n\nPayment webhooks are deprecated. Use the transfer webhooks instead.\n\n\n\n\nType\nDescription\n\n\n\n\nbalancePlatform.incomingTransfer.created\nThere are funds that will be added to the balance account because of a pending refund or a funds transfer.Possible statuses: PendingIncomingTransfer\n\n\nbalancePlatform.incomingTransfer.updated\nFunds were added to a balance account because of a refund or a funds transfer.Possible values: Refunded, IncomingTransfer\n\n\nbalancePlatform.outgoingTransfer.created\nFunds were deducted from a balance account because of a payment capture or a funds transfer.Possible statuses: Captured, OutgoingTransfer\n\n\nbalancePlatform.outgoingTransfer.updated\nThere was an update after funds were deducted from a balance account. For example, the funds transfer to a transfer instrument failed. Possible statuses: TransferConfirmed, TransferSentOut, or TransferFailed\n\n\nbalancePlatform.payment.created\nA payment authorisation, a refund, or a funds transfer has been initiated.Possible statuses: Authorised, Refused, Error\n\n\nbalancePlatform.payment.updated\nA payment authorisation has expired or has been cancelled.Possible statuses: Expired, Cancelled\n\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Webhook structures and types for marketplaces"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/marketplaces","lvl2":"\/pt\/marketplaces\/webhook-types"},"levels":3,"category":"Marketplaces","category_color":"green","tags":["Webhook","structures","types","marketplaces"]}}
| | | | |