Reporting Extracts: Error Records
Contents
Overview
Settlements can run into errors while processing event data records (EDRs). These error records are stored separately, and a file containing them is generated in the .csv format without a header and sent to a specified on-premise location using SFTP. Settlements also provide a back office function to recycle error transactions that are already in the settlements database. The following table contains the field names and the descriptions found in the error records extract.
| Field Name | Description | |
|---|---|---|
| plmTransactionID | The PLM domain internal transaction ID. Example: 100367435 |
|
| extTransactionID | The transaction ID provided by the external system. Type 1: Over-the-top (OTT) provider Type 2: Communications service provider (CSP) Billing System Example: g3692644656476564 |
|
| chargeDate | The transaction date/time (sent by the OTTor Billing System). Example: 5/19/2019 12:00:00AM |
|
| cspOrganizationId | The PLM domain provided CSP organization code. Example: NXT |
|
| cspProductCode | The CSP provided product code / charge code (unique to each product used by the CSP). Example: PLM_PART_0003 |
|
| partnerOrganizationId | The PLM domain provided OTT organization code. Example: NETFLIX |
|
| partnerOrganizationName | The name of the OTT. | |
| partnerProductCode | The OTT provided product code (the product code defined by the partner in the PLM domain). Example: NFX001 |
|
| partnerProductName | The product name provided by the OTT. Example: Netflix Basic |
|
| productCategoryName | The product category from the PLM domain. Example: Content |
|
| description | The description of the content or the product received from the OTT or CSP in the transaction. Example: 5600 diamantes (Garena Free Fire) |
|
| currency | The currency for the transaction (in the ISO-4217 format). Example: MXN |
|
| amount | The positive value for the charge, or the negative value for the refund. Example: 100.12 for the charge, or -200.34 for the refund. |
|
| taxIncluded | Flag if tax was included in the transaction amount. Valid values: Y/N Example: Y |
|
| taxAmount | The tax amount if the transaction contains tax. Tax Amount = Transaction amount x Tax %. Example :10.5 Note: The currency for this amount will be the same as shown in the currency field |
|
| settlementAmount | The settlement amount for this transaction to be paid to the OTT. Example: 7.23 Note: The currency for this amount will be the same as shown in the currency field. |
|
| status | The customer status retrieved the last time the /account/validate API was called. Example: Active |
|
| phoneNumber | The MSISDN associated with the CSP account returned in the /account/validate API. Example: 524626293701 |
|
| extCustomerId | The CSP unique customer ID associated with the CSP account returned in the /account/validate API. Example : 22432596 |
|
| extAccountId | The CSP account type associated with the CSP account returned in the /account/validate API. Example: Prepaid |
|
| extBillingId | The CSP financial account ID associated with the CSP account returned in the /account/validate API. Example : 98432596 |
|
| reasonCode | The reason for the error code returned by the CSP billing system or by the PLM domain during customer validation or transaction processing. It also contains the error code from settlement processing. Example: 13 |
|
| reasonDesc | The reason for the error description returned by the CSP billing system or by the PLM domain during customer validation or transaction processing. It also contains the error description from settlement processing. Example : PLM-STR-8001: Account not in good standing |
|
| Extended Attributes | extendedAttribute1 | Additional parameters retrieved as name value pairs for a specific CSP during the /transaction or the last /account/validate API call. Example: "platform": "Blue" |
| extendedAttribute2 | Additional parameters retrieved as name value pairs for a specific CSP during the /transaction or the last /account/validate API call. Example: "brand": "Nextel" |
|
| extendedAttribute3 | Additional parameters retrieved as name value pairs for a specific CSP during the /transaction or the last /account/validate API call. Example: "channel": "Web" |
|
| extendedAttribute4 | Additional parameters retrieved as name value pairs for a specific CSP during the /transaction or the last /account/validate API call. Example: "level": "Platinum" |
|
| extendedAttribute5 | Additional parameters retrieved as name value pairs for a specific CSP during the /transaction or the last /account/validate API call. Example: "churn": "low" |
|
Sample Error Codes
The following table contains sample error codes.
| Error Code | Description |
|---|---|
| DUPL | Duplicate record. |
| LS05 | Invalid record length. |
| PL01 | Settlement model not found. |
| PL02 | Valid product does not exist. |
| PL03 | Valid agreement does not exist. |
| PL04 | No mapping exists for the product category and the agreement. |
| PL05 | Settlement rates not found. |
| PL06 | Insufficient balance. |
| PL07 | Customer not active. |
Revision History
| Version | Description |
|---|---|
| 19.08 | Initial release. |
| 19.12.03 | Added Contents and Revision History sections. |