Announce a deposit you're expecting

Registers an expected arrival before the money moves, and creates the PAY_IN transaction immediately at PENDING_FUNDS with settlement_status: FUNDS_EXPECTED. The transaction exists before the funds do.

What the intent means depends on the account it's against:

  • On a PAYMENT-purpose account the intent is the locked order, and onUnder decides what happens if the payer sends less than expected.
  • On a CONVERSION or BALANCE account it's an optional announcement.

The response carries an indicativeRate with binding: false. It's an indication, never a lock, and this endpoint accepts no quoteId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
expectedAmount
object
required
tolerance
object
required

Set independently, never a symmetric percentage.

string
enum
required
Allowed:
string
enum
required

Applies on a PAYMENT-purpose account. resize keeps the locked rate and shrinks the quantity; requote re-prices at today's rate; block holds until the shortfall is made up or the intent expires; refund returns the receipt.

Allowed:
date-time
required
string
length ≤ 140

Quoted by the payer. Stage 0 of attribution, and the only reliable match key.

string
metadata
object

Client-supplied key–value pairs, echoed on the object and every event about it.

Headers
uuid
required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight.
Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a
different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json