Ctrlk
Back To Rafflex.io
For the complete documentation index, see llms.txt. This page is also available as Markdown.

TrueLayer

Connect TrueLayer so approved customer withdrawals are paid automatically, instead of you paying each one by hand.

Automatic payouts are currently in beta. If you would like access to this feature, please contact support.

This guide sets up TrueLayer as your automatic payout provider. If you have not chosen a provider yet, start on the Payouts overview.

Before you start

You will need:

  1. A TrueLayer account. Sign up with TrueLayer first and complete any checks they ask for. Payouts cannot work until your TrueLayer account is approved and your merchant account is funded.

  2. Your TrueLayer credentials. You copy these from the TrueLayer Console into RaffleX. We list exactly which ones below.

  3. A few minutes to test. Every new setup starts in a safe test mode so you can check the connection before any real money moves.

Step 1: Open the Payouts settings

  1. Log in to your RaffleX admin panel.

  2. In the left menu, go to Settings.

  3. Open the Payouts page.

  4. Set Payout Provider to TrueLayer (Automatic). The TrueLayer fields then appear.

When you have finished making changes on this page, always click Save Settings at the bottom.

Step 2: Enter your TrueLayer details

You get all of these from the TrueLayer Console, TrueLayer's own back office dashboard. All five are required for TrueLayer to work. The Name Match Threshold below is optional to change.

Field
Required?
What to enter

Client ID

Required

Your API client ID. In the Console, open your app and go to the Settings tab.

Client Secret

Required

Your API client secret, on the same Settings tab. Keep this private. TrueLayer only shows a secret once, so save it when you create it.

Signing Key ID

Required

Your request signing key ID, found in the Signing keys section of the Settings tab.

Signing PEM Key

Required

Your signing private key. Paste it in full, including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- lines. If the key is incomplete, RaffleX will refuse to save and tell you what is wrong.

Merchant Account ID

Required

The TrueLayer merchant account that payouts are paid from. Find it on the Merchant account tab in the Console. It must hold enough funds to cover the payouts you make.

Signing keys come as a pair. In the TrueLayer Console you upload the public key (in the Signing keys section under Settings), and TrueLayer gives you a Signing Key ID for it. You keep the matching private key, which is the one you paste into the Signing PEM Key field here. If TrueLayer set up your account for you, ask your contact there for the key ID and private key.

Name Match Threshold

TrueLayer also shows a Name Match Threshold (%) setting. This one is optional to change. It comes with a sensible default, so you can leave it exactly as it is and skip to the next step.

If you do want to adjust it: when TrueLayer checks a customer's bank details, it compares the account name to the customer's name and gives a match score. This setting is the lowest score you will accept.

  • The range is between 50 and 100.

  • The default is 70.

  • A higher number is stricter. Somewhere between 70 and 85 suits most sites. Set it higher if you want tighter checks, lower if genuine customers are being turned away too often.

Step 3: How and when payouts happen

These settings control whether payouts run and when you still need to step in.

Setting
What it does

Enable Automatic Payouts

The master on/off switch. Leave this off while you set up and test. Turn it on when you are ready for TrueLayer to start paying withdrawals.

Test Mode

On by default. While it is on, everything runs against the TrueLayer sandbox and no real money moves. Turn it off only when you are ready to go live.

Auto-Payout Max (GBP)

The largest withdrawal that is paid automatically. Anything at or below this amount goes through on its own. Anything above it waits for you to approve it by hand. Set it to 0 to approve every payout yourself.

Retry Max Attempts

How many times a failed payout is tried again automatically before it is handed to you to sort out. The default is 3.

Enable Manual Bank Details Fallback

On by default. If a customer's bank cannot be verified automatically, or their bank is not supported, this lets them enter their bank details by hand so you can still pay them the manual way.

Start with Auto-Payout Max set low, or at 0, while you get comfortable. That way larger amounts still come to you for a final check even after automatic payouts are live.

Step 4: Test the connection

Once you have entered and saved your TrueLayer details, a Test Provider Connection button appears on the page.

  1. Click Test Provider Connection.

  2. RaffleX checks your credentials with TrueLayer and shows the result.

  3. The result tells you whether you are in sandbox or live mode, and lists each check as a pass or a fail.

If anything fails, re-check the fields above. The most common causes are using sandbox credentials while in live mode (or the other way round), or a signing key that was not pasted in full.

Step 5: Go live

When your test connection passes and you are happy with your settings:

  1. Turn Test Mode off.

  2. Make sure your TrueLayer fields now hold your live credentials, not the sandbox ones.

  3. Turn Enable Automatic Payouts on.

  4. Click Save Settings.

Automatic payouts are now active. Approved withdrawals at or below your Auto-Payout Max will be paid by TrueLayer, and anything above it will still come to you for approval.

FAQ

Can I switch back to manual later?

Yes. Set Payout Provider back to Manual / Bank Transfer, or turn Enable Automatic Payouts off, and you are back to paying withdrawals by hand.

Will every withdrawal be paid automatically?

Only those at or below your Auto-Payout Max (GBP). Anything above that amount waits for you to approve it. If you set the max to 0, you approve every payout yourself.

What happens if a customer's bank details cannot be verified?

If you leave Enable Manual Bank Details Fallback on, the customer can enter their details by hand and you pay them the manual way. If you turn it off, only automatically verified payouts are allowed.

Last updated