Invoice complete

Nothing Found

Invoice completeWebhook

Request

Security:

Request Body schema: application/json

invoice_id	string <UUID4 or TUID> The primary key for this transaction.
invoice_type	string <string> The type of invoice this invoice is, for example user_purchase or commit_escrow.
account_id	string <UUID4> The buyer's Tilia Account ID.
reference_type	string A type for your `reference_id`.
reference_id	string Your reference ID for the transaction.
state	string The status of the transaction. One of `OPEN`, `PROCESSING`, `SUCCESS`, `FAILED`, or `CANCELED`.
description	string A user-facing description for this transaction. May appear in receipts and transaction history pages, and viewed by support agents.
metadata	string The arbitrary data structure associated with this transaction.
	object The transaction summary object.
failure_code	string If the transaction failed, a code representing the failure. See Invoice Failure Codes for more information.
failure_reason	string If the transaction failed, a human-readable reason for the failure. See Invoice Failure Codes for more information.
created	string Timestamp when this transaction was created. The format is RFC 3339 (2006-01-02T15:04:05Z07:00).
updated	string Timestamp when this transaction was most recently updated. The format is RFC 3339 (2006-01-02T15:04:05Z07:00).
	Array of objects The payment methods for the transaction. The payment_method_id is the value returned from the Purchase flow.
	Array of objects (LineItems-2) The line items for the transaction.
	Array of objects (Subitem) Subitems related to the transaction.

Responses

2XX

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

Request samples

application/json

{"invoice_id": "65d6c272-d593-405d-986c-a70b587e281f",
"invoice_type": "user_purchase",
"account_id": "b2ba9a0f-3d75-44e0-968d-be299cda5d80",
"reference_type": "Acme order number",
"reference_id": "8987749",
"state": "FAILED",
"description": "Digital product order",
"metadata": {"key1": {"key2": 3
}
},
"summary": {"total_amount": 155,
"total_amount_usd": 155,
"currency": "string",
"display_amount": "USD 1.55",
"subtotal": {"total_amount": 155,
"total_amount_usd": 155,
"currency": "string",
"display_amount": "USD 1.55"
},
"tax": {"total_amount": 155,
"total_amount_usd": 155,
"currency": "string",
"display_amount": "USD 1.55"
},
"fx": {"total_amount": 155,
"total_amount_usd": 155,
"currency": "string",
"display_amount": "USD 1.55",
"exchange_id": "afba6925-545c-4790-be49-887705942e9c"
}
},
"failure_code": "generic_error",
"failure_reason": "an error ocurred",
"created": "string",
"updated": "string",
"payment_methods": [{"payment_method_id": "34a2a1b4-3fa8-4c20-9112-16137682caff",
"authorized_amount": 155,
"currency": "USD",
"display_amount": "$1.55",
"subitems": [{"subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
"amount": 155,
"currency": "string",
"display_amount": "$1.55",
"reference_type": "invoicing.invoice_line_item_v2.line_item_id",
"reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
"description": "In-game digital bundle",
"metadata": {"key1": {"key2": 3
}
},
"source_account_id": "f4ef7057-0f3c-49fc-9001-59c1ed38239a",
"source_payment_method_id": "d140dca4-9830-4c41-ab0a-1453210cf5c4",
"source_wallet_id": "f13be8d7-06c9-4d04-b59f-7d3acb26b70c",
"destination_account_id": "a738ae8d-8f24-436e-9345-68defb76b760",
"destination_payment_method_id": "bd8545a4-fc5b-4d91-aba8-3b197ac2cb80",
"destination_wallet_id": "a52206d7-355e-4107-9de9-2bd2c839c25e",
"tags": {"<tag_id>": {"tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
"account_id": "5e8f9263-bbd0-4bd9-810d-9961a3f253b1",
"resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
"resource_type": "payments.payment_method.id",
"namespace": "payment_method",
"tag": "default_payment",
"status": "ACTIVE",
"integrator": "acme",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
}
}
],
"tags": {"<tag_id>": {"tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
"account_id": "5e8f9263-bbd0-4bd9-810d-9961a3f253b1",
"resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
"resource_type": "payments.payment_method.id",
"namespace": "payment_method",
"tag": "default_payment",
"status": "ACTIVE",
"integrator": "acme",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
},
"amount": 0
}
],
"line_items": [{"line_item_id": "12175ea1-5a52-4c8a-a027-0e7421ca613f",
"amount": 155,
"currency": "string",
"transaction_type": "user_to_integrator",
"product_sku": "SKU-123-A",
"product_code": "code-123-A",
"reference_type": "Acme catalog ID",
"reference_id": "7245480",
"description": "In-game digital bundle",
"metadata": {"key1": {"key2": 3
}
},
"sort_order": 0,
"subitems": {"subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
"amount": 155,
"currency": "string",
"display_amount": "$1.55",
"reference_type": "invoicing.invoice_line_item_v2.line_item_id",
"reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
"description": "In-game digital bundle",
"metadata": {"key1": {"key2": 3
}
},
"source_account_id": "f4ef7057-0f3c-49fc-9001-59c1ed38239a",
"source_payment_method_id": "d140dca4-9830-4c41-ab0a-1453210cf5c4",
"source_wallet_id": "f13be8d7-06c9-4d04-b59f-7d3acb26b70c",
"destination_account_id": "a738ae8d-8f24-436e-9345-68defb76b760",
"destination_payment_method_id": "bd8545a4-fc5b-4d91-aba8-3b197ac2cb80",
"destination_wallet_id": "a52206d7-355e-4107-9de9-2bd2c839c25e",
"tags": {"<tag_id>": {"tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
"account_id": "5e8f9263-bbd0-4bd9-810d-9961a3f253b1",
"resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
"resource_type": "payments.payment_method.id",
"namespace": "payment_method",
"tag": "default_payment",
"status": "ACTIVE",
"integrator": "acme",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
}
}
}
],
"subitems": [{"subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
"amount": 155,
"currency": "string",
"display_amount": "$1.55",
"reference_type": "invoicing.invoice_line_item_v2.line_item_id",
"reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
"description": "In-game digital bundle",
"metadata": {"key1": {"key2": 3
}
},
"source_account_id": "f4ef7057-0f3c-49fc-9001-59c1ed38239a",
"source_payment_method_id": "d140dca4-9830-4c41-ab0a-1453210cf5c4",
"source_wallet_id": "f13be8d7-06c9-4d04-b59f-7d3acb26b70c",
"destination_account_id": "a738ae8d-8f24-436e-9345-68defb76b760",
"destination_payment_method_id": "bd8545a4-fc5b-4d91-aba8-3b197ac2cb80",
"destination_wallet_id": "a52206d7-355e-4107-9de9-2bd2c839c25e",
"tags": {"<tag_id>": {"tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
"account_id": "5e8f9263-bbd0-4bd9-810d-9961a3f253b1",
"resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
"resource_type": "payments.payment_method.id",
"namespace": "payment_method",
"tag": "default_payment",
"status": "ACTIVE",
"integrator": "acme",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
}
}
]
}