Payments view
Monitor payments and generate reports in Console.
The payments view is a record of all the incoming and outgoing transactions that you have made using TrueLayer APIs. Access it by going to Payments within your app.
If you don't have a merchant account, you only see payments made to external accounts here.
The Payments view contains information about all incoming and outgoing payments. This includes payments and payouts that are in progress, which could fail.
As such, for a definitive view of your balance on a given day, you should use the Historical Balances or Transactions tab within the Merchant Account section.
Payments database
The Payments tab in your app is a table of payments made to or from your EUR or GBP merchant account.
Various different types of payment in the sandbox payment view.
You can filter by date, payment status and currency using the date picker and dropdowns to the right. 31 days is the longest period you can display on the payments view at once.
In the database, you can see every transaction made to and from your merchant account within the given date range. Days are in UTC from midnight to midnight.
Details included in this view:
- the amount paid
- the status of the payment
- the payment type
- the payment, payout or refund
id - the payment reference
- the name of the remitter, or payer (if a pay-in)
- the name of the beneficiary, or payee (if a payout)
- the date and time (UTC) that the payment was last modified
Click on an individual payment to also see:
- the option to refund the payment, if it was made to your merchant account
- the dates and times that the payment transitioned to each status in its lifecycle
- the transaction ID
- the account number and sort code of the payer or payee
- the remitter or beneficiary type
- the payment source ID of the remitter or beneficiary
- the user ID of the remitter or beneficiary
- The auto-refund or external deposit associated with the payment or refund (if you've enabled auto-refunds)
Generate a report
Click Export to generate a CSV report of your transaction history within a time frame that you choose.
Use the menu to filter by date range, currency and payment status. To include more detailed information in the payout type, enable Granular payment types.
For more control over the fields that appear on the report, enable Advanced export fields.
CSV export format
When you generate a report, the column headers change depending on whether you are using the latest version of the payments view, or the legacy payments view.
CSV export format for latest version of the payments view
If you export a CSV of the latest version of the payments view with all fields enabled, this is the order that columns display in:
| amount | currency | status | type | reference | remitter | beneficiary | id | paymentId | payoutId | date | providerId | providerName | failureReason | remitterIBAN | remitterAccountNumber | remitterSortCode | beneficiaryIBAN | beneficiaryAccountNumber | beneficiarySortCode | beneficiaryType | paymentSourceId | userId | createdAt | authorizedAt | executedAt | failedAt | settledAt | schemeId | schemeName | mandateId |
|---|
Additional columns can be appended on the end of your export. These are the keys from any key-value pairs you include as metadata in your payment, refund or payout request.
The eighth column of the export, id, corresponds to the eighth column of an export from the legacy payments view, transactionId.
If your filter or export settings mean your export doesn't contain certain data, the relevant column is omitted from the export, instead of having a column header with blank values.
CSV export format for the legacy payments view
If you export a CSV from the legacy payments view, the exported file contains only the following 11 columns.
| amount | currency | status | type | reference | remitter | beneficiary | transactionId | paymentId | payoutId | date |
|---|
If your payments, payouts, or refunds have additional metadata, this isn't included in the CSV export.
Legacy payments view
In July 2023, we updated the default payments view. The new view has clearer visibility over a payment's lifecycle, additional statuses, better export options, and extra filters. However, the format of exported CSV files is different.
If you want to use the legacy payments view, go to Settings and scroll down. In Enable legacy API settings, toggle on Enable reports in legacy PayDirect API format.
In the legacy payments view, you cannot see all payments made on a mandate (you can in the latest version). You only see payments on a mandate that are made to your merchant account and have a status of settled.
Updated 9 days ago