Simulations

Get Simulated Inbound Transfer Status

⚠️ Sandbox & development only. Simulation endpoints are not available in production and return 404 Not Found there.

Checks whether a simulated inbound transfer has settled into a transaction yet. Pass the sender_name returned by Simulate Inbound Transfer. Returns processing until the transfer settles, and settled with the resulting transaction_id once it does.

get/simulations/inbound_transfers/{sender_name}

Request

Base URL
https://api.meow.com/v1
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/meow/apis/meow-api/docs/simulations/inbound_transfers/:sender_name/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sender_namestring required

The sender_name returned when the inbound transfer was simulated.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

sender_namestring required

The simulation's correlation token.

status'processing' | 'settled' required

transaction_idstring nullable

The settled transaction's ID, as returned by the list transactions endpoint. Null while processing.

amountstring nullable

The settled transaction's amount, in dollars. Null while processing.

Changes

No recorded changes to this operation across all 1 revision of this API.