[Plugins] Track and refund payments in Console

You may find it easier to use admin tools within Console than tools within your plugin to monitor and refund payments. For example, the payments view is a record of all the payments that you have accepted and refunds that you have made using TrueLayer APIs. Access it by going to Console > Payments > Payments v3 > Payments.

To move money from your merchant account to a business account, set up automatic sweeping from Console. You can also refund payments made through any plugin straight from the payments view.

Manage roles and permissions in Console

There are five possible roles that you can have as a member of an app:

• Owner
• Admin
• Developer
• Payments Operator
• View-only

See an overview of the members and roles within your app on the Team members page (Console > Team members).

Payments table

When you open the Payments page in Console, most of the page is occupied by a table of payments made to or from your EUR or GBP merchant account.

Filter by date, payment status and currency using the 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 (whether it is a payment or refund)
• a unique ID for the payment or refund
• a reference
• the name of the remitter, or payer (if a pay-in)
• the name of the beneficiary, or payee (if a refund)
• the date and time (UTC) that the payment was last modified

Click on an individual payment to also see:

• 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

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.

Payment statuses

Payments move through different statuses as they are created, authorised by your customer, and settle into your account. You can see the status of a payment in the payments view.

Below are the payment statuses which can apply to a TrueLayer payment, no matter what plugin they are made with.

Note that plugin dashboards sometimes use different payment statuses.

• Shopify order payment statuses
• Magento order statuses
• WooCommerce order statuses

Refund a payment

Requirements

A person signed into your application in Console can only issue a refund if they have:

• The Owner, Admin or Payments Operator role in the application.
• Set up multi-factor authentication (MFA) for their Console account. If you do not have MFA enabled, configure it from the User settings page or from the payments view.

To refund a payment:

1. Go to Console. Ensure that you are in the correct environment (ie that Live is toggled in the top right).
2. Enable multi-factor authentication (MFA), if you haven't already.
   You need to enable multi-factor authentication to process refunds. For help with doing this, see Set up MFA below.

1. Go to Payments > Payments. Here you will be able to see all the payments and payouts in your account.
2. Click on the payment that you want to refund. Click Refund payment at the top of the window that opens to the right.
3. A dialog displays. Enter the amount of the original payment to refund.
   The amount of money refunded cannot be more than the amount of the original payment.

Sweep money between your business and merchant accounts

To move money between your TrueLayer merchant account and another business account that you own, set up sweeping in Console.

Requirements

• You must have a role of either Owner or Admin in Console.
• We need to verify your business bank account details for KYC purposes. This must be done for each merchant account you want to set up sweeping for. Get in touch with us as early as possible in the testing process to enable this.

To set up sweeping:

1. Sign in to Console and go to Payments icon in the left navigation bar. The Payments Quick Start page displays.
2. Select Payments > Merchant Account.
   Your GBP and EUR merchant accounts display along with their historical balances.
3. Select the Merchant Account Sweeping tab under your merchant accounts.
   Use the field and dropdown to set up sweeping. If not, you need to verify your bank details.
4. To define how much and how often you want to sweep:
   1. Enter a minimum value to sweep from your merchant account to your business account.
   2. Select a frequency from Daily, Weekly, or Fortnightly to sweep funds at.
      Funds are always swept at 10:00 UTC on a Monday if you select Weekly or Fortnightly.
5. Select Set up merchant account sweeping.
   Money is automatically transferred from your merchant account to your business account in line with your settings.

Edit your sweeping settings by clicking the Edit icon to the right of your sweeping settings. To delete your settings, click Delete.