Get escrow transactions by reference id

Retrieves list of escrow transaction specified by the reference_id URL parameter.

Request
Security:
tilia_auth (read_invoices)
path Parameters
reference_id
required
string <TUID>

The Reference ID associated with Escrow Transaction(s)

query Parameters
status
string

Status to filter by. Defaults to ALL. May specify a comma separated list.

Valid values: ALL,OPEN,ESCROWED,ESCROW-FAILED,COMMITTED,COMMIT-REQUESTED,COMMIT-FAILED,CANCELLED,CANCEL-REQUESTED,CANCEL-FAILED,SYSTEM-CANCELLED,SYSTEM-CANCEL-REQUESTED,SYSTEM-CANCEL-FAILED,CANCEL-INVOICE-TRANSFER-FAILED

Example: status=OPEN,ESCROWED,COMMITTED
sort
string

The query direction, either asc or desc. Pass asc for ascending order, and desc for descending. Defaults to desc.

Example: sort=asc
sortField
string

The field to sort by, Valid values: created, updated. Defaults to updated.

Example: sortField=created
limit
integer

Maximum number of records to return. Defaults to 100. Note response field total maybe be larger than this.

Example: limit=1
offset
integer

Offset of first record to return. Defaults to 0.

Example: offset=2
Responses
200

Successfully retrieved escrow transactions.

401

Unauthorized access.

500

Service unavailable or server error.

get/v2/escrow/reference/{reference_id}
Request samples
curl -i -X GET \
  'https://invoicing.tilia-inc.com/v2/escrow/reference/:reference_id?status=string&sort=string&sortField=string&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "total": "1",
  • "account_id": "b2ba9a0f-3d75-44e0-968d-be299cda5d80",
  • "escrow_transactions": [
    ]
}