GET/inbound_wire_transfers

List inbound wire transfers

Lists inbound wire transfers, with optional filters for account, account number, creation time, status, and wire drawdown request. Use cursor and limit to retrieve results in pages; the default and maximum limit is 100.

10 parameters
cursorstringoptional
Returns the page of results after this cursor; use the `next_cursor` value from a previous response to continue.
limitintegeroptional
Maximum number of inbound wire transfers to return. Must be at least 1 and defaults to 100 when omitted; the maximum is 100.
Default:100
account_idstringoptional
Filter results to inbound wire transfers belonging to this account.
account_number_idstringoptional
Filter results to inbound wire transfers belonging to this account number.
created_at.afterstringoptional
Filter for results created after this ISO 8601 date-time.
created_at.beforestringoptional
Filter for results created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Filter for results created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Filter for results created at or before this ISO 8601 date-time.
status.inarray<string>optional
Filter by status: `pending`, `accepted`, `declined`, or `reversed`. For GET requests, encode multiple statuses as a comma-delimited string.
wire_drawdown_request_idstringoptional
Filter results to inbound wire transfers belonging to this wire drawdown request.

3 status codes
200Returns a list of inbound wire transfer objects and a `next_cursor` value for retrieving the next page; `next_cursor` is null when there are no more results.
dataarray<InboundWireTransfer>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request cannot be completed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

limit must be at least 1 and no more than 100, and defaults to 100 when omitted. status.in accepts pending, accepted, declined, or reversed; encode multiple statuses as a comma-delimited string. Date filters must use ISO 8601 date-time values.