A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

The unique identifier for the channel.

The push channel used to deliver the SCA challenge.

The unique identifier for the user.

The push channel used for the authentication factor.

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

Filter for active or deactivated users. Leave out to fetch all users.

Filter by the email address of the user.

Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card.

Filter by the bulk process status.

The bulk id of the bulk process.

Return bulk process operations at or after this sequence number.

Filter by the bulk process operation status.

The unique identifier for the user.

Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision.

Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision.

Sort order for the results:

• ASC: Ascending order, oldest first.
• DESC: Descending order, most recent first.

Filter by the managed account/card profile. Leave out to fetch all managed accounts/card.

Filter by the managed account/card friendly name. Leave out to fetch all managed accounts/card.

The exact name must be provided, as wildcards are not supported.

Filter by one or more current instrument states. When multiple values are provided, instruments matching any of the states are returned:

• ACTIVE: The instrument can be used in transactions.
• BLOCKED: The instrument is temporarily blocked and cannot be used.
• DESTROYED: The instrument has been permanently destroyed.
• NOT_ENABLED: The instrument cannot be used because its linked user has not completed the required verification steps.

Leave this parameter out to return instruments in any state.

Filter by the managed account/card currency.

Currencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.

Filter for managed accounts/cards created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

Filter for managed accounts/cards created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

Filter by one or more linked-account verification run states.

Filter blocked instruments by one or more reasons they were blocked. When multiple values are provided, instruments matching any of the reasons are returned. This filter applies only to instruments whose state is BLOCKED.

Leave this parameter out to return blocked instruments regardless of the reason.

Filter destroyed instruments by one or more reasons they were destroyed. When multiple values are provided, instruments matching any of the reasons are returned. This filter applies only to instruments whose state is DESTROYED.

Leave this parameter out to return destroyed instruments regardless of the reason.

A request parameter specifying the type of response the client would like. Must be one of application/json, application/pdf or text/csv.

The default response type (application/json) will be returned if specified incorrectly or not specified.

The limit of the results for statements paging, starting at the offset. Limit is capped at 500.

Orders the result in ascending or descending order.

• ASC: Ascending order, oldest transactions first.
• DESC: Descending order, most recent transactions first.

If not specified, the transactions will be returned in descending order.

Filter for transactions having transaction timestamp after fromTimestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included.

Filter for transactions having transaction timestamp before toTimestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included. If both fromTimestamp and toTimestamp are provided, toTimestamp must be greater than fromTimestamp.

Deprecated. Use singleEntryPerTransaction instead.

Returns only the entries which contain fund movements.

Returns transactions that span multiple movements as a single entry. Only includes transactions that have been completed. Defaults to true for PDF statements, false otherwise. Note: due to the fact that only completed transactions are included, some transactions that are in progress and have modified the balance of the instrument will not be shown, which could lead to seemingly inconsistent balance being displayed.

Filter by the transaction type. Leave out to fetch all entries.

Opts the call in to the latest version of the endpoint. Set to LATEST to be routed to the newest implementation; omit to retain the default routing for your tenant.

The maximum number of statement entries to return. Limit is capped at 500.

Start of the statement period. Epoch timestamp using millisecond precision.

End of the statement period. Epoch timestamp using millisecond precision.

Sort order for the results:

• ASC: Ascending order, oldest first (default for statements).
• DESC: Descending order, most recent first.

Filter statement entries by one or more transaction types.

Filter statement entries by the ID of the access instrument that initiated the transaction.

Filter statement entries by the type of access instrument that initiated the transaction (managed cards or IBANs).

Filter by one or more transaction activity types.

Filter by one or more normalised transaction statuses.

Filter by transaction direction (CREDIT or DEBIT).

Filter for transactions last updated after this timestamp. Useful for pulling recently changed transactions. Epoch timestamp using millisecond precision.

Filter for transactions last updated before this timestamp. Epoch timestamp using millisecond precision.

The field to sort transaction activity results by. Defaults to creationTimestamp.

Filter by the type of the card.

Filter by the renewal type of the card.

The unique identifier for the user.

Filter by the managed card the payment belongs to.

Filter by one or more card payment statuses.

Filter by one or more card payment types.

Filter by one or more event subtypes (joined against the events timeline).

Partial, case-insensitive match against merchant name.

Filter for displayAmount.amount >= amountFrom.

Filter for displayAmount.amount <= amountTo.

Filter for card payments related to the given parent id.

Filter for card payments created at or after this epoch timestamp in milliseconds.

Filter for card payments created before this epoch timestamp in milliseconds.

Filter for card payments updated at or after this epoch timestamp in milliseconds.

Filter for card payments updated before this epoch timestamp in milliseconds.

Sort order on creationTimestamp. ASC = oldest first.

The unique identifier of a card payment.

Filter events to a single card payment.

Filter events to those on a single managed card.

Filter by one or more event types.

Filter events by one or more network subtypes.

Filter events by reversal flag.

Filter for card payment events at or after this epoch timestamp in milliseconds.

Filter for card payment events before this epoch timestamp in milliseconds.

Sort order on event timestamp. ASC = oldest first (default DESC).

Filter by the transfer profile. Leave out to fetch all transfer transactions.

Filter by the source instrument id.

Filter by the transfer transaction state. Leave out to fetch all states.

Filter for transfer transactions created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers.

Filter for transfer transactions created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers.

Filter for transfer transactions executed after executedFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers.

Filter for transfer transactions executed before executedTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers.

Filter by the transfer tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

Filter by the Send profile. Leave out to fetch all entries.

Filter by the source instrument id. Must be specified when source.type is provided.

Filter by the source instrument type. Must be specified when source.id is provided.

Filter by the Send transaction state. Leave out to fetch all states.

Filter for send transactions created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

Filter for send transactions created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

Filter for send transactions executed after executedFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

Filter for send transactions executed before executedTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

Filter by the send tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

Filter incoming wire transfers by state.

Filter by the source instrument id. Must be specified when source.type is provided.

Filter by the source instrument type. Must be specified when source.id is provided.

Filter by the outgoing wire transfer state. Leave out to fetch all states.

A unique call reference included in every call, that enables the receiver to avoid duplicate handling of a webhook request (e.g. webhook was resent).

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255