--- title: "Transfer created" method: POST path: "balancePlatform.transfer.created" tags: ["General"] --- # Transfer created `POST balancePlatform.transfer.created` (webhook) Adyen sends this webhook when there are fund movements on your platform. ## Payload - TransferNotificationRequest - `data` TransferNotificationData, required - `accountHolder` ResourceReference - `description` string — The description of the resource. - `id` string — The unique identifier of the resource. - `reference` string — The reference for the resource. - `amount` Amount, required - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `balanceAccount` ResourceReference - `description` string — The description of the resource. - `id` string — The unique identifier of the resource. - `reference` string — The reference for the resource. - `balanceAccountId` string — The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). - `balances` BalanceMutation[] — The list of the latest balance statuses in the transfer. - `balance` integer — The amount in the payment's currency that is debited or credited on the balance accounting register. - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `received` integer — The amount in the payment's currency that is debited or credited on the received accounting register. - `reserved` integer — The amount in the payment's currency that is debited or credited on the reserved accounting register. - `category` 'bank' | 'internal' | 'issuedCard' | 'platformPayment', required — The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users. - `counterparty` CounterpartyV3, required - `balanceAccountId` string — Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). - `bankAccount` BankAccountV3 - `accountHolder` PartyIdentification2, required - `address` Address2 - `city` string — The name of the city. - `country` string, required — The two-character ISO 3166-1 alpha-2 country code. For example, **US**. >If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `line1` string — First line of the street address. - `line2` string — Second line of the street address. - `postalCode` string — The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries. - `stateOrProvince` string — The two-letter ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `firstName` string — First name of the individual. Required when `type` is **individual**. - `fullName` string, required — The name of the entity. - `lastName` string — Last name of the individual. Required when `type` is **individual**. - `type` 'individual' | 'organization' | 'unknown' — The type of entity that owns the bank account. Possible values: **individual**, **organization**, or **unknown**. - `accountIdentification` union, required — Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer. - AULocalAccountIdentification - `accountNumber` string, required — The bank account number, without separators or whitespace. - `bsbCode` string, required — The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. - `type` 'auLocal', required — **auLocal** - BRLocalAccountIdentification - `accountNumber` string, required — The bank account number (without separators or whitespace). - `bankCode` string, required — The 3-digit Brazilian bank code (with leading zeros). - `branchNumber` string, required — The bank account branch number (without separators or whitespace). - `type` 'brLocal', required — **brLocal** - CALocalAccountIdentification - `accountNumber` string, required — The 5- to 12-digit bank account number, without separators or whitespace. - `institutionNumber` string, required — The 3-digit institution number, without separators or whitespace. - `transitNumber` string, required — The 5-digit transit number, without separators or whitespace. - `type` 'caLocal', required — **caLocal** - CZLocalAccountIdentification - `accountNumber` string, required — The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) - `bankCode` string, required — The 4-digit bank code (Kód banky), without separators or whitespace. - `type` 'czLocal', required — **czLocal** - DKLocalAccountIdentification - `accountNumber` string, required — The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). - `bankCode` string, required — The 4-digit bank code (Registreringsnummer) (without separators or whitespace). - `type` 'dkLocal', required — **dkLocal** - HULocalAccountIdentification - `accountNumber` string, required — The 24-digit bank account number, without separators or whitespace. - `type` 'huLocal', required — **huLocal** - IbanAccountIdentification - `iban` string, required — The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. - `type` 'iban', required — **iban** - NOLocalAccountIdentification - `accountNumber` string, required — The 11-digit bank account number, without separators or whitespace. - `type` 'noLocal', required — **noLocal** - NumberAndBicAccountIdentification - `accountNumber` string, required — The bank account number, without separators or whitespace. The length and format depends on the bank or country. - `additionalBankIdentification` AdditionalBankIdentification - … - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'numberAndBic', required — **numberAndBic** - PLLocalAccountIdentification - `accountNumber` string, required — The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. - `type` 'plLocal', required — **plLocal** - SELocalAccountIdentification - `accountNumber` string, required — The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. - `clearingNumber` string, required — The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. - `type` 'seLocal', required — **seLocal** - SGLocalAccountIdentification - `accountNumber` string, required — The 4- to 19-digit bank account number, without separators or whitespace. - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'sgLocal' — **sgLocal** - UKLocalAccountIdentification - `accountNumber` string, required — The 8-digit bank account number, without separators or whitespace. - `sortCode` string, required — The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. - `type` 'ukLocal', required — **ukLocal** - USLocalAccountIdentification - `accountNumber` string, required — The bank account number, without separators or whitespace. - `accountType` 'checking' | 'savings' — The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. - `routingNumber` string, required — The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. - `type` 'usLocal', required — **usLocal** - `merchant` MerchantData - `mcc` string — The merchant category code. - `merchantId` string — The merchant identifier. - `nameLocation` NameLocation - `city` string — The city where the merchant is located. - `country` string — The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. - `countryOfOrigin` string — The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies. - `name` string — The name of the merchant's shop or service. - `rawData` string — The raw data. - `state` string — The state where the merchant is located. - `postalCode` string — The merchant postal code. - `transferInstrumentId` string — Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - `description` string — A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. - `direction` 'incoming' | 'outgoing' — The direction of the transfer. Possible values: **incoming**, **outgoing**. - `events` TransferEvent[] — The list of events leading up to the current status of the transfer. - `amountAdjustments` AmountAdjustment[] — The amount adjustments in this transfer. - `amount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `amountAdjustmentType` 'atmMarkup' | 'authHoldReserve' | 'exchange' | 'forexMarkup' — The type of markup that is applied to an authorised payment. Possible values: **exchange**, **forexMarkup**, **authHoldReserve**, **atmMarkup**. - `basepoints` integer — The basepoints associated with the applied markup. - `bookingDate` string, date-time — The date when the transfer request was sent. - `id` string — The unique identifier of the transfer event. - `mutations` BalanceMutation[] — The list of the balance mutation per event. - `balance` integer — The amount in the payment's currency that is debited or credited on the balance accounting register. - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `received` integer — The amount in the payment's currency that is debited or credited on the received accounting register. - `reserved` integer — The amount in the payment's currency that is debited or credited on the reserved accounting register. - `originalAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `reason` 'amountLimitExceded' | 'approved' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'unknown' — The reason for the transfer status. - `status` 'atmWithdrawal' | 'atmWithdrawalReversalPending' | 'atmWithdrawalReversed' | 'authAdjustmentAuthorised' | 'authAdjustmentError' | 'authAdjustmentRefused' | 'authorised' | 'bankTransfer' | 'bankTransferPending' | 'booked' | 'bookingPending' | 'cancelled' | 'capturePending' | 'captureReversalPending' | 'captureReversed' | 'captured' | 'chargeback' | 'chargebackPending' | 'chargebackReversalPending' | 'chargebackReversed' | 'credited' | 'depositCorrection' | 'depositCorrectionPending' | 'dispute' | 'disputeClosed' | 'disputeExpired' | 'disputeNeedsReview' | 'error' | 'expired' | 'failed' | 'fee' | 'feePending' | 'internalTransfer' | 'internalTransferPending' | 'invoiceDeduction' | 'invoiceDeductionPending' | 'manualCorrectionPending' | 'manuallyCorrected' | 'matchedStatement' | 'matchedStatementPending' | 'merchantPayin' | 'merchantPayinPending' | 'merchantPayinReversed' | 'merchantPayinReversedPending' | 'miscCost' | 'miscCostPending' | 'paymentCost' | 'paymentCostPending' | 'received' | 'refundPending' | 'refundReversalPending' | 'refundReversed' | 'refunded' | 'refused' | 'reserveAdjustment' | 'reserveAdjustmentPending' | 'returned' | 'secondChargeback' | 'secondChargebackPending' | 'undefined' — The status of the transfer event. - `transactionId` string — The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes. - `type` 'accounting' | 'tracking' — The type of the transfer event. Possible values: **accounting**, **tracking**. - `updateDate` string, date-time — The date when the tracking status was updated. - `valueDate` string, date-time — A future date, when the funds are expected to be deducted from or credited to the balance account. - `id` string — The ID of the resource. - `modificationMerchantReference` string — The capture's merchant reference included in the transfer. - `modificationPspReference` string — The capture reference included in the transfer. - `panEntryMode` 'chip' | 'cof' | 'contactless' | 'ecommerce' | 'magstripe' | 'manual' | 'token' — Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**. - `paymentInstrument` PaymentInstrument - `description` string — The description of the resource. - `id` string — The unique identifier of the resource. - `reference` string — The reference for the resource. - `tokenType` string — The type of wallet the network token is associated with. - `paymentInstrumentId` string — The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). - `paymentMerchantReference` string — The payment's merchant reference included in the transfer. - `priority` 'crossBorder' | 'directDebit' | 'fast' | 'instant' | 'regular' | 'wire' — The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html) .* **crossBorder**: High value transfer to receipt in a different country. - `processingType` 'atmWithdraw' | 'balanceInquiry' | 'ecommerce' | 'moto' | 'pos' | 'purchaseWithCashback' | 'recurring' | 'token' — Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments. - `pspPaymentReference` string — The payment reference included in the transfer. - `reason` 'amountLimitExceded' | 'approved' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'unknown' — Additional information about the status of the transfer. - `reference` string — Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. - `referenceForBeneficiary` string — A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others. - `relayedAuthorisationData` RelayedAuthorisationData2 - `metadata` object — Contains key-value pairs of your references and descriptions, for example, `customId`:`your-own-custom-field-12345`. - `reference` string — Your reference for the relayed authorisation data. - `sequenceNumber` integer — The sequence number of the transfer notification. The numbers start from 1 and increase with each new notification for a specific transfer. It can help you restore the correct sequence of events even if they arrive out of order. - `status` 'atmWithdrawal' | 'atmWithdrawalReversalPending' | 'atmWithdrawalReversed' | 'authAdjustmentAuthorised' | 'authAdjustmentError' | 'authAdjustmentRefused' | 'authorised' | 'bankTransfer' | 'bankTransferPending' | 'booked' | 'bookingPending' | 'cancelled' | 'capturePending' | 'captureReversalPending' | 'captureReversed' | 'captured' | 'chargeback' | 'chargebackPending' | 'chargebackReversalPending' | 'chargebackReversed' | 'credited' | 'depositCorrection' | 'depositCorrectionPending' | 'dispute' | 'disputeClosed' | 'disputeExpired' | 'disputeNeedsReview' | 'error' | 'expired' | 'failed' | 'fee' | 'feePending' | 'internalTransfer' | 'internalTransferPending' | 'invoiceDeduction' | 'invoiceDeductionPending' | 'manualCorrectionPending' | 'manuallyCorrected' | 'matchedStatement' | 'matchedStatementPending' | 'merchantPayin' | 'merchantPayinPending' | 'merchantPayinReversed' | 'merchantPayinReversedPending' | 'miscCost' | 'miscCostPending' | 'paymentCost' | 'paymentCostPending' | 'received' | 'refundPending' | 'refundReversalPending' | 'refundReversed' | 'refunded' | 'refused' | 'reserveAdjustment' | 'reserveAdjustmentPending' | 'returned' | 'secondChargeback' | 'secondChargebackPending' | 'undefined', required — The result of the transfer. For example, **authorised**, **refused**, or **error**. - `tracking` TransferNotificationTransferTracking - `status` 'credited' — The tracking status of the transfer. - `transactionId` string — The ID of the transaction that is created based on the transfer. - `transactionRulesResult` TransactionRulesResult - `advice` string — The advice given by the Risk analysis. - `allRulesPassed` boolean — Indicates whether the transaction passed the evaluation for all transaction rules. - `failedTransactionRules` TransactionEventViolation[] — Array containing all the transaction rules that the transaction violated. This list is only sent when `allRulesPassed` is **false**. - `reason` string — An explanation about why the transaction rule failed. - `transactionRule` TransactionRuleReference - `description` string — The description of the resource. - `id` string — The unique identifier of the resource. - `reference` string — The reference for the resource. - `transactionRuleSource` TransactionRuleSource - `id` string — ID of the resource, when applicable. - `type` string — Indicates the type of resource for which the transaction rule is defined. Possible values: * **PaymentInstrumentGroup** * **PaymentInstrument** * **BalancePlatform** * **EntityUsageConfiguration** * **PlatformRule**: The transaction rule is a platform-wide rule imposed by Adyen. - `score` integer — The score of the Risk analysis. - `type` 'atmWithdrawal' | 'atmWithdrawalReversal' | 'balanceAdjustment' | 'balanceRollover' | 'bankTransfer' | 'capture' | 'captureReversal' | 'chargeback' | 'chargebackReversal' | 'depositCorrection' | 'fee' | 'grant' | 'installment' | 'installmentReversal' | 'internalTransfer' | 'invoiceDeduction' | 'leftover' | 'manualCorrection' | 'miscCost' | 'payment' | 'paymentCost' | 'refund' | 'refundReversal' | 'repayment' | 'reserveAdjustment' | 'secondChargeback' — The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**. - `validationFacts` TransferNotificationValidationFact[] — The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information. - `result` string — The evaluation result of the validation fact. - `type` string — The type of the validation fact. - `environment` string, required — The environment from which the webhook originated. Possible values: **test**, **live**. - `type` 'balancePlatform.transfer.created' | 'balancePlatform.transfer.updated' — The type of the notification. ## Acknowledgement `200` OK - the request has succeeded. - BalancePlatformNotificationResponse - `notificationResponse` string — Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). --- [API](https://skmtc.dev/adyen/apis/transfer-webhooks.md) · [All operations](https://skmtc.dev/adyen/apis/transfer-webhooks/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/transfer-webhooks/revisions/5cb35e90ac77/schema)