Learn how to verify a user’s bank account ownership by initiating micro-deposits - small deposits that are sent to the account and must be verified by the user to confirm account ownership.
initiate-micro-deposits
link relation exists. A link to initiate-micro-deposits
will return when an unverified bank
funding source is eligible to receive micro-deposits.
HTTP 201
and a link to the created micro-deposits resource funding-sources/{id}/micro-deposits
in the location header. The micro-deposits resource can be later used to retrieve the status of micro-deposits or verify micro-deposit amounts. If your application is subscribed to , a webhook will be sent with the microdeposits_added
event, notifying your application that micro-deposits are en route to your customer’s bank account.
microdeposits_completed
event will be triggered once micro-deposits have successfully posted to the bank. Once micro-deposits have completed, a verify-micro-deposits
link relation will return on the funding source letting your application know the funding source can be verified. When the amounts are entered for verification, the order in which they are entered doesn’t matter.
microdeposits_maxattempts
event will be triggered and a failed-verification-micro-deposits
link will be returned in the response for the funding source. As a result, they will no longer be allowed to verify the funding source using the same two posted micro-deposit amounts. In order to retry bank account verification via micro-deposits, the following steps will need to be taken by your customer and application:
failed-verification-micro-deposits
, initiate-micro-deposits
or verify-micro-deposits
, will give your application insight into whether the funding source is eligible to receive or verify micro-deposits, or if it has already failed micro-deposit verification.