Nothing Found

Invoice completedWebhook

Webhook event notification request.

event_name value: invoice-completed

This request is sent to registered webhook event handlers after
Balance transfer completes successfully
Commit an escrow transaction completes successfully
Pay an escrow transaction completes successfully
Pay an invoice completes successfully
Refund a line item from an invoice completes successfully
Refund an invoice 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.

created
string

Timestamp when this transaction was created. The format is RFC 3339 (2006-01-02T15:04:05Z07:00).

description
string

A user-facing description for this transaction. May appear in receipts and transaction history pages, and viewed by support agents.

failure_code
string

If the transaction failed, a code representing the failure. Visit Invoice Failure Codes for more information.

failure_reason
string

If the transaction failed, a human-readable reason for the failure. Visit Invoice Failure Codes for more information.

invoice_id
string <= 36 characters

The primary key for this transaction.

invoice_type
string <string>

The type of invoice, such as, user_purchase or commit_escrow.

Array of objects (LineItems-2)

The line items for the transaction.

metadata
string

The arbitrary data structure associated with this transaction.

Array of objects

The payment methods for the transaction. The payment_method_id is the value returned from the Purchase flow.

reference_id
string

Your reference ID for the transaction.

reference_type
string

A type for your reference_id.

state
string

The status of the transaction. One of OPEN, PROCESSING, SUCCESS, FAILED, or CANCELED.

Array of objects (Subitem)

Subitems related to the transaction.

object

The transaction summary object.

updated
string

Timestamp when this transaction was most recently updated. The format is RFC 3339 (2006-01-02T15:04:05Z07:00).

Responses
2XX

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

Request samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "created": "string",
  • "description": "Digital product order",
  • "failure_code": "generic_error",
  • "failure_reason": "an error ocurred",
  • "invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
  • "invoice_type": "user_purchase",
  • "line_items": [
    ],
  • "metadata": {
    },
  • "payment_methods": [
    ],
  • "reference_id": "8987749",
  • "reference_type": "Acme order number",
  • "state": "FAILED",
  • "subitems": [
    ],
  • "summary": {
    },
  • "updated": "string"
}