Match transfers by settlement identifiers

get

https://api.eu1.notabene.id/entities/{entityDID}/tx/match

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityDID

string

required

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

Query Params

settlement_id

string

required

Settlement identifier (e.g., tx hash).

settlement_address

string

required

Settlement address, preferably in CAIP-10 format (e.g., eip155:1:0x...). CAIP-10 addresses get deep validation; plain addresses pass through as-is.

source_address

string

length ≥ 1

Sender address in CAIP-10 format (e.g., xrpl:0:rAddr:123456). Embedded memo tags are extracted and used for matching.

asset

array of objects

Filter transfers by asset identifier

asset

settlement_id_index

string

Optional index (vout/log index). Used for strict match; dropped in broadened search if strict fails.

memo_tag

string

Memo tag for matching

limit

integer

1 to 100

Defaults to 25

Maximum number of transfers to return

offset

integer

≥ 0

Defaults to 0

Number of transfers to skip

direction

string

enum

Filter transfers by direction

Allowed:

fields

string

Comma-separated list of fields to include in the response.

sort_by

string

Field to sort by

sort_order

string

enum

Sort order (asc or desc)

Allowed:

Responses

200Match results retrieved successfully

400Bad Request - The server could not process the request due to a client error.

401Unauthorized - Authentication information is missing or invalid.

403Forbidden - The server understood the request but refuses to authorize it.

404Not Found - The requested resource could not be found.

409Conflict - The request could not be completed due to a conflict with the current state of the resource.

500Internal Server Error - An unexpected condition was encountered on the server.