Remittance advice API
Test endpoint:
https://transact.ti.com/v2/store/remittance-advice/test
Production endpoint:
https://transact.ti.com/v2/store/remittance-advice
The remittance advice API gives you the ability to submit remittance advice information that confirms your payment details. Each request must contain both header and item sections. Header sections identify the customer's remittance advice and currency code information. The item section can contain one or more detail records with specific payment and financial document information.
Note: Remittance advice API is only available to customers with a TI line of credit.
Remittance advice flow
- Authenticate with your API Key and secret.
- After you have received your access token, send the request with the required information. 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 a confirmation.
Example request:
{
"remittanceAdviceNumber": "CustomerRemit100",
"currencyCode": "USD",
"lineItems": [
{ "paymentAmount": "2000", "financialDocumentNumber": "1234567890" }
,
{ "paymentAmount": "200", "financialDocumentNumber": "234567890" }
]
}
Example response:
{
"tiRemittanceAdviceNumber": "06CustomerRemit100",
"remittanceAdviceNumber": "CustomerRemit100",
"currencyCode": "USD",
"messages": [
{
"code": "TI-TXT-012013",
"type": "SUCCESS",
"reason": "Remittance Advice 06CustomerRemit1 posted.",
"message": "Remittance Advice 06CustomerRemit1 posted." }
],
"lineItems": [
{ "paymentAmount": "2000", "financialDocumentNumber": "1234567890" }
,
{ "paymentAmount": "200", "financialDocumentNumber": "234567890" }
]
}