Skip to main content
POST
/
deposits
/
expectations
Create deposit expectation
curl --request POST \
  --url https://{host}/deposits/expectations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "bankAccountId": "64f0c51e7fb3fc001234abcd",
  "reference": "wallet-topup-5f91ce",
  "consideration": {
    "amount": 250
  }
}
'
{
  "message": "Invalid amount",
  "code": "INVALID_AMOUNT"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wealthyhood.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to register a deposit expectation when the user sends a bank transfer. When the transfer arrives, Wealthyhood matches it against pending expectations by reference and amount, then automatically reconciles it as a completed deposit.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-user-id
string
required

The external user identifier of the acting customer.

Example:

"bank-user-12345"

Body

application/json
​
bankAccountId
string
required

MongoDB ObjectId of the bank account to credit

Pattern: ^[a-f0-9]{24}$
Example:

"64f0c51e7fb3fc001234abcd"

​
reference
string
required

Payment reference the user will include in their bank transfer. Leading and trailing whitespace are trimmed; the value is stored and matched in lowercase (ASCII) so it aligns with the bank statement reference field.

Minimum string length: 1
Example:

"wallet-topup-5f91ce"

​
consideration
object
required

Response

Deposit expectation created successfully