unknown<\/code><\/td>\n| No specific reason is known by Adyen for the failure, or the reported reason does not correspond to any of the codes above.<\/td>\n | Check the card details provided in the transfer and retry. If problem persists, further manual investigation might be needed.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/pay-out-to-cards\/payout-webhooks","articleFields":{"description":"Find out which webhooks Adyen sends for payout-related events.","feedback_component":true,"parameters":{"transferType":"payout","integrationType":"payouts","directoryPath":"\/payouts\/payout-service","counterpartyType":"card","model":"platform"},"type":"page","_expandable":{"operations":""},"status":"current","filters_component":false,"last_edit_on":"21-03-2023 10:36"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/pay-out-to-cards\/payout-webhooks","title":"Webhooks for card payouts","content":"When funds are paid out from a balance account to a user's bank account, Adyen sends webhook notifications to inform your platform of the progress and status changes of the transfer. Use this guide to understand which events are sent and how to configure your system to process these payout-related webhooks successfully.\nWhen a payout is triggered in your platform, Adyen sends the following kinds of webhooks:\n\n balancePlatform.transfer.created, which informs your server that an outgoing transfer is initiated from a balance account in your platform.\n balancePlatform.transfer.updated, which informs your server of the transfer status changes.\n\nThis page explains how to identify webhooks related to card payouts and shows examples for the webhooks that you receive for every transfer status.\nRequirements\nBefore you begin, take into account the following requirements and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAn Adyen payout service integration.\n\n\nWebhooks\nTo keep track of payout-related events in your platform, make sure that: Your server must be able to receive and accept webhooks.You have subscribed to Transfer webhooks and Transaction webhooks in your Customer Area.\n\n\n\nIdentify payout-related webhooks\nYou can identify transfer webhooks triggered by payout-related events by looking at the following values:\n\n\n\nParameter\nDescription\nValue\n\n\n\n\n category\nSpecifies the category of the transfer.\ncard\n\n\n direction\nThe direction of the transfer based on the balance account.\noutgoing\n\n\n type\nSpecifies the type of the transfer.\ncardTransfer\n\n\n\nAdyen sends webhooks for the following payout events:\n\nPayout initiated\nPayout authorised\nPayout booked\nPayout pending\nPayout accepted\nPayout failed\n\nThe following sections provide code samples for the events that trigger webhooks. These samples consider a use case where you pay out EUR 100.00 from a balance account to a Mastercard or Visa card.\nPayout initiated\nWhen your user initiates a transfer to a Mastercard or Visa card, Adyen sends a balancePlatform.transfer.created webhook to inform your server that an outgoing transfer request has been created. The webhook provides information about the transfer, such as:\n\nThe amount of the payout\nThe reference for the payout\nThe referenceForBeneficiary\nYour user's balanceAccount from which the funds will be deducted\nDetails of the accountHolder linked to your user's balance account.\nDetails of the counterparty in the transfer, which is your user's transfer instrument.\nThe bookingDate when the payout was requested.\nThe id of the corresponding transfer.\n\nThe following tabs show examples of balancePlatform.transfer.created webhooks for one-off and recurring payouts.\n\n\n \n \n \n \n\n\nPayout authorised\nWhen the transfer request for the payout is authorised, Adyen sends a balancePlatform.transfer.updated webhook to inform your server that the transfer amount has been reserved on the account. This webhook includes the status authorised.\nThe following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.\n\n\n \n \n \n \n\n\nPayout booked\nWhen the funds are deducted from your user's balance account, Adyen sends a balancePlatform.transfer.updated webhook with:\n\ndirection: outgoing\nstatus: booked\nevents.transactionId: ID of the transaction\n\nThis status is not final. The transfer may still fail if, for example, the transfer is rejected by the scheme or issuing bank.\nThe following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.\n\n\n \n \n \n \n\n\nPayout pending\nAfter the funds are deducted from your user's balance account, the transfer is automatically analyzed to ensure that it complies with Adyen's policies. If a transfer is flagged, Adyen reviews the transfer.\nIn order to speed up the screening process and reduce the amount of manual effort needed, we recommend that you provide as much information as possible in the transfer request. For example, include all counterparty details in the counterparty.card.cardHolder object.\nIn this case, Adyen sends a balancePlatform.transfer.updated webhook with a tracking event, specifying the following trackingData details:\n\nstatus: pending\ntype: internalReview\n\nThe following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.\n\n\n \n \n \n \n\n\nIf the transfer fails Adyen's review process, we send a balancePlatform.transfer.updated webhook with a tracking event, specifying the following trackingData:\n\nreason: refusedForRegulatoryReasons\nstatus: failed\ntype: internalReview\n\nIf this is the case, contact our Support Team.\nPayout accepted\nWhen a card payout request is accepted for processing by the card schemes, Adyen sends a balancePlatform.transfer.updated webhook to your server.\nThe webhook includes a tracking event, which contains the following trackingData details:\n\nstatus: accepted\ntype: confirmation\n\nThis event confirms that the scheme will process the payout. You can use this to let your counterparty know that their funds will arrive soon.\nThe following example shows a balancePlatform.transfer.updated webhook for a payout request that has been accepted:\n\n \n\nPayout failed\nThe payout transfer can fail if it is rejected by an external banking system and any automatic retries are unsuccessful.\nWhen a payout transfer fails, Adyen sends a balancePlatform.transfer.updated webhook with:\n\nstatus: failed\nThe transactionId\nThe reason for the failure. For more information, see Reason codes.\n\nThe following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.\n\n\n \n \n \n \n\n\nReason codes\nThe following table describes the reasons why a transfer may be rejected or returned by the counterparty's bank.\n\n\n\nReason code\nDescription\nRemediating action\n\n\n\n\namountLimitExceeded\nThe counterparty's bank or the payment system rejected this transfer because the value is too high.\nRetry the transfer with a lower amount or with a different route.\n\n\ncounterpartyBankUnavailable\nThe counterparty's bank is unavailable for real-time processing.\nRetry the transfer later or with a different route.\n\n\ncounterpartyAccountNotFound\nThe counterparty's bank is unable to locate the account with the provided details.\nCheck the card details provided in the transfer and retry.\n\n\ncounterpartyAccountClosed\nThe counterparty's bank reported that the account exists, but it is closed.\nCheck the card details provided in the transfer and retry.\n\n\ncounterpartyAccountBlocked\nThe counterparty's bank reported that the account is blocked or suspended.\nCheck the card details provided in the transfer and retry.\n\n\ncounterpartyAddressRequired\nThe counterparty's bank requires the account holder's address to credit this transfer to the account.\nRetry the transfer with full street address.\n\n\ncounterpartyBankTimedOut\nThe counterparty's bank timed out while trying to process this request in real-time.\nRetry the transfer later or with a different route.\n\n\n\n\n\nrefusedByCounterpartyBank\nThe counterparty's bank refused the transfer without providing any further information regarding the underlying reason.\nCheck the card details provided in the transfer and\/or contact the counterparty's bank.\n\n\nunknown\nNo specific reason is known by Adyen for the failure, or the reported reason does not correspond to any of the codes above.\nCheck the card details provided in the transfer and retry. If problem persists, further manual investigation might be needed.\n\n\n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Pay out to third-party cards","lvl4":"Webhooks for card payouts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payouts","lvl2":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service","lvl3":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/pay-out-to-cards","lvl4":"\/pt\/payouts\/payout-service\/pay-out-to-cards\/payout-webhooks"},"levels":5,"category":"","category_color":"","tags":["Webhooks","payouts"]},"articleFiles":{"transfer-accepted-raw.json":" transfer-accepted-raw.json<\/p>","transfer-authorised-raw.json":" transfer-authorised-raw.json<\/p>","transfer-authorised-token.json":" transfer-authorised-token.json<\/p>","transfer-booked-raw.json":" transfer-booked-raw.json<\/p>","transfer-booked-token.json":" transfer-booked-token.json<\/p>","transfer-credited-raw.json":" transfer-credited-raw.json<\/p>","transfer-credited-token.json":" transfer-credited-token.json<\/p>","transfer-failed-raw.json":" transfer-failed-raw.json<\/p>","transfer-failed-token.json":" transfer-failed-token.json<\/p>","transfer-initiated-raw.json":" transfer-initiated-raw.json<\/p>","transfer-initiated-token.json":" transfer-initiated-token.json<\/p>","transfer-pending-failed.json":" transfer-pending-failed.json<\/p>","transfer-pending-raw.json":" transfer-pending-raw.json<\/p>","transfer-pending-token.json":" transfer-pending-token.json<\/p>"}}
|