Incoming transfer created

webhook balancePlatform.incomingTransfer.created

Was this page helpful?

Deprecated in version 1

Use balancePlatform.transfer.created instead.

Adyen sends this webhook when there are incoming funds due to a refund or a fund transfer. Use the paymentId to link to the original refund request or funds transfer request. Check the content of the webhook to differentiate the events.

For refunds, the webhook includes the payment instrument to which funds will be refunded.
For incoming fund transfers, the webhook only includes information about the balance account.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/btl/v1/balancePlatform.incomingTransfer.created

Notification parameters

Required Optional

data object Required

Contains event details.

Show children

accountHolder object

Contains information about the account holder.

Show children

amount object

The amount converted to the balance account's currency, in case the original transaction currency is different.

A positive value means the amount is added to the balance account.
A negative value means the amount is deducted from the balance account.

Show children

balanceAccount object

Contains information about the balance account.

Show children

balancePlatform string

The unique identifier of the balance platform.

counterparty object

Contains information about the other party in the transaction.

Show children

balanceAccountId string

Unique identifier of the balance account.

bankAccount object

Contains information about the bank account.

Show children

merchant object

Contains information about the merchant.

Show children

transferInstrumentId string

Unique identifier of the transfer instrument.

creationDate string

The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.

description string

Your description for the transfer. If you send a description longer than 140 characters, the text is truncated.

id string

The ID of the resource.

modification object

Contains the amount and type of modification that triggered the notification. For example, this object contains the amount of a partial cancellation or partial expired authorisation.

Show children

originalAmount object

The amount in the original currency of the transaction.

A positive value means the amount is added to the balance account.
A negative value means the amount is deducted from the balance account.

Show children

paymentId string

The ID of the original payment authorisation, refund, or funds transfer request. Use this to trace the original request from the balancePlatform.payment.created webhook.

paymentInstrument object

Contains information about the payment instrument.

Show children

platformPayment object

Contains information about the related platform payment.

Show children

reference string

Max length: 80

An Adyen-generated unique reference for the transfer.

referenceForBeneficiary string

Max length: 80

The reference sent to or received from the counterparty.

For outgoing funds, this is the referenceForBeneficiary from the /transfers request.
For incoming funds, this is the reference from the sender.

status string

The event status. The possible values depend on the type.

Authorised, Refused, or Error for type balancePlatform.payment.created
Expired or Cancelled or AuthAdjustmentAuthorised for type balancePlatform.payment.updated
PendingIncomingTransfer for type balancePlatform.incomingTransfer.created
Refunded or IncomingTransfer for type balancePlatform.incomingTransfer.updated
Captured or OutgoingTransfer for type balancePlatform.outgoingTransfer.created
TransferConfirmed, TransferSentOut, or TransferFailed for type balancePlatform.outgoingTransfer.updated

valueDate string

Indicates the expected settlement date of this transaction, in ISO 8601 extended format. For example, 2021-08-17T15:34:37+02:00.

environment string Required

The environment from which the webhook originated.

Possible values: test, live.

type string Required

Type of notification.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
notificationResponse string

Respond with HTTP 200 OK and [accepted] in the response body to accept the webhook.

Incoming transfer created

Endpoint destination URL

Notification parameters

Response parameters

HTTP Responses

200 - OK