Financial document retrieve API
Test endpoint:
https://transact.ti.com/v2/store/orders/T10999999/financial-documents/5999999999/test
Production endpoint:
https://transact.ti.com/v2/store/orders/{Order Number}/financial-documents/{Invoice Number}
The financial document retrieve API provides invoice information for non-Apruve payments and allows you to download PDF copies of your invoices. Invoices become available after TI processes and ships the order. To retrieve an invoice using the financial retrieve API, the order number and the financial document number are required for the request. You can find the financial document number under the "invoices" section in the order retrieve response (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api). To retrieve a PDF, see spec below for configuration options. This API is available in push or retrieve implementations. The push API will send a webhook to your system in real-time to notify that your financial documents are ready and it can be used to trigger automation flows. See push notification setup for more information.
For invoices using Apruve as the payment method, navigate to your Apruve portal to obtain your invoice directly.
Financial document retrieve flow
- After the financial documents are generated, authenticate with your assigned API key and secret.
- After you have received your access token, send a request including the order number and the document number. Multiple requests can be made in the same session with the access token as long as the token hasn't expired.
- The API will respond with a status code, 200 OK, and a JSON string containing the document information.
- If a PDF was requested, it will be included in the JSON as a base64 encoded string.
A testing version of the API is available. The data in the response will return standardized testing example data. For testing, the financialDocumentNumber should always be passed as 5999999999.
Example request: