TrueLayer

Create payout

Pay out from one of your merchant accounts.

Get payout

Returns payout details.

Start authorization flow

Start the authorization flow for a payout. This API can be called using the `resource_token` associated with the payout you are trying to fetch.

Submit payments return parameters

Submit direct return query and fragment parameters returned from the provider.

Create Mandate

Create a new mandate. This API must be called using a backend bearer token.

List Mandates

List all the mandates associated with the client. This API must be called using a backend bearer token.

Get Mandate

Returns a mandate with the stated ID. This endpoint can be called either by the regular `backend token` or the `mandate token` for that mandate.

Start Authorization Flow

Start the authorization flow for a mandate. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.

Submit consent

Submit the consent given by the user. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.

Submit provider selection

Submit the provider details selected by the PSU. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.

Revoke Mandate

Revoke a mandate. This API must be called using a backend bearer token.

Confirm Mandate Funds

Confirm that the PSU has the given funds. This API can be called using the mandate_token associated with the mandate or using a backend bearer token.

Get Mandate Constraints

Retrieve the constraints defined on the mandate, as well as the current utilization of those constraints within the periods.

List Merchant Accounts

List all your TrueLayer merchant accounts. There might be more than one account per currency.

Get Merchant Account

Get the details of a single merchant account.

Get Transactions

Get the transactions of a single merchant account. If pagination is missing, add a header `tl-enable-pagination: true` to enable pagination.

Set Up or Update Sweeping

Set the automatic sweeping settings for a merchant account. At regular intervals, any available balance in excess of the configured `max_amount_in_minor` is withdrawn to a pre-configured IBAN.

Disable Sweeping

Disable automatic sweeping for a merchant account.

Get Sweeping Settings

Get the automatic sweeping settings for a merchant account.

Get Payment Sources

Get the payment sources from which the merchant account has received payments.

Create Payment Link

Create a new payment link. This API must be called using a backend bearer token.

Get Payment Link

Retrieves payment link details. This API must be called using a backend bearer token.

Get Payments

List all the payments associated with the payment link. This API must be called using a backend bearer token.

Create Payment

Create a new payment. This API must be called using a backend bearer token.

Start Payment Authorization Flow

Start the authorization flow for a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Submit Provider Selection

Submit the provider details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Submit Scheme Selection

Submit the scheme details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Submit Form

Submit form details filled by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Submit Consent

Submit the consent given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Submit User Account Selection

Submit the user account selection option given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Cancel Payment

Cancel a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Save Payment Account

Save the account details associated with a payment for subsequent re-use. This API can be called using the `resource_token` associated with the payment or a backend bearer token.

Get Payment

Returns payment details. This API can be called using either the `resource_token` associated with the payment or a backend bearer token.

Create Payment Refund

Refund a merchant account payment, either fully or partially.

Get Payment Refunds

Returns all refunds of a payment.

Get Payment Refund

Returns refund details for a specific payment.

Search Payment Providers

Returns a list of payment providers.

Get Payment Provider

Returns payment provider details. This API can be called without the need for authentication.

Custom API Call

Make a custom API call to a specific endpoint