Single payments

Enable payments to your or other bank accounts.

Single domestic payments and single international payments are concepts defined in the Open Banking Standards.

With the Payments API, you can split single payments into one of two categories:

  • A payment from a user to your TrueLayer merchant account
  • A payment from a user to a bank account (either external or your own)

When you create a payment using the /payments endpoint, you must provide information such as payment value, payment method and more. You provide this information within the different objects in your POST request to the API.

Learn how to configure a single payment request.

Provider selection and required user information

Some objects you configure as part of a payment require more consideration than others. Specifically, the providers and user objects.

Provider selection

The providers object refers to the financial provider a payment is made through, typically a bank. When you configure a payment, you can:

  • require that the payment is made through a specific provider
  • list only certain providers as a payment option
  • filter providers based on certain criteria such as payment scheme

Learn how to configure provider selection for a payment.

Required user information

The users object enables you to provide user information as part of a payment. This includes user id, name, email, date of birth, phone number, and address.

Reusing the user id for multiple payments enables you to build a profile of their payments. It's also important to collect personal information as part of a payment to ensure compliance with financial regulations.

Learn how to provide user information for a payment.

Payment statuses and errors

There are a range of possible payment statuses that inform you of the progress of a payment. If a payment fails, the payment status can tell you why.

In addition to payment statuses, the errors that the Payments API returns include reasons why a payment doesn't work.