Reports
You can access two standard reports as part of your uP Payouts solution:
- Transaction Activity
- Payment Status
Report Delivery
Reports for the uP Payouts solution are provided in comma-separated values (CSV) file format. They are delivered through the SFTP folder directory. Reports can be generated on a daily, weekly or monthly basis, depending on your requirements, and they are based on UTC.
Transaction Activity Report
This report provides you with detailed uP Payout transaction information within a given day [DATE]T00:00:00.000Z to [DATE]:23:59:59.999Z UTC whereby the format is [yyyymmdd] Thh:mm:ss.sssZ. The data in this report can be used to help you track the movement of funds through the uP Gateway’s Disbursements system through to the recipient’s preferred transfer method. The Transaction Activity Report is ordered by transaction date and transaction sequence and captures all of the transaction for your Account and all of the recipients (i.e., Sub Accounts) that are linked to your Account. The Transaction Activity Report is formatted with the file name transaction_activity_report_[accountId]_[yyyymmddhhmmss].csv.
The table below provides and explanation of all the columns in the Transaction Activity report.
| Column/Field Name | Description | Supported Options (if applicable) | Format / Example Value |
|---|---|---|---|
| Account ID | The unique merchant identifier assigned by uP POM during onboarding preceded by the EID identifier | EID-63ec06ef0c0ac4359 | |
| Sub Account ID | This is the unique uP Recipient ID of a recipient in the uP Platform preceded by the SID identifier. NOTE: Sub Account ID is only populated if there is an activity on the sub-account. | SID-63ed218545405edec | |
| Amount | Transaction amount. Two decimal digits. Amounts are formatted using a dot (".") | 2358.20 | |
| Currency | Payment currency. Currency three letter code ISO 4217-Alpha 3 | MYR | |
| Transaction Type | The transaction types. Can be as follows: • Load • Foreign Exchange • Cashout • Returned | • LOAD • FX • CASHOUT • RETURN | Text, as defined in Supported Options column |
| Transaction Description | Description of the transaction. Can either be passed by the merchant (for a payment transaction) or will be generated by the system (e.g. Foreign Exchange Fee.) | ||
| Transaction Direction | Denotes if the transaction is a debit or a credit. Can be as follows: • Debit • Credit | • DEBIT • CREDIT | Text, as defined in Supported Options column |
| Transaction Date | Transaction date and time. NOTE: the time zone will be set based on the merchant’s location | YYYY-MM-DDThh:mm:ss | |
| Fee Amount | Fee amount. Two decimal digits. Amounts are formatted using a dot (".") When not applicable this field will be left empty. | 2.00 | |
| Fee Currency | Fee currency three letter code ISO 4217-Alpha 3 | MYR | |
| FX Rate Used | The foreign exchange rate that is used on the transaction. When not applicable this field will be left empty. | 1.67865265 | |
| Payment ID | Payment's unique identifier assigned by the uP Platform preceded by the PMT identifier | PMT-64180286ed496113a | |
| Payment Reference | Unique identifier assigned to payment by merchant | testPayment001 |
Payment Status Report
This report provides visibility into payment statuses; this includes a view of pending/waiting transactions, as well as any errors that may have arisen during the process of trying to send a payment to a recipient’s transfer method. The Payment Status Report is formatted with the file name payout_status_report_[accountID]_[yyyymmddhhmmss].csv.
The table below provides an explanation of all the columns in the Payment Status report.
| Column/Field Name | Description | Supported Options (if applicable) | Format / Example Value |
|---|---|---|---|
| Account ID | Unique merchant identifier assigned by uP POM during onboarding preceded by the EID identifier. | EID-123456789 | |
| Account Name | Merchant’s legal entity name. | HAPPY STORE SUPPLIES LTD. | |
| Sub Account ID | This is the unique uP Recipient ID of a recipient in the uP Platform. | SID-123456 | |
| Client Sub Account ID | This is the unique ID of the Recipient in your system. Something that is unique to your system and that you can use to find the account on your platform. | Merchant specific | |
| Payment ID | Payment's unique identifier assigned by the uP Platform preceded by the PMT identifier | PMT-64180286ed496113a | |
| Payment Reference | Unique identifier assigned to payment by merchant | testPayment001 | |
| Amount | Payment amount. Two decimal digits. Amounts are formatted using a dot (".") | 2358.20 | |
| Currency | Payment currency. Currency three letter code ISO 4217-Alpha 3 | MYR | |
| Transfer Method ID | Transfer Method's unique identifier assigned by uP Platform preceded by the TRM identifier. | TRM-641c67c7a91f720f1 | |
| Transfer Method Type | Transfer method type. Can be as follows: • Bank Account • Any of the supported E-Wallet Types | • BANK_ACCOUNT • VODAFONE_ACCOUNT • DIGICEL_ACCOUNT • GCASH • PAYTM • GOPAY • OVO • DANA • LINKAJA • SHOPEEPAY • TOUCHNGO • PAYMAYA • GCASH • COINS • GRABPAY • STARPAY • TAYOCASH • PALAWAYPAY • LULU • USSC • TRUEMONEY • MOMO • VNPAY • VNPT | Text, as defined in Supported Options column |
| Payment Status | Payment status. Can be as follows: • Payment has been cancelled. • Payment has completed. (i.e., the payment has been submitted to the transfer method). • Payment has expired. • Payment has failed. • A payment is pending. (i.e., the payment request has been received by the uP Platform and will be processed shortly). • Payment is processing. • Payment has been returned by the financial institution to the merchant. • Payment has been scheduled for a future date | • CANCELLED • PROCESSED • EXPIRED • FAILED • PENDING • PROCESSING • RETURNED • SCHEDULED | Text, as defined in Supported Options column |
| Payment Creation Date | Payment creation date and time. NOTE: the time zone will be set based on the merchant’s location | YYYY-MM-DDThh:mm:ss | |
| Payment Last Updated Date | Payment last updated date and time | YYYY-MM-DDThh:mm:ss |