Nothing Found

Escrow transaction updateWebhook

Webhook event notification request.

event_name value: escrow-transaction-update

This request is sent to registered webhook event handlers after
Cancel an escrow transaction completes successfully
Commit an escrow transaction completes successfully
Pay an escrow transaction completes successfully

The Request body described below is the message property in the event notification request data. For more information about event notification requests, visit Webhooks.

Securitytilia_auth
Request
Request Body schema: application/json
account_id
string <= 36 characters

The buyer's Tilia Account ID.

cancel_invoice_id
string <= 36 characters

The underlying invoice that refunded the escrow transaction back to the buyer. Only exists after /cancel is called

commit_invoice_id
string <= 36 characters

The underlying invoice that executed the escrow transaction and moved proceeds to their final destinations. Only exists after /commit is called

escrow_invoice_id
string <= 36 characters

The underlying invoice that put the buyer's proceeds in escrow.

id
string <= 36 characters

The primary key for this escrow transaction.

integrator
string

The name of the partner that this escrow transaction is associated with.

status
string

The status of the escrow transaction. The table displays the possible values of this property.

Value Description
OPEN The transaction has been created, but not paid.
ESCROWED The transaction has been paid, but not not committed.
ESCROW-FAILED The transaction payment could not be made.
COMMITTED The transaction payment was committed and sent to recipients.
COMMIT-FAILED The transaction could not be committed.
CANCELLED The transaction was canceled.
CANCEL-FAILED The transaction cancellation could not be made.
SYSTEM-CANCELLED The transaction was canceled by the system.
SYSTEM-CANCEL-REQUESTED The system requested the transaction to be canceled.
SYSTEM-CANCEL-FAILED The transaction could not be canceled by the system.
Responses
2XX

Return a 2XX status to indicate that the data was received successfully

Request samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "cancel_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
  • "commit_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
  • "escrow_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
  • "id": "esc_2V2TxPgh8usE9neZJoEjQyFHhVh",
  • "integrator": "tilia",
  • "status": "ESCROWED"
}